Skip to content
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

Add a CLI help mode to show hidden opts. #30392

Merged
merged 1 commit into from
Dec 21, 2018
Merged

Add a CLI help mode to show hidden opts. #30392

merged 1 commit into from
Dec 21, 2018

Conversation

maleadt
Copy link
Member

@maleadt maleadt commented Dec 14, 2018

Instead of hiding internal/unstable command-line arguments (#24410, #23054), why not show them in a hidden help menu like LLVM does? I've had to look for them in the sources and explain to people that the options hadn't disappeared at least twice already (I know, nothing spectacular, but still).
We could even add an non-stability guarantee to the output and/or move some other rarely used arguments (handle-signals, sysimage, machine-file, etc) over there to make the main help menu more clear.

@@ -184,6 +188,7 @@ JL_DLLEXPORT void jl_parse_opts(int *argcp, char ***argvp)
// with the required arguments defined in base/client.jl `process_options()`
{ "version", no_argument, 0, 'v' },
{ "help", no_argument, 0, 'h' },
{ "help-hidden", no_argument, 0, opt_help_hidden },
Copy link
Sponsor Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about calling this help-all instead? Or maybe passing --help twice?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same to me. -help-hidden is what LLVM uses, and I mimicked.

Copy link
Sponsor Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose matching LLVM for this does make sense.

Copy link
Sponsor Member

@vchuravy vchuravy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recently had to go and look at the source-code to find these options.

@vchuravy vchuravy merged commit 163b019 into master Dec 21, 2018
@vchuravy vchuravy deleted the tb/help_hidden branch December 21, 2018 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants