cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

installing-solidity.rst: Mention the PEDANTIC flag

Browse Source
This commit is contained in:
Kamil Śliwak 2022-08-11 15:35:38 +02:00
parent 9290ccb908
commit b7847c9f07
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/installing-solidity.rst
View File

@ -354,6 +354,17 @@ The following are dependencies for all builds of Solidity:
If you do this, however, please remember to pass the ``--no-smt`` option to ``scripts/tests.sh`` If you do this, however, please remember to pass the ``--no-smt`` option to ``scripts/tests.sh``
to skip the SMT tests. to skip the SMT tests.
.. note::
By default the build is performed in *pedantic mode*, which enables extra warnings and tells the
compiler to treat all warnings as errors.
This forces developers to fix warnings as they arise, so they do not accumulate "to be fixed later".
If you are only interested in creating a release build and do not intend to modify the source code
to deal with such warnings, you can pass ``-DPEDANTIC=OFF`` option to CMake to disable this mode.
Doing this is not recommended for general use but may be necessary when using a toolchain we are
not testing with or trying to build an older version with newer tools.
If you encounter such warnings, please consider
`reporting them <https://github.com/ethereum/solidity/issues/new>`_.
Minimum Compiler Versions Minimum Compiler Versions
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^