summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Turbov <i.zaufi@gmail.com>2022-08-12 23:03:23 (GMT)
committerAlex Turbov <i.zaufi@gmail.com>2022-08-14 05:58:41 (GMT)
commita6070b480fe5b0201d845614c762bf2d594948c3 (patch)
tree09c6b72b000682fb46f7fa6fb2064359e4c91821
parent8ba20cb56f90d31271138ce5d0934835cc47b459 (diff)
downloadCMake-a6070b480fe5b0201d845614c762bf2d594948c3.zip
CMake-a6070b480fe5b0201d845614c762bf2d594948c3.tar.gz
CMake-a6070b480fe5b0201d845614c762bf2d594948c3.tar.bz2
Help: Use placeholder instead of listing choices in option lines
This avoids any ambiguity with whether the choices are literal values or not. It also makes the option lines more concise.
-rw-r--r--Help/manual/cmake.1.rst17
-rw-r--r--Help/manual/ctest.1.rst5
-rw-r--r--Source/cmakemain.cxx11
3 files changed, 18 insertions, 15 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index 1e44b6c..1f91a25 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -497,10 +497,12 @@ Options
a variable called ``MYVAR`` to ``1``, but the user sets it to ``2`` with a
``-D`` argument, the value ``2`` is preferred.
-.. option:: --list-presets, --list-presets=<[configure | build | test | all]>
+.. option:: --list-presets[=<type>]
- Lists the available presets. If no option is specified only configure presets
- will be listed. The current working directory must contain CMake preset files.
+ Lists the available presets of the specified ``<type>``. Valid values for
+ ``<type>`` are ``configure``, ``build``, ``test``, or ``all``. If ``<type>``
+ is omitted, ``configure`` is assumed. The current working directory must
+ contain CMake preset files.
.. _`Build Tool Mode`:
@@ -560,14 +562,15 @@ following options:
Build target ``clean`` first, then build.
(To clean only, use :option:`--target clean <cmake --target>`.)
-.. option:: --resolve-package-references=<on|off|only>
+.. option:: --resolve-package-references=<value>
.. versionadded:: 3.23
Resolve remote package references from external package managers (e.g. NuGet)
- before build. When set to ``on`` (default), packages will be restored before
- building a target. When set to ``only``, the packages will be restored, but no
- build will be performed. When set to ``off``, no packages will be restored.
+ before build. When ``<value>`` is set to ``on`` (default), packages will be
+ restored before building a target. When ``<value>`` is set to ``only``, the
+ packages will be restored, but no build will be performed. When
+ ``<value>`` is set to ``off``, no packages will be restored.
If the target does not define any package references, this option does nothing.
diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst
index 5f6927f..8e0be19 100644
--- a/Help/manual/ctest.1.rst
+++ b/Help/manual/ctest.1.rst
@@ -419,9 +419,10 @@ Run Tests
This option will not run any tests, it will simply print the list of
all labels associated with the test set.
-.. option:: --no-tests=<[error|ignore]>
+.. option:: --no-tests=<action>
- Regard no tests found either as error or ignore it.
+ Regard no tests found either as error (when ``<action>`` is set to
+ ``error``) or ignore it (when ``<action>`` is set to ``ignore``).
If no tests were found, the default behavior of CTest is to always log an
error message but to return an error code in script mode only. This option
diff --git a/Source/cmakemain.cxx b/Source/cmakemain.cxx
index 5837bc5..6f3d0eb 100644
--- a/Source/cmakemain.cxx
+++ b/Source/cmakemain.cxx
@@ -71,7 +71,7 @@ const char* cmDocumentationUsageNote[][2] = {
const char* cmDocumentationOptions[][2] = {
CMAKE_STANDARD_OPTIONS_TABLE,
{ "--preset <preset>,--preset=<preset>", "Specify a configure preset." },
- { "--list-presets", "List available presets." },
+ { "--list-presets[=<type>]", "List available presets." },
{ "-E", "CMake command mode." },
{ "-L[A][H]", "List non-advanced cached variables." },
{ "--fresh",
@@ -83,8 +83,8 @@ const char* cmDocumentationOptions[][2] = {
{ "-P <file>", "Process script mode." },
{ "--find-package", "Legacy pkg-config like mode. Do not use." },
{ "--graphviz=<file>",
- "Generate graphviz of dependencies, see "
- "CMakeGraphVizOptions.cmake for more." },
+ "Generate graphviz of dependencies, see CMakeGraphVizOptions.cmake for "
+ "more." },
{ "--system-information [file]", "Dump information about this system." },
{ "--log-level=<ERROR|WARNING|NOTICE|STATUS|VERBOSE|DEBUG|TRACE>",
"Set the verbosity of messages from CMake files. "
@@ -109,8 +109,7 @@ const char* cmDocumentationOptions[][2] = {
{ "--warn-uninitialized", "Warn about uninitialized values." },
{ "--no-warn-unused-cli", "Don't warn about command line options." },
{ "--check-system-vars",
- "Find problems with variable usage in system "
- "files." },
+ "Find problems with variable usage in system files." },
{ "--compile-no-warning-as-error",
"Ignore COMPILE_WARNING_AS_ERROR property and "
"CMAKE_COMPILE_WARNING_AS_ERROR variable." },
@@ -616,7 +615,7 @@ int do_build(int ac, char const* const* av)
" <dir> = Project binary directory to be built.\n"
" --preset <preset>, --preset=<preset>\n"
" = Specify a build preset.\n"
- " --list-presets\n"
+ " --list-presets[=<type>]\n"
" = List available build presets.\n"
" --parallel [<jobs>], -j [<jobs>]\n"
" = Build in parallel using the given number of jobs. \n"