From 546922a57b73ce67c1599d37f77be5045bfa6b40 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Mon, 14 Feb 2022 20:51:31 +1100 Subject: Help: Fix typo and improve docs for --debug-find-pkg|var options Amends d7b18895bc (cmake: Add filtered debug-find options, 2021-12-07) --- Help/manual/cmake.1.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 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=[,...]`` +``--debug-find-pkg=[,...]`` Put cmake find commands in a debug mode when running under calls - to ``find_package()``, where ```` is an entry in the given - comma-separated list of case-sensitive package names. + to :command:`find_package(\) `, where ```` + 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=[,...]`` Put cmake find commands in a debug mode when called with ```` - as the return variable, where ```` is an entry in the given + as the result variable, where ```` is an entry in the given comma-separated list. Like ``--debug-find``, but limiting scope to the specified variable names. -- cgit v1.2.1 From 8efd4b537888bd66723224fc2bd9bbee166923d3 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Mon, 14 Feb 2022 21:08:36 +1100 Subject: cmake::GetDebugFindPkgOutput: Use consistent argument name The argument name used in the class declaration didn't match the one used in the implementation file. The one in the header appears to be a cut-n-paste from GetDebugFindOutput(), but the implementation makes it clear that "pkg" better infers what the argument represents than "var". --- Source/cmake.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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); -- cgit v1.2.1