Skip to content

Commit b7847c9

Browse files
committed
installing-solidity.rst: Mention the PEDANTIC flag
1 parent 9290ccb commit b7847c9

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/installing-solidity.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,17 @@ The following are dependencies for all builds of Solidity:
354354
If you do this, however, please remember to pass the ``--no-smt`` option to ``scripts/tests.sh``
355355
to skip the SMT tests.
356356

357+
.. note::
358+
By default the build is performed in *pedantic mode*, which enables extra warnings and tells the
359+
compiler to treat all warnings as errors.
360+
This forces developers to fix warnings as they arise, so they do not accumulate "to be fixed later".
361+
If you are only interested in creating a release build and do not intend to modify the source code
362+
to deal with such warnings, you can pass ``-DPEDANTIC=OFF`` option to CMake to disable this mode.
363+
Doing this is not recommended for general use but may be necessary when using a toolchain we are
364+
not testing with or trying to build an older version with newer tools.
365+
If you encounter such warnings, please consider
366+
`reporting them <https://github.com/ethereum/solidity/issues/new>`_.
367+
357368
Minimum Compiler Versions
358369
^^^^^^^^^^^^^^^^^^^^^^^^^
359370

0 commit comments

Comments
 (0)