summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-02-14 15:00:38 +0000
committerKitware Robot <kwrobot@kitware.com>2022-02-14 10:00:44 -0500
commitba1f706768dbc1620ba164d6f152f5018371ba0e (patch)
tree0ca0075c6de9a20f2bda0b9cffeccd74b2fee367
parent59da8629cc289df77ac376968db482b1d43fcf47 (diff)
parent8efd4b537888bd66723224fc2bd9bbee166923d3 (diff)
downloadcmake-ba1f706768dbc1620ba164d6f152f5018371ba0e.tar.gz
Merge topic 'doc-debug-find-pkg-var' into release-3.23
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
-rw-r--r--Help/manual/cmake.1.rst9
-rw-r--r--Source/cmake.h2
2 files changed, 6 insertions, 5 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index c2b4d68e7b..7eb7dec5e0 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.
diff --git a/Source/cmake.h b/Source/cmake.h
index 1187be571e..97444b8660 100644
--- a/Source/cmake.h
+++ b/Source/cmake.h
@@ -488,7 +488,7 @@ public:
//! Do we want debug output from the find commands during the cmake run.
bool GetDebugFindOutput() const { return this->DebugFindOutput; }
bool GetDebugFindOutput(std::string const& var) const;
- bool GetDebugFindPkgOutput(std::string const& var) const;
+ bool GetDebugFindPkgOutput(std::string const& pkg) const;
void SetDebugFindOutput(bool b) { this->DebugFindOutput = b; }
void SetDebugFindOutputPkgs(std::string const& args);
void SetDebugFindOutputVars(std::string const& args);