diff options
| author | Alex Turbov <i.zaufi@gmail.com> | 2022-08-12 23:03:23 (GMT) |
|---|---|---|
| committer | Alex Turbov <i.zaufi@gmail.com> | 2022-08-14 05:58:41 (GMT) |
| commit | a6070b480fe5b0201d845614c762bf2d594948c3 (patch) | |
| tree | 09c6b72b000682fb46f7fa6fb2064359e4c91821 /Help/manual/cmake.1.rst | |
| parent | 8ba20cb56f90d31271138ce5d0934835cc47b459 (diff) | |
| download | CMake-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.
Diffstat (limited to 'Help/manual/cmake.1.rst')
| -rw-r--r-- | Help/manual/cmake.1.rst | 17 |
1 files changed, 10 insertions, 7 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. |