diff options
| author | Brad King <brad.king@kitware.com> | 2021-07-13 13:33:52 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2021-07-13 13:41:26 (GMT) |
| commit | 161f1f42d6400f4de85767108c090991c41326fe (patch) | |
| tree | 1dff6a4f562c330c67eb67f9b75ea094b73e728d /Help | |
| parent | 00e8292434871887f174cfc1a8b3941abefe4cb1 (diff) | |
| download | CMake-161f1f42d6400f4de85767108c090991c41326fe.zip CMake-161f1f42d6400f4de85767108c090991c41326fe.tar.gz CMake-161f1f42d6400f4de85767108c090991c41326fe.tar.bz2 | |
Help: Clarify 'cmake --build' signature alternatives
Documentation added by
* commit 4f4f2028b8 (Help: Add documentation for buildPresets and
testPresets, 2021-01-13, v3.20.0-rc1~51^2~7)
* commit 676ecf0d37 (cmake-presets: Add build and test presets,
2020-12-14, v3.20.0-rc1~51^2~6)
used square brackets in the `cmake --build` signature to indicate
non-optional alternatives, which is not a typical convention.
A common convention is to use parentheses instead, but in this
case it is probably clearer to list the two signatures separately.
Fixes: #22413
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake.1.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 2d639b6..e23ddd8 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -408,7 +408,8 @@ project binary tree: .. code-block:: shell - cmake --build [<dir> | --preset <preset>] [<options>] [-- <build-tool-options>] + cmake --build <dir> [<options>] [-- <build-tool-options>] + cmake --build --preset <preset> [<options>] [-- <build-tool-options>] This abstracts a native build tool's command-line interface with the following options: |