diff options
| author | Brad King <brad.king@kitware.com> | 2015-05-20 12:30:36 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-05-20 12:30:36 (GMT) |
| commit | b0ea36730847695c5e9579de92e7dd4272cfc27a (patch) | |
| tree | 4cfecdfa5884284ce7587737bba14d18e9d7daa5 /Help/manual | |
| parent | 594dd9b36a7f3ac37b56c89596ff38451570de3e (diff) | |
| download | CMake-b0ea36730847695c5e9579de92e7dd4272cfc27a.zip CMake-b0ea36730847695c5e9579de92e7dd4272cfc27a.tar.gz CMake-b0ea36730847695c5e9579de92e7dd4272cfc27a.tar.bz2 | |
Help: Spell '-D' option consistently across documentation (#15575)
Always show the option with its argument separate in summary text.
State in the main documentation that the option and its argument can be
given together too.
Diffstat (limited to 'Help/manual')
| -rw-r--r-- | Help/manual/OPTIONS_BUILD.txt | 3 | ||||
| -rw-r--r-- | Help/manual/cmake.1.rst | 2 |
2 files changed, 4 insertions, 1 deletions
diff --git a/Help/manual/OPTIONS_BUILD.txt b/Help/manual/OPTIONS_BUILD.txt index e4c5873..4207db4 100644 --- a/Help/manual/OPTIONS_BUILD.txt +++ b/Help/manual/OPTIONS_BUILD.txt @@ -27,6 +27,9 @@ command in the project sets the type to ``PATH`` or ``FILEPATH`` then the ``<value>`` will be converted to an absolute path. + This option may also be given as a single argument: + ``-D<var>:<type>=<value>`` or ``-D<var>=<value>``. + ``-U <globbing_expr>`` Remove matching entries from CMake cache. diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index b2f7e9d..4bd5a5e 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -9,7 +9,7 @@ Synopsis .. parsed-literal:: 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 -E <command> [<options>...] cmake --find-package <options>... |