diff options
| author | chriseth <chris@ethereum.org> | 2017-01-17 22:34:41 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-01-17 22:34:41 +0800 |
| commit | ed12b977615822f1fd6c7674b1b90efc9c6479d3 (patch) | |
| tree | a10d1ffc447374b4ded7374dfe874b818fb30334 | |
| parent | 78b12e8f5c2a5c92989a86e475d4ebc276ad7cb8 (diff) | |
| parent | 592c692bceb4cbf14446ad7eff949a475ab63251 (diff) | |
| download | dexon-solidity-ed12b977615822f1fd6c7674b1b90efc9c6479d3.tar.gz dexon-solidity-ed12b977615822f1fd6c7674b1b90efc9c6479d3.tar.zst dexon-solidity-ed12b977615822f1fd6c7674b1b90efc9c6479d3.zip | |
Merge pull request #1574 from ethereum/docs-version
Explain how version numbers are built
| -rw-r--r-- | docs/installing-solidity.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/installing-solidity.rst b/docs/installing-solidity.rst index d7374717..345780d7 100644 --- a/docs/installing-solidity.rst +++ b/docs/installing-solidity.rst @@ -216,6 +216,24 @@ 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``. + +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`` + Important information about versioning ====================================== |