浏览代码

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

Replace mentions of these options in the presets manual page.
Alex Turbov 3 年之前
父节点
当前提交
e2198fd9dc
共有 2 个文件被更改,包括 30 次插入28 次删除
  1. 22 22
      Help/manual/OPTIONS_BUILD.txt
  2. 8 6
      Help/manual/cmake-presets.7.rst

+ 22 - 22
Help/manual/OPTIONS_BUILD.txt

@@ -109,20 +109,6 @@
  Enable warnings that are meant for the author of the ``CMakeLists.txt``
  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
 
  Enable deprecated functionality warnings.
@@ -137,16 +123,30 @@
  Suppress warnings for usage of deprecated functionality, that are meant
  for the author of the ``CMakeLists.txt`` files.
 
-.. option:: -Werror=deprecated
+.. option:: -Werror=<what>
+
+ Treat CMake warnings as errors. ``<what>`` must be one of the following:
+
+ ``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.
+
+ ``deprecated``
+  Make deprecated macro and function warnings errors.
 
- Make deprecated macro and function warnings errors.
+  Make warnings for usage of deprecated macros and functions, that are meant
+  for the author of the ``CMakeLists.txt`` files, errors.
 
- Make warnings for usage of deprecated macros and functions, that are meant
- for the author of the ``CMakeLists.txt`` files, errors.
+.. option:: -Wno-error=<what>
 
-.. option:: -Wno-error=deprecated
+ Do not treat CMake warnings as errors. ``<what>`` must be one of the following:
 
- Make deprecated macro and function warnings not errors.
+ ``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.
 
- Make warnings for usage of deprecated macros and functions, that are meant
- for the author of the ``CMakeLists.txt`` files, not errors.
+ ``deprecated``
+  Make warnings for usage of deprecated macros and functions, that are meant
+  for the author of the ``CMakeLists.txt`` files, not errors.

+ 8 - 6
Help/manual/cmake-presets.7.rst

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