diff options
| author | Brad King <brad.king@kitware.com> | 2022-10-05 18:33:10 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2022-10-05 19:27:40 (GMT) |
| commit | b768a5e23ba58b1eaf747c54451a5a255663650b (patch) | |
| tree | 93ce8d691dcc28f9dc869400ef60db4ab6ef22d6 /Help/manual/cmake-presets.7.rst | |
| parent | 6ace9562e730328b87ad5b56390e70cb7704050a (diff) | |
| download | CMake-b768a5e23ba58b1eaf747c54451a5a255663650b.zip CMake-b768a5e23ba58b1eaf747c54451a5a255663650b.tar.gz CMake-b768a5e23ba58b1eaf747c54451a5a255663650b.tar.bz2 | |
Help: Disambiguate cmake(1) program modes in Sphinx option references
Define the entry point to each mode as an option for the `cmake`
program, but reference the options for that mode as part of stand-in
`cmake-<mode>` programs.
Diffstat (limited to 'Help/manual/cmake-presets.7.rst')
| -rw-r--r-- | Help/manual/cmake-presets.7.rst | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/Help/manual/cmake-presets.7.rst b/Help/manual/cmake-presets.7.rst index 93f929e..eb3e460 100644 --- a/Help/manual/cmake-presets.7.rst +++ b/Help/manual/cmake-presets.7.rst @@ -460,21 +460,21 @@ that may contain the following fields: ``jobs`` An optional integer. Equivalent to passing - :option:`--parallel <cmake --parallel>` or ``-j`` on the command line. + :option:`--parallel <cmake--build --parallel>` or ``-j`` on the command line. ``targets`` An optional string or array of strings. Equivalent to passing - :option:`--target <cmake --target>` or ``-t`` on the command line. + :option:`--target <cmake--build --target>` or ``-t`` on the command line. Vendors may ignore the targets property or hide build presets that explicitly specify targets. This field supports macro expansion. ``configuration`` - An optional string. Equivalent to passing :option:`--config <cmake --config>` - on the command line. + An optional string. Equivalent to passing + :option:`--config <cmake--build --config>` on the command line. ``cleanFirst`` An optional bool. If true, equivalent to passing - :option:`--clean-first <cmake --clean-first>` on the command line. + :option:`--clean-first <cmake--build --clean-first>` on the command line. ``resolvePackageReferences`` An optional string that specifies the package resolve mode. This is @@ -498,7 +498,7 @@ that may contain the following fields: .. note:: The command line parameter - :option:`--resolve-package-references <cmake --resolve-package-references>` + :option:`--resolve-package-references <cmake--build --resolve-package-references>` will take priority over this setting. If the command line parameter is not provided and this setting is not specified, an environment-specific cache variable will be evaluated to decide, if package restoration should be @@ -512,7 +512,7 @@ that may contain the following fields: ``verbose`` An optional bool. If true, equivalent to passing - :option:`--verbose <cmake --verbose>` on the command line. + :option:`--verbose <cmake--build --verbose>` on the command line. ``nativeToolOptions`` An optional array of strings. Equivalent to passing options after ``--`` @@ -981,6 +981,8 @@ fields: ``vendorName`` An optional string representing the vendor name. +.. _`Workflow Preset`: + Workflow Preset ^^^^^^^^^^^^^^^ |