From 798834ef6322e7cac19e3d54e4fd80ed11a7c933 Mon Sep 17 00:00:00 2001 From: Alex Turbov Date: Tue, 9 Aug 2022 22:56:04 +0400 Subject: =?UTF-8?q?Help:=20``=20=E2=86=92=20``=20for=20`--help*`?= =?UTF-8?q?=20option=20descriptions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Help/manual/OPTIONS_HELP.txt | 40 ++++++++++++++++++++-------------------- 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 ile if given. +.. |file| replace:: The help is printed to a named ```` 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 [] +.. option:: --version, -version, /V [] Show program name/version banner and exit. If a file is specified, the version is written into it. |file| -.. option:: --help-full [] +.. option:: --help-full [] Print all help manuals and exit. All manuals are printed in a human-readable text format. |file| -.. option:: --help-manual [] +.. option:: --help-manual [] Print one help manual and exit. The specified manual is printed in a human-readable text format. |file| -.. option:: --help-manual-list [] +.. option:: --help-manual-list [] List help manuals available and exit. @@ -35,7 +35,7 @@ using the ``--help-manual`` option followed by a manual name. |file| -.. option:: --help-command [] +.. option:: --help-command [] Print help for one command and exit. @@ -43,7 +43,7 @@ printed in a human-readable text format. |file| -.. option:: --help-command-list [] +.. option:: --help-command-list [] 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 [] +.. option:: --help-commands [] Print cmake-commands manual and exit. @@ -59,7 +59,7 @@ human-readable text format. |file| -.. option:: --help-module [] +.. option:: --help-module [] Print help for one module and exit. @@ -67,7 +67,7 @@ in a human-readable text format. |file| -.. option:: --help-module-list [] +.. option:: --help-module-list [] 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 [] +.. option:: --help-modules [] Print cmake-modules manual and exit. @@ -83,7 +83,7 @@ text format. |file| -.. option:: --help-policy [] +.. option:: --help-policy [] Print help for one policy and exit. @@ -91,7 +91,7 @@ printed in a human-readable text format. |file| -.. option:: --help-policy-list [] +.. option:: --help-policy-list [] 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 [] +.. option:: --help-policies [] Print cmake-policies manual and exit. @@ -107,7 +107,7 @@ human-readable text format. |file| -.. option:: --help-property [] +.. option:: --help-property [] Print help for one property and exit. @@ -115,7 +115,7 @@ printed in a human-readable text format. |file| -.. option:: --help-property-list [] +.. option:: --help-property-list [] 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 [] +.. option:: --help-properties [] Print cmake-properties manual and exit. @@ -131,7 +131,7 @@ human-readable text format. |file| -.. option:: --help-variable [] +.. option:: --help-variable [] Print help for one variable and exit. @@ -139,7 +139,7 @@ printed in a human-readable text format. |file| -.. option:: --help-variable-list [] +.. option:: --help-variable-list [] 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 [] +.. option:: --help-variables [] 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 []", "Print version number and exit." }, - { "--help-full []", "Print all help manuals and exit." }, - { "--help-manual []", "Print one help manual and exit." }, - { "--help-manual-list []", "List help manuals available and exit." }, - { "--help-command []", "Print help for one command and exit." }, - { "--help-command-list []", + { "-h,-H,--help,-help,-usage,/?", "Print usage information and exit." }, + { "--version,-version,/V []", "Print version number and exit." }, + { "--help-full []", "Print all help manuals and exit." }, + { "--help-manual []", "Print one help manual and exit." }, + { "--help-manual-list []", "List help manuals available and exit." }, + { "--help-command []", "Print help for one command and exit." }, + { "--help-command-list []", "List commands with help available and exit." }, - { "--help-commands []", "Print cmake-commands manual and exit." }, - { "--help-module []", "Print help for one module and exit." }, - { "--help-module-list []", "List modules with help available and exit." }, - { "--help-modules []", "Print cmake-modules manual and exit." }, - { "--help-policy []", "Print help for one policy and exit." }, - { "--help-policy-list []", + { "--help-commands []", "Print cmake-commands manual and exit." }, + { "--help-module []", "Print help for one module and exit." }, + { "--help-module-list []", + "List modules with help available and exit." }, + { "--help-modules []", "Print cmake-modules manual and exit." }, + { "--help-policy []", "Print help for one policy and exit." }, + { "--help-policy-list []", "List policies with help available and exit." }, - { "--help-policies []", "Print cmake-policies manual and exit." }, - { "--help-property []", "Print help for one property and exit." }, - { "--help-property-list []", + { "--help-policies []", "Print cmake-policies manual and exit." }, + { "--help-property []", + "Print help for one property and exit." }, + { "--help-property-list []", "List properties with help available and exit." }, - { "--help-properties []", "Print cmake-properties manual and exit." }, - { "--help-variable var []", "Print help for one variable and exit." }, - { "--help-variable-list []", + { "--help-properties []", "Print cmake-properties manual and exit." }, + { "--help-variable var []", "Print help for one variable and exit." }, + { "--help-variable-list []", "List variables with help available and exit." }, - { "--help-variables []", "Print cmake-variables manual and exit." }, + { "--help-variables []", "Print cmake-variables manual and exit." }, { nullptr, nullptr } }; -- cgit v0.12