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

doc: `-help-debug` implies `-help` #14207

Merged
merged 1 commit into from Sep 13, 2018

Conversation

Projects
None yet
3 participants
@laanwj
Copy link
Member

commented Sep 12, 2018

I don't understand why -help-debug would be useful without requesting the help, and I've made this particular mistake one time too many.

@laanwj laanwj added the Docs label Sep 12, 2018

@MarcoFalke

This comment has been minimized.

Copy link
Member

commented Sep 12, 2018

utACK ba6ab6ea2dce8a439caf57b2e7832ac01ee2ae0e

@promag
Copy link
Member

left a comment

Makes sense!

Tested ACK ba6ab6e.

Nit, the following comment

// This option is just shown in the UI options, if -help-debug is enabled.

could be improved like ..., if -help-debug is used — now it's an option, not a flag.

src/init.cpp Outdated
@@ -443,7 +443,7 @@ void SetupServerArgs()
gArgs.AddArg("-debug=<category>", "Output debugging information (default: -nodebug, supplying <category> is optional). "
"If <category> is not supplied or if <category> = 1, output all debugging information. <category> can be: " + ListLogCategories() + ".", false, OptionsCategory::DEBUG_TEST);
gArgs.AddArg("-debugexclude=<category>", strprintf("Exclude debugging information for a category. Can be used in conjunction with -debug=1 to output debug logs for all categories except one or more specified categories."), false, OptionsCategory::DEBUG_TEST);
gArgs.AddArg("-help-debug", "Show all debugging options (usage: --help -help-debug)", false, OptionsCategory::DEBUG_TEST);
gArgs.AddArg("-help-debug", "Show all debugging options", false, OptionsCategory::DEBUG_TEST);

This comment has been minimized.

Copy link
@promag

promag Sep 13, 2018

Member

Nit, Print help message with debugging options and exit.

@laanwj

This comment has been minimized.

Copy link
Member Author

commented Sep 13, 2018

@promag ieeehhh—so the original reason that -help-debug is an option is to show debug options in the GUI option overview? that seems very unlikely to ever be used, if someone wants to add a way to show debug options in the GUI it'd be better to have a check box.
For now, I'm going to remove that comment.

Edit: updated help message and removed comment
Edit.2: looks like you can, even after this change, specify help-debug=1 in bitcoin.confand it will do that, which I guess is good for backwards compatibility but I'm not going to document it

doc: `-help-debug` implies `-help`
I don't understand why `-help-debug` would be useful without requesting
the help, and I've made this particular mistake one time too many.

(ok, so apparently the original reason that -help-debug is an option is
to show debug options in the GUI option overview? that seems very
unlikely to ever be used, if someone wants to add a way to show debug
options in the GUI it'd be better to have a check box)

@laanwj laanwj force-pushed the laanwj:2018_10_help_debug branch to d0b1cee Sep 13, 2018

@laanwj laanwj merged commit d0b1cee into bitcoin:master Sep 13, 2018

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

laanwj added a commit that referenced this pull request Sep 13, 2018

Merge #14207: doc: `-help-debug` implies `-help`
d0b1cee doc: `-help-debug` implies `-help` (Wladimir J. van der Laan)

Pull request description:

  I don't understand why `-help-debug` would be useful without requesting the help, and I've made this particular mistake one time too many.

Tree-SHA512: 370eab368d672fc09e66fcc440db3cb7e4c70c2988aab506cdc3f3e234c27c8f0fc7512c9cf86606ac43f5c6023b3618b7b0302b4b6e289b388559ba8010f27a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.