Browse Source

Help: Fix command-line synopsis markup syntax

Use `{}` to surround required parts instead of `()`.

Fixes: #17917
Brad King 7 years ago
parent
commit
909ab169eb
4 changed files with 5 additions and 5 deletions
  1. 1 1
      Help/manual/ccmake.1.rst
  2. 1 1
      Help/manual/cmake-gui.1.rst
  3. 2 2
      Help/manual/cmake.1.rst
  4. 1 1
      Help/manual/ctest.1.rst

+ 1 - 1
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
 ===========

+ 1 - 1
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
 ===========

+ 2 - 2
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>...]

+ 1 - 1
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