diff options
author | Alex Turbov <i.zaufi@gmail.com> | 2022-08-09 18:56:04 (GMT) |
---|---|---|
committer | Alex Turbov <i.zaufi@gmail.com> | 2022-08-14 05:58:41 (GMT) |
commit | 798834ef6322e7cac19e3d54e4fd80ed11a7c933 (patch) | |
tree | 78af33548489e75523a1e5070acc30684fc71121 | |
parent | 7f4b90a3a6d9adf34bc1b89c630107bf50fb0237 (diff) | |
download | CMake-798834ef6322e7cac19e3d54e4fd80ed11a7c933.zip CMake-798834ef6322e7cac19e3d54e4fd80ed11a7c933.tar.gz CMake-798834ef6322e7cac19e3d54e4fd80ed11a7c933.tar.bz2 |
Help: `<f>` → `<file>` for `--help*` option descriptions
-rw-r--r-- | Help/manual/OPTIONS_HELP.txt | 40 | ||||
-rw-r--r-- | Source/cmDocumentation.cxx | 42 |
2 files changed, 42 insertions, 40 deletions
diff --git a/Help/manual/OPTIONS_HELP.txt b/Help/manual/OPTIONS_HELP.txt index 92bdf1e..00e5714 100644 --- a/Help/manual/OPTIONS_HELP.txt +++ b/Help/manual/OPTIONS_HELP.txt @@ -1,4 +1,4 @@ -.. |file| replace:: The help is printed to a named <f>ile if given. +.. |file| replace:: The help is printed to a named ``<file>`` if given. .. option:: --help, -help, -usage, -h, -H, /? @@ -6,28 +6,28 @@ Usage describes the basic command line interface and its options. -.. option:: --version, -version, /V [<f>] +.. option:: --version, -version, /V [<file>] Show program name/version banner and exit. If a file is specified, the version is written into it. |file| -.. option:: --help-full [<f>] +.. option:: --help-full [<file>] Print all help manuals and exit. All manuals are printed in a human-readable text format. |file| -.. option:: --help-manual <man> [<f>] +.. option:: --help-manual <man> [<file>] Print one help manual and exit. The specified manual is printed in a human-readable text format. |file| -.. option:: --help-manual-list [<f>] +.. option:: --help-manual-list [<file>] List help manuals available and exit. @@ -35,7 +35,7 @@ using the ``--help-manual`` option followed by a manual name. |file| -.. option:: --help-command <cmd> [<f>] +.. option:: --help-command <cmd> [<file>] Print help for one command and exit. @@ -43,7 +43,7 @@ printed in a human-readable text format. |file| -.. option:: --help-command-list [<f>] +.. option:: --help-command-list [<file>] List commands with help available and exit. @@ -51,7 +51,7 @@ using the ``--help-command`` option followed by a command name. |file| -.. option:: --help-commands [<f>] +.. option:: --help-commands [<file>] Print cmake-commands manual and exit. @@ -59,7 +59,7 @@ human-readable text format. |file| -.. option:: --help-module <mod> [<f>] +.. option:: --help-module <mod> [<file>] Print help for one module and exit. @@ -67,7 +67,7 @@ in a human-readable text format. |file| -.. option:: --help-module-list [<f>] +.. option:: --help-module-list [<file>] List modules with help available and exit. @@ -75,7 +75,7 @@ using the ``--help-module`` option followed by a module name. |file| -.. option:: --help-modules [<f>] +.. option:: --help-modules [<file>] Print cmake-modules manual and exit. @@ -83,7 +83,7 @@ text format. |file| -.. option:: --help-policy <cmp> [<f>] +.. option:: --help-policy <cmp> [<file>] Print help for one policy and exit. @@ -91,7 +91,7 @@ printed in a human-readable text format. |file| -.. option:: --help-policy-list [<f>] +.. option:: --help-policy-list [<file>] List policies with help available and exit. @@ -99,7 +99,7 @@ using the ``--help-policy`` option followed by a policy name. |file| -.. option:: --help-policies [<f>] +.. option:: --help-policies [<file>] Print cmake-policies manual and exit. @@ -107,7 +107,7 @@ human-readable text format. |file| -.. option:: --help-property <prop> [<f>] +.. option:: --help-property <prop> [<file>] Print help for one property and exit. @@ -115,7 +115,7 @@ printed in a human-readable text format. |file| -.. option:: --help-property-list [<f>] +.. option:: --help-property-list [<file>] List properties with help available and exit. @@ -123,7 +123,7 @@ using the ``--help-property`` option followed by a property name. |file| -.. option:: --help-properties [<f>] +.. option:: --help-properties [<file>] Print cmake-properties manual and exit. @@ -131,7 +131,7 @@ human-readable text format. |file| -.. option:: --help-variable <var> [<f>] +.. option:: --help-variable <var> [<file>] Print help for one variable and exit. @@ -139,7 +139,7 @@ printed in a human-readable text format. |file| -.. option:: --help-variable-list [<f>] +.. option:: --help-variable-list [<file>] List variables with help available and exit. @@ -147,7 +147,7 @@ using the ``--help-variable`` option followed by a variable name. |file| -.. option:: --help-variables [<f>] +.. option:: --help-variables [<file>] Print cmake-variables manual and exit. diff --git a/Source/cmDocumentation.cxx b/Source/cmDocumentation.cxx index 3619ade..d466a12 100644 --- a/Source/cmDocumentation.cxx +++ b/Source/cmDocumentation.cxx @@ -17,30 +17,32 @@ #include "cmVersion.h" static const char* cmDocumentationStandardOptions[][2] = { - { "--help,-help,-usage,-h,-H,/?", "Print usage information and exit." }, - { "--version,-version,/V [<f>]", "Print version number and exit." }, - { "--help-full [<f>]", "Print all help manuals and exit." }, - { "--help-manual <man> [<f>]", "Print one help manual and exit." }, - { "--help-manual-list [<f>]", "List help manuals available and exit." }, - { "--help-command <cmd> [<f>]", "Print help for one command and exit." }, - { "--help-command-list [<f>]", + { "-h,-H,--help,-help,-usage,/?", "Print usage information and exit." }, + { "--version,-version,/V [<file>]", "Print version number and exit." }, + { "--help-full [<file>]", "Print all help manuals and exit." }, + { "--help-manual <man> [<file>]", "Print one help manual and exit." }, + { "--help-manual-list [<file>]", "List help manuals available and exit." }, + { "--help-command <cmd> [<file>]", "Print help for one command and exit." }, + { "--help-command-list [<file>]", "List commands with help available and exit." }, - { "--help-commands [<f>]", "Print cmake-commands manual and exit." }, - { "--help-module <mod> [<f>]", "Print help for one module and exit." }, - { "--help-module-list [<f>]", "List modules with help available and exit." }, - { "--help-modules [<f>]", "Print cmake-modules manual and exit." }, - { "--help-policy <cmp> [<f>]", "Print help for one policy and exit." }, - { "--help-policy-list [<f>]", + { "--help-commands [<file>]", "Print cmake-commands manual and exit." }, + { "--help-module <mod> [<file>]", "Print help for one module and exit." }, + { "--help-module-list [<file>]", + "List modules with help available and exit." }, + { "--help-modules [<file>]", "Print cmake-modules manual and exit." }, + { "--help-policy <cmp> [<file>]", "Print help for one policy and exit." }, + { "--help-policy-list [<file>]", "List policies with help available and exit." }, - { "--help-policies [<f>]", "Print cmake-policies manual and exit." }, - { "--help-property <prop> [<f>]", "Print help for one property and exit." }, - { "--help-property-list [<f>]", + { "--help-policies [<file>]", "Print cmake-policies manual and exit." }, + { "--help-property <prop> [<file>]", + "Print help for one property and exit." }, + { "--help-property-list [<file>]", "List properties with help available and exit." }, - { "--help-properties [<f>]", "Print cmake-properties manual and exit." }, - { "--help-variable var [<f>]", "Print help for one variable and exit." }, - { "--help-variable-list [<f>]", + { "--help-properties [<file>]", "Print cmake-properties manual and exit." }, + { "--help-variable var [<file>]", "Print help for one variable and exit." }, + { "--help-variable-list [<file>]", "List variables with help available and exit." }, - { "--help-variables [<f>]", "Print cmake-variables manual and exit." }, + { "--help-variables [<file>]", "Print cmake-variables manual and exit." }, { nullptr, nullptr } }; |