summaryrefslogtreecommitdiffstats
path: root/Help/manual
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-02-14 15:00:38 (GMT)
committerKitware Robot <kwrobot@kitware.com>2022-02-14 15:00:45 (GMT)
commitc033892e077f26a90890794594aa810f2c07a4e8 (patch)
tree09dfd0d0ece2a50d9be822b4cfca25d9e8afc8c7 /Help/manual
parent6e08cd438e15163dda307f22064deea549c296fc (diff)
parent8efd4b537888bd66723224fc2bd9bbee166923d3 (diff)
downloadCMake-c033892e077f26a90890794594aa810f2c07a4e8.zip
CMake-c033892e077f26a90890794594aa810f2c07a4e8.tar.gz
CMake-c033892e077f26a90890794594aa810f2c07a4e8.tar.bz2
Merge topic 'doc-debug-find-pkg-var'
8efd4b5378 cmake::GetDebugFindPkgOutput: Use consistent argument name 546922a57b Help: Fix typo and improve docs for --debug-find-pkg|var options Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6977
Diffstat (limited to 'Help/manual')
-rw-r--r--Help/manual/cmake.1.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index 37cf7d8..a584141 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -250,16 +250,17 @@ Options
See also the :variable:`CMAKE_FIND_DEBUG_MODE` variable for debugging
a more local part of the project.
-``--debug-find=<pkg>[,...]``
+``--debug-find-pkg=<pkg>[,...]``
Put cmake find commands in a debug mode when running under calls
- to ``find_package(<pkg>)``, where ``<pkg>`` is an entry in the given
- comma-separated list of case-sensitive package names.
+ to :command:`find_package(\<pkg\>) <find_package>`, where ``<pkg>``
+ is an entry in the given comma-separated list of case-sensitive package
+ names.
Like ``--debug-find``, but limiting scope to the specified packages.
``--debug-find-var=<var>[,...]``
Put cmake find commands in a debug mode when called with ``<var>``
- as the return variable, where ``<var>`` is an entry in the given
+ as the result variable, where ``<var>`` is an entry in the given
comma-separated list.
Like ``--debug-find``, but limiting scope to the specified variable names.