diff options
| author | Brad King <brad.king@kitware.com> | 2018-04-18 12:25:47 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2018-04-18 12:28:32 (GMT) |
| commit | 909ab169eb83f0a60f717aa87c5549e77e09e35f (patch) | |
| tree | 32ab532868bf188c57e34ef45c96903e9f96bd99 | |
| parent | 9260dedfd2ab473d87679e215ea10cd572765766 (diff) | |
| download | CMake-909ab169eb83f0a60f717aa87c5549e77e09e35f.zip CMake-909ab169eb83f0a60f717aa87c5549e77e09e35f.tar.gz CMake-909ab169eb83f0a60f717aa87c5549e77e09e35f.tar.bz2 | |
Help: Fix command-line synopsis markup syntax
Use `{}` to surround required parts instead of `()`.
Fixes: #17917
| -rw-r--r-- | Help/manual/ccmake.1.rst | 2 | ||||
| -rw-r--r-- | Help/manual/cmake-gui.1.rst | 2 | ||||
| -rw-r--r-- | Help/manual/cmake.1.rst | 4 | ||||
| -rw-r--r-- | Help/manual/ctest.1.rst | 2 |
4 files changed, 5 insertions, 5 deletions
diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst index a5fe191..cc3ceec 100644 --- a/Help/manual/ccmake.1.rst +++ b/Help/manual/ccmake.1.rst @@ -8,7 +8,7 @@ Synopsis .. parsed-literal:: - ccmake [<options>] (<path-to-source> | <path-to-existing-build>) + ccmake [<options>] {<path-to-source> | <path-to-existing-build>} Description =========== diff --git a/Help/manual/cmake-gui.1.rst b/Help/manual/cmake-gui.1.rst index 032b51f..57a9850 100644 --- a/Help/manual/cmake-gui.1.rst +++ b/Help/manual/cmake-gui.1.rst @@ -9,7 +9,7 @@ Synopsis .. parsed-literal:: cmake-gui [<options>] - cmake-gui [<options>] (<path-to-source> | <path-to-existing-build>) + cmake-gui [<options>] {<path-to-source> | <path-to-existing-build>} Description =========== diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index c2e6435..577d321 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -8,8 +8,8 @@ Synopsis .. parsed-literal:: - cmake [<options>] (<path-to-source> | <path-to-existing-build>) - cmake [(-D <var>=<value>)...] -P <cmake-script-file> + cmake [<options>] {<path-to-source> | <path-to-existing-build>} + cmake [{-D <var>=<value>}...] -P <cmake-script-file> cmake --build <dir> [<options>...] [-- <build-tool-options>...] cmake --open <dir> cmake -E <command> [<options>...] diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 75af22e..9553d15 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -13,7 +13,7 @@ Synopsis ctest [<options>] ctest <path-to-source> <path-to-build> --build-generator <generator> [<options>...] [-- <build-options>...] [--test-command <test>] - ctest (-D <dashboard> | -M <model> -T <action> | -S <script> | -SP <script>) + ctest {-D <dashboard> | -M <model> -T <action> | -S <script> | -SP <script>} [-- <dashboard-options>...] Description |