Help: Document `cmake --build` as a separate command mode (#16093)
The `--build` mode was confusingly documented among other options, falsely implying that it can be used anywhere on the command line. Move the documentation to a dedicated section and clarify its usage as s separate command line mode.
This commit is contained in:
parent
d4faed2f7f
commit
3e503fe1ac
|
@ -10,7 +10,7 @@ Synopsis
|
||||||
|
|
||||||
cmake [<options>] (<path-to-source> | <path-to-existing-build>)
|
cmake [<options>] (<path-to-source> | <path-to-existing-build>)
|
||||||
cmake [(-D <var>=<value>)...] -P <cmake-script-file>
|
cmake [(-D <var>=<value>)...] -P <cmake-script-file>
|
||||||
cmake --build <dir> [<options>] [-- <build-tool-options>...]
|
cmake --build <dir> [<options>...] [-- <build-tool-options>...]
|
||||||
cmake -E <command> [<options>...]
|
cmake -E <command> [<options>...]
|
||||||
cmake --find-package <options>...
|
cmake --find-package <options>...
|
||||||
|
|
||||||
|
@ -49,23 +49,7 @@ Options
|
||||||
display help for each variable.
|
display help for each variable.
|
||||||
|
|
||||||
``--build <dir>``
|
``--build <dir>``
|
||||||
Build a CMake-generated project binary tree.
|
See `Build Tool Mode`_.
|
||||||
|
|
||||||
This abstracts a native build tool's command-line interface with the
|
|
||||||
following options:
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
<dir> = Project binary directory to be built.
|
|
||||||
--target <tgt> = Build <tgt> instead of default targets.
|
|
||||||
May only be specified once.
|
|
||||||
--config <cfg> = For multi-configuration tools, choose <cfg>.
|
|
||||||
--clean-first = Build target 'clean' first, then build.
|
|
||||||
(To clean only, use --target 'clean'.)
|
|
||||||
--use-stderr = Ignored. Behavior is default in CMake >= 3.0.
|
|
||||||
-- = Pass remaining options to the native tool.
|
|
||||||
|
|
||||||
Run ``cmake --build`` with no options for quick help.
|
|
||||||
|
|
||||||
``-N``
|
``-N``
|
||||||
View mode only.
|
View mode only.
|
||||||
|
@ -149,6 +133,38 @@ Options
|
||||||
|
|
||||||
.. include:: OPTIONS_HELP.txt
|
.. include:: OPTIONS_HELP.txt
|
||||||
|
|
||||||
|
Build Tool Mode
|
||||||
|
===============
|
||||||
|
|
||||||
|
CMake provides a command-line signature to build an already-generated
|
||||||
|
project binary tree::
|
||||||
|
|
||||||
|
cmake --build <dir> [<options>...] [-- <build-tool-options>...]
|
||||||
|
|
||||||
|
This abstracts a native build tool's command-line interface with the
|
||||||
|
following options:
|
||||||
|
|
||||||
|
``--build <dir>``
|
||||||
|
Project binary directory to be built. This is required and must be first.
|
||||||
|
|
||||||
|
``--target <tgt>``
|
||||||
|
Build ``<tgt>`` instead of default targets. May only be specified once.
|
||||||
|
|
||||||
|
``--config <cfg>``
|
||||||
|
For multi-configuration tools, choose configuration ``<cfg>``.
|
||||||
|
|
||||||
|
``--clean-first``
|
||||||
|
Build target ``clean`` first, then build.
|
||||||
|
(To clean only, use ``--target clean``.)
|
||||||
|
|
||||||
|
``--use-stderr``
|
||||||
|
Ignored. Behavior is default in CMake >= 3.0.
|
||||||
|
|
||||||
|
``--``
|
||||||
|
Pass remaining options to the native tool.
|
||||||
|
|
||||||
|
Run ``cmake --build`` with no options for quick help.
|
||||||
|
|
||||||
Command-Line Tool Mode
|
Command-Line Tool Mode
|
||||||
======================
|
======================
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue