-
Notifications
You must be signed in to change notification settings - Fork 359
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CLI help updates #4317
CLI help updates #4317
Conversation
The --help and --version options are documented in COMMON OPTIONS for most commands but were documented in OPTIONS for command aliases!
1e5c401 FWIW should go to 2.0 as well. |
On the environment variable, no reason to not switch to |
How about |
ok with that, or a more specific |
Only reason I could see is the completion scripts that parse the manpage output; but they don't use this section so it should be fine. |
Best checked commit-by-commit:
Cmdliner.Manpage.s_
constants instead of hard-coded section names (small tidy-up, although possibly one "bug" found)--help
and--version
options inOPTIONS
instead ofCOMMON OPTIONS
opam lock --help
was missing all the common information (ENVIRONMENT
,BUGS
, etc.)There are two other things to consider/fix:
ENVIRONMENT VARIABLES
(OpamArg.help_sections
) but the standard name isENVIRONMENT
(Cmdliner.Manpage.s_environment
) - any reason not to change this?What is changed in the lock file?
- this should be in capitals and re-worded. PerhapsLOCK PROCEDURE
, perhaps?