summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2020-10-14 15:16:49 -0400
committerKyle Edwards <kyle.edwards@kitware.com>2020-10-19 10:25:57 -0400
commit88c9d6f6eb2307aa083845246a7182e8dc0906fd (patch)
treee8b8fc837ca5861e74b5faa107dd677f200fb9ec /Help
parentefab856008e104fe8de237095b0c3ef62401f32a (diff)
downloadcmake-88c9d6f6eb2307aa083845246a7182e8dc0906fd.tar.gz
Help: Add documentation for debug field
Oops!
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-presets.7.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst
index c93df2054c..c24b74e21d 100644
--- a/Help/manual/cmake-presets.7.rst
+++ b/Help/manual/cmake-presets.7.rst
@@ -263,6 +263,26 @@ Format
``-Wno-error=deprecated`` on the command line. This may not be set to
``true`` if ``warnings.deprecated`` is set to ``false``.
+ ``debug``
+
+ An optional object specifying debug options. The object may contain the
+ following fields:
+
+ ``output``
+
+ An optional boolean. Setting this to ``true`` is equivalent to passing
+ ``--debug-output`` on the command line.
+
+ ``tryCompile``
+
+ An optional boolean. Setting this to ``true`` is equivalent to passing
+ ``--debug-trycompile`` on the command line.
+
+ ``find``
+
+ An optional boolean. Setting this to ``true`` is equivalent to passing
+ ``--debug-find`` on the command line.
+
As mentioned above, some fields support macro expansion. Macros are
recognized in the form ``$<macro-namespace>{<macro-name>}``. All macros are
evaluated in the context of the preset being used, even if the macro is in a