From 9f9b7fb6f0953558bb671c5385dec9c875eb15f0 Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Tue, 17 Jan 2017 12:32:07 +0000 Subject: Explain how version numbers are built --- docs/installing-solidity.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/installing-solidity.rst b/docs/installing-solidity.rst index d7374717..2a1f5012 100644 --- a/docs/installing-solidity.rst +++ b/docs/installing-solidity.rst @@ -216,6 +216,21 @@ Alternatively, you can build for Windows on the command-line, like so: cmake --build . --config RelWithDebInfo +The version string in detail +============================ + +The Solidity version string contains four parts: +- the version number +- pre-release tag, usually set to ``develop.YYYY.MM.DD`` or ``nightly.YYYY.MM.DD`` +- commit in the format of ``commit.GITHASH`` +- platform has arbitrary number of items, containing details about the platform and compiler + +If there are local modifications, the commit will be postfixed with ``.mod``. + +A relase example: ``0.4.8+commit.60cc1668.Emscripten.clang``. + +A pre-release example: ``0.4.9-nightly.2017.1.17+commit.6ecb4aa3.Emscripten.clang`` + Important information about versioning ====================================== -- cgit v1.2.3 From 592c692bceb4cbf14446ad7eff949a475ab63251 Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Tue, 17 Jan 2017 13:01:11 +0000 Subject: Mention how our version maps to Semver --- docs/installing-solidity.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/installing-solidity.rst b/docs/installing-solidity.rst index 2a1f5012..345780d7 100644 --- a/docs/installing-solidity.rst +++ b/docs/installing-solidity.rst @@ -227,6 +227,9 @@ The Solidity version string contains four parts: If there are local modifications, the commit will be postfixed with ``.mod``. +These parts are combined as required by Semver, where the Solidity pre-release tag equals to the Semver pre-release +and the Solidity commit and platform combined make up the Semver build metadata. + A relase example: ``0.4.8+commit.60cc1668.Emscripten.clang``. A pre-release example: ``0.4.9-nightly.2017.1.17+commit.6ecb4aa3.Emscripten.clang`` -- cgit v1.2.3