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

laanwj commented at 1:11 PM on September 12, 2018: member

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 added the label Docs on Sep 12, 2018

MarcoFalke commented at 1:13 PM on September 12, 2018: member

utACK ba6ab6ea2dce8a439caf57b2e7832ac01ee2ae0e

in src/init.cpp:446 in ba6ab6ea2d outdated

 442 | @@ -443,7 +443,7 @@ void SetupServerArgs()
 443 |      gArgs.AddArg("-debug=<category>", "Output debugging information (default: -nodebug, supplying <category> is optional). "
 444 |          "If <category> is not supplied or if <category> = 1, output all debugging information. <category> can be: " + ListLogCategories() + ".", false, OptionsCategory::DEBUG_TEST);
 445 |      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);
 446 | -    gArgs.AddArg("-help-debug", "Show all debugging options (usage: --help -help-debug)", false, OptionsCategory::DEBUG_TEST);
 447 | +    gArgs.AddArg("-help-debug", "Show all debugging options", false, OptionsCategory::DEBUG_TEST);

promag commented at 12:10 AM on September 13, 2018:

Nit, Print help message with debugging options and exit.

promag commented at 12:12 AM on September 13, 2018: member

Makes sense!

Tested ACK ba6ab6e.

Nit, the following comment https://github.com/bitcoin/bitcoin/blob/8f464549c46db2954d7b64d1feb200eb35f2e7e8/src/qt/paymentrequestplus.cpp#L145 could be improved like ..., if -help-debug is used — now it's an option, not a flag.

laanwj commented at 5:55 AM on September 13, 2018: member

@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)

d0b1cee1fe

laanwj force-pushed on Sep 13, 2018

laanwj merged this on Sep 13, 2018

laanwj closed this on Sep 13, 2018

laanwj referenced this in commit 477f258755 on Sep 13, 2018

deadalnix referenced this in commit c53dd70368 on Mar 17, 2020

ftrader referenced this in commit bb46f3063c on May 19, 2020

Munkybooty referenced this in commit b4ddb5ccd1 on Jul 8, 2021

Munkybooty referenced this in commit 5d21d8251b on Jul 9, 2021

Munkybooty referenced this in commit fa925f28c1 on Jul 11, 2021

Munkybooty referenced this in commit 9a00aa29bc on Jul 12, 2021

MarcoFalke locked this on Sep 8, 2021