mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-04 12:49:36 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Format -Werror/-Wno-error in the way it can be referenced

Browse Source 
Replace mentions of these options in the presets manual page.
This commit is contained in:
Alex Turbov
2022-08-13 03:15:45 +04:00
parent a6070b480f
commit e2198fd9dc
2 changed files with 30 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
Help/manual/OPTIONS_BUILD.txt
View File

@@ -109,20 +109,6 @@
Enable warnings that are meant for the author of the ``CMakeLists.txt`` Enable warnings that are meant for the author of the ``CMakeLists.txt``
files. By default this will also turn on deprecation warnings. files. By default this will also turn on deprecation warnings.
.. option:: -Werror=dev
Make developer warnings errors.
Make warnings that are meant for the author of the ``CMakeLists.txt`` files
errors. By default this will also turn on deprecated warnings as errors.
.. option:: -Wno-error=dev
Make developer warnings not errors.
Make warnings that are meant for the author of the ``CMakeLists.txt`` files not
errors. By default this will also turn off deprecated warnings as errors.
.. option:: -Wdeprecated .. option:: -Wdeprecated
Enable deprecated functionality warnings. Enable deprecated functionality warnings.
@@ -137,16 +123,30 @@
Suppress warnings for usage of deprecated functionality, that are meant Suppress warnings for usage of deprecated functionality, that are meant
for the author of the ``CMakeLists.txt`` files. for the author of the ``CMakeLists.txt`` files.
.. option:: -Werror=deprecated .. option:: -Werror=<what>
Make deprecated macro and function warnings errors. Treat CMake warnings as errors. ``<what>`` must be one of the following:
Make warnings for usage of deprecated macros and functions, that are meant ``dev``
for the author of the ``CMakeLists.txt`` files, errors. Make developer warnings errors.
.. option:: -Wno-error=deprecated Make warnings that are meant for the author of the ``CMakeLists.txt`` files
errors. By default this will also turn on deprecated warnings as errors.
Make deprecated macro and function warnings not errors. ``deprecated``
Make deprecated macro and function warnings errors.
Make warnings for usage of deprecated macros and functions, that are meant Make warnings for usage of deprecated macros and functions, that are meant
for the author of the ``CMakeLists.txt`` files, not errors. for the author of the ``CMakeLists.txt`` files, errors.
.. option:: -Wno-error=<what>
Do not treat CMake warnings as errors. ``<what>`` must be one of the following:
``dev``
Make warnings that are meant for the author of the ``CMakeLists.txt`` files not
errors. By default this will also turn off deprecated warnings as errors.
``deprecated``
Make warnings for usage of deprecated macros and functions, that are meant
for the author of the ``CMakeLists.txt`` files, not errors.

14
Help/manual/cmake-presets.7.rst
View File

@@ -349,15 +349,17 @@ that may contain the following fields:
``dev`` ``dev``
An optional boolean. Equivalent to passing ``-Werror=dev`` or An optional boolean. Equivalent to passing :option:`-Werror=dev <cmake -Werror>`
``-Wno-error=dev`` on the command line. This may not be set to ``true`` or :option:`-Wno-error=dev <cmake -Werror>` on the command line.
if ``warnings.dev`` is set to ``false``. This may not be set to ``true`` if ``warnings.dev`` is set to ``false``.
``deprecated`` ``deprecated``
An optional boolean. Equivalent to passing ``-Werror=deprecated`` or An optional boolean. Equivalent to passing
``-Wno-error=deprecated`` on the command line. This may not be set to :option:`-Werror=deprecated <cmake -Werror>` or
``true`` if ``warnings.deprecated`` is set to ``false``. :option:`-Wno-error=deprecated <cmake -Werror>` on the command line.
This may not be set to ``true`` if ``warnings.deprecated`` is set to
``false``.
``debug`` ``debug``