mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
Merge pull request #10064 from hqhq/hq_fix_flag_comments
correct the flag comments
This commit is contained in:
commit
eaeaf0d8e3
1 changed files with 8 additions and 4 deletions
|
@ -24,11 +24,15 @@
|
||||||
For such flags, the default value is just the initial value of the variable.
|
For such flags, the default value is just the initial value of the variable.
|
||||||
|
|
||||||
You can also add "deprecated" flags, they are still usable, but are not shown
|
You can also add "deprecated" flags, they are still usable, but are not shown
|
||||||
in the usage and will display a warning when you try to use them:
|
in the usage and will display a warning when you try to use them. `#` before
|
||||||
var ip = flag.Int([]string{"#f", "#flagname", "-flagname2"}, 1234, "help message for flagname")
|
an option means this option is deprecated, if there is an following option
|
||||||
this will display: `Warning: '--flagname' is deprecated, it will be replaced by '--flagname2' soon. See usage.` and
|
without `#` ahead, then that's the replacement, if not, it will just be removed:
|
||||||
|
var ip = flag.Int([]string{"#f", "#flagname", "-flagname"}, 1234, "help message for flagname")
|
||||||
|
this will display: `Warning: '-f' is deprecated, it will be replaced by '--flagname' soon. See usage.` or
|
||||||
|
this will display: `Warning: '-flagname' is deprecated, it will be replaced by '--flagname' soon. See usage.`
|
||||||
var ip = flag.Int([]string{"f", "#flagname"}, 1234, "help message for flagname")
|
var ip = flag.Int([]string{"f", "#flagname"}, 1234, "help message for flagname")
|
||||||
will display: `Warning: '-f' is deprecated, it will be removed soon. See usage.`
|
will display: `Warning: '-flagname' is deprecated, it will be removed soon. See usage.`
|
||||||
|
so you can only use `-f`.
|
||||||
|
|
||||||
You can also group one letter flags, bif you declare
|
You can also group one letter flags, bif you declare
|
||||||
var v = flag.Bool([]string{"v", "-verbose"}, false, "help message for verbose")
|
var v = flag.Bool([]string{"v", "-verbose"}, false, "help message for verbose")
|
||||||
|
|
Loading…
Reference in a new issue