diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Console] Improve description for the help flag.

Browse Source
This commit is contained in:
Rodrigo Aguilera 2020-09-29 17:50:06 +02:00 committed by Fabien Potencier
parent af8ad344d3
commit c451c48258
18 changed files with 37 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/Symfony/Component/Console/Application.php
View File

@ -1020,8 +1020,7 @@ class Application implements ResetInterface
{
return new InputDefinition([
new InputArgument('command', InputArgument::REQUIRED, 'The command to execute'),
new InputOption('--help', '-h', InputOption::VALUE_NONE, 'Display this help message'),
new InputOption('--help', '-h', InputOption::VALUE_NONE, 'Display help for the given command. When no command is given display help for the <info>'.$this->defaultCommand.'</info> command'),
new InputOption('--quiet', '-q', InputOption::VALUE_NONE, 'Do not output any message'),
new InputOption('--verbose', '-v|vv|vvv', InputOption::VALUE_NONE, 'Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug'),
new InputOption('--version', '-V', InputOption::VALUE_NONE, 'Display this application version'),

2
src/Symfony/Component/Console/Tests/Command/ListCommandTest.php
View File

@ -77,7 +77,7 @@ Usage:
command [options] [arguments]
Options:
-h, --help Display this help message
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output

4
src/Symfony/Component/Console/Tests/Fixtures/application_1.json
View File

@ -43,7 +43,7 @@
"accept_value": false,
"is_value_required": false,
"is_multiple": false,
"description": "Display this help message",
"description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
"default": false
},
"quiet": {
@ -146,7 +146,7 @@
"accept_value": false,
"is_value_required": false,
"is_multiple": false,
"description": "Display this help message",
"description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
"default": false
},
"quiet": {

4
src/Symfony/Component/Console/Tests/Fixtures/application_1.md
View File

@ -55,7 +55,7 @@ To output raw command help
#### `--help|-h`
Display this help message
Display help for the given command. When no command is given display help for the list command
* Accept value: no
* Is value required: no
@ -173,7 +173,7 @@ The output format (txt, xml, json, or md)
#### `--help|-h`
Display this help message
Display help for the given command. When no command is given display help for the list command
* Accept value: no
* Is value required: no

2
src/Symfony/Component/Console/Tests/Fixtures/application_1.txt
View File

@ -4,7 +4,7 @@ Console Tool
command [options] [arguments]
<comment>Options:</comment>
<info>-h, --help</info> Display this help message
<info>-h, --help</info> Display help for the given command. When no command is given display help for the <info>list</info> command
<info>-q, --quiet</info> Do not output any message
<info>-V, --version</info> Display this application version
<info> --ansi</info> Force ANSI output

4
src/Symfony/Component/Console/Tests/Fixtures/application_1.xml
View File

@ -34,7 +34,7 @@
<description>To output raw command help</description>
</option>
<option name="--help" shortcut="-h" accept_value="0" is_value_required="0" is_multiple="0">
<description>Display this help message</description>
<description>Display help for the given command. When no command is given display help for the &lt;info&gt;list&lt;/info&gt; command</description>
</option>
<option name="--quiet" shortcut="-q" accept_value="0" is_value_required="0" is_multiple="0">
<description>Do not output any message</description>
@ -93,7 +93,7 @@
</defaults>
</option>
<option name="--help" shortcut="-h" accept_value="0" is_value_required="0" is_multiple="0">
<description>Display this help message</description>
<description>Display help for the given command. When no command is given display help for the &lt;info&gt;list&lt;/info&gt; command</description>
</option>
<option name="--quiet" shortcut="-q" accept_value="0" is_value_required="0" is_multiple="0">
<description>Do not output any message</description>

12
src/Symfony/Component/Console/Tests/Fixtures/application_2.json
View File

@ -47,7 +47,7 @@
"accept_value": false,
"is_value_required": false,
"is_multiple": false,
"description": "Display this help message",
"description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
"default": false
},
"quiet": {
@ -150,7 +150,7 @@
"accept_value": false,
"is_value_required": false,
"is_multiple": false,
"description": "Display this help message",
"description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
"default": false
},
"quiet": {
@ -229,7 +229,7 @@
"accept_value": false,
"is_value_required": false,
"is_multiple": false,
"description": "Display this help message",
"description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
"default": false
},
"quiet": {
@ -325,7 +325,7 @@
"accept_value": false,
"is_value_required": false,
"is_multiple": false,
"description": "Display this help message",
"description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
"default": false
},
"quiet": {
@ -402,7 +402,7 @@
"accept_value": false,
"is_value_required": false,
"is_multiple": false,
"description": "Display this help message",
"description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
"default": false
},
"quiet": {
@ -481,7 +481,7 @@
"accept_value": false,
"is_value_required": false,
"is_multiple": false,
"description": "Display this help message",
"description": "Display help for the given command. When no command is given display help for the <info>list</info> command",
"default": false
},
"quiet": {

10
src/Symfony/Component/Console/Tests/Fixtures/application_2.md
View File

@ -68,7 +68,7 @@ To output raw command help
#### `--help|-h`
Display this help message
Display help for the given command. When no command is given display help for the list command
* Accept value: no
* Is value required: no
@ -186,7 +186,7 @@ The output format (txt, xml, json, or md)
#### `--help|-h`
Display this help message
Display help for the given command. When no command is given display help for the list command
* Accept value: no
* Is value required: no
@ -264,7 +264,7 @@ command 1 help
#### `--help|-h`
Display this help message
Display help for the given command. When no command is given display help for the list command
* Accept value: no
* Is value required: no
@ -357,7 +357,7 @@ command 2 help
#### `--help|-h`
Display this help message
Display help for the given command. When no command is given display help for the list command
* Accept value: no
* Is value required: no
@ -432,7 +432,7 @@ Do not ask any interactive question
#### `--help|-h`
Display this help message
Display help for the given command. When no command is given display help for the list command
* Accept value: no
* Is value required: no

2
src/Symfony/Component/Console/Tests/Fixtures/application_2.txt
View File

@ -4,7 +4,7 @@ My Symfony application <info>v1.0</info>
command [options] [arguments]
<comment>Options:</comment>
<info>-h, --help</info> Display this help message
<info>-h, --help</info> Display help for the given command. When no command is given display help for the <info>list</info> command
<info>-q, --quiet</info> Do not output any message
<info>-V, --version</info> Display this application version
<info> --ansi</info> Force ANSI output

12
src/Symfony/Component/Console/Tests/Fixtures/application_2.xml
View File

@ -34,7 +34,7 @@
<description>To output raw command help</description>
</option>
<option name="--help" shortcut="-h" accept_value="0" is_value_required="0" is_multiple="0">
<description>Display this help message</description>
<description>Display help for the given command. When no command is given display help for the &lt;info&gt;list&lt;/info&gt; command</description>
</option>
<option name="--quiet" shortcut="-q" accept_value="0" is_value_required="0" is_multiple="0">
<description>Do not output any message</description>
@ -93,7 +93,7 @@
</defaults>
</option>
<option name="--help" shortcut="-h" accept_value="0" is_value_required="0" is_multiple="0">
<description>Display this help message</description>
<description>Display help for the given command. When no command is given display help for the &lt;info&gt;list&lt;/info&gt; command</description>
</option>
<option name="--quiet" shortcut="-q" accept_value="0" is_value_required="0" is_multiple="0">
<description>Do not output any message</description>
@ -126,7 +126,7 @@
<arguments/>
<options>
<option name="--help" shortcut="-h" accept_value="0" is_value_required="0" is_multiple="0">
<description>Display this help message</description>
<description>Display help for the given command. When no command is given display help for the &lt;info&gt;list&lt;/info&gt; command</description>
</option>
<option name="--quiet" shortcut="-q" accept_value="0" is_value_required="0" is_multiple="0">
<description>Do not output any message</description>
@ -167,7 +167,7 @@
<description></description>
</option>
<option name="--help" shortcut="-h" accept_value="0" is_value_required="0" is_multiple="0">
<description>Display this help message</description>
<description>Display help for the given command. When no command is given display help for the &lt;info&gt;list&lt;/info&gt; command</description>
</option>
<option name="--quiet" shortcut="-q" accept_value="0" is_value_required="0" is_multiple="0">
<description>Do not output any message</description>
@ -198,7 +198,7 @@
<arguments/>
<options>
<option name="--help" shortcut="-h" accept_value="0" is_value_required="0" is_multiple="0">
<description>Display this help message</description>
<description>Display help for the given command. When no command is given display help for the &lt;info&gt;list&lt;/info&gt; command</description>
</option>
<option name="--quiet" shortcut="-q" accept_value="0" is_value_required="0" is_multiple="0">
<description>Do not output any message</description>
@ -231,7 +231,7 @@
<arguments/>
<options>
<option name="--help" shortcut="-h" accept_value="0" is_value_required="0" is_multiple="0">
<description>Display this help message</description>
<description>Display help for the given command. When no command is given display help for the &lt;info&gt;list&lt;/info&gt; command</description>
</option>
<option name="--quiet" shortcut="-q" accept_value="0" is_value_required="0" is_multiple="0">
<description>Do not output any message</description>

2
src/Symfony/Component/Console/Tests/Fixtures/application_filtered_namespace.txt
View File

@ -4,7 +4,7 @@ My Symfony application <info>v1.0</info>
command [options] [arguments]
<comment>Options:</comment>
<info>-h, --help</info> Display this help message
<info>-h, --help</info> Display help for the given command. When no command is given display help for the <info>list</info> command
<info>-q, --quiet</info> Do not output any message
<info>-V, --version</info> Display this application version
<info> --ansi</info> Force ANSI output

6
src/Symfony/Component/Console/Tests/Fixtures/application_mbstring.md
View File

@ -59,7 +59,7 @@ To output raw command help
#### `--help|-h`
Display this help message
Display help for the given command. When no command is given display help for the list command
* Accept value: no
* Is value required: no
@ -177,7 +177,7 @@ The output format (txt, xml, json, or md)
#### `--help|-h`
Display this help message
Display help for the given command. When no command is given display help for the list command
* Accept value: no
* Is value required: no
@ -270,7 +270,7 @@ command åèä help
#### `--help|-h`
Display this help message
Display help for the given command. When no command is given display help for the list command
* Accept value: no
* Is value required: no

2
src/Symfony/Component/Console/Tests/Fixtures/application_mbstring.txt
View File

@ -4,7 +4,7 @@ MbString åpplicätion
command [options] [arguments]
<comment>Options:</comment>
<info>-h, --help</info> Display this help message
<info>-h, --help</info> Display help for the given command. When no command is given display help for the <info>list</info> command
<info>-q, --quiet</info> Do not output any message
<info>-V, --version</info> Display this application version
<info> --ansi</info> Force ANSI output

2
src/Symfony/Component/Console/Tests/Fixtures/application_run1.txt
View File

@ -4,7 +4,7 @@ Usage:
command [options] [arguments]
Options:
-h, --help Display this help message
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output

2
src/Symfony/Component/Console/Tests/Fixtures/application_run2.txt
View File

@ -10,7 +10,7 @@ Arguments:
Options:
--raw To output raw command list
--format=FORMAT The output format (txt, xml, json, or md) [default: "txt"]
-h, --help Display this help message
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output

2
src/Symfony/Component/Console/Tests/Fixtures/application_run3.txt
View File

@ -10,7 +10,7 @@ Arguments:
Options:
--raw To output raw command list
--format=FORMAT The output format (txt, xml, json, or md) [default: "txt"]
-h, --help Display this help message
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output

2
src/Symfony/Component/Console/Tests/Fixtures/application_run5.txt
View File

@ -10,7 +10,7 @@ Arguments:
Options:
--format=FORMAT The output format (txt, xml, json, or md) [default: "txt"]
--raw To output raw command help
-h, --help Display this help message
-h, --help Display help for the given command. When no command is given display help for the list command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output

2
src/Symfony/Component/Console/Tests/phpt/single_application/help_name.phpt
View File

@ -28,7 +28,7 @@ Usage:
%s
Options:
-h, --help Display this help message
-h, --help Display help for the given command. When no command is given display help for the %s command
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output