diff options
| author | Kevin Tolle <kevin.a.tolle@gmail.com> | 2024-09-30 18:42:32 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2024-10-05 06:08:44 (GMT) |
| commit | b80aa1d3a3ba1ad351ad57c42361408a72f7254d (patch) | |
| tree | 8852ba38ab3ff8c0a3220b97b7f7d672bcf3ccd0 /Help | |
| parent | d734f8dc6dec8834b94a77f06836e3c457ede3fc (diff) | |
| download | CMake-b80aa1d3a3ba1ad351ad57c42361408a72f7254d.zip CMake-b80aa1d3a3ba1ad351ad57c42361408a72f7254d.tar.gz CMake-b80aa1d3a3ba1ad351ad57c42361408a72f7254d.tar.bz2 | |
preset: Easier command line interface for Workflow Presets
A positional option allows 'cmake --workflow --preset <preset>' to be
shortened to 'cmake --workflow <preset>'.
Fixes: #26270
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake.1.rst | 13 | ||||
| -rw-r--r-- | Help/release/dev/cmake--workflow-preset.rst | 6 |
2 files changed, 17 insertions, 2 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 586a72e..4610e11 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -31,7 +31,7 @@ Synopsis cmake --find-package [<options>] `Run a Workflow Preset`_ - cmake --workflow [<options>] + cmake --workflow <options> `View Help`_ cmake --help[-<topic>] @@ -1394,7 +1394,7 @@ build steps in order: .. code-block:: shell - cmake --workflow [<options>] + cmake --workflow <options> The options are: @@ -1411,6 +1411,15 @@ The options are: must contain CMake preset files. See :manual:`preset <cmake-presets(7)>` for more details. + .. versionchanged:: 3.31 + When following immediately after the ``--workflow`` option, + the ``--preset`` argument can be omitted and just the ``<preset>`` + name can be given. This means the following syntax is valid: + + .. code-block:: console + + $ cmake --workflow my-preset + .. option:: --list-presets Lists the available workflow presets. The current working directory must diff --git a/Help/release/dev/cmake--workflow-preset.rst b/Help/release/dev/cmake--workflow-preset.rst new file mode 100644 index 0000000..2e07eb9 --- /dev/null +++ b/Help/release/dev/cmake--workflow-preset.rst @@ -0,0 +1,6 @@ +cmake--workflow-preset +---------------------- + +* When executing a CMake workflow preset, the ``--preset`` option can now be + omitted, allowing the simpler command line + :option:`cmake --workflow \<preset\> <cmake--workflow --preset>`. |