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
Merged

doc: -help-debug implies -help #14207

merged 1 commit into from Sep 13, 2018

Conversation

@laanwj
Copy link
Member

@laanwj laanwj 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
Copy link
Member

@MarcoFalke MarcoFalke commented Sep 12, 2018

utACK ba6ab6ea2dce8a439caf57b2e7832ac01ee2ae0e

Copy link
Member

@promag promag 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);
Copy link
Member

@promag promag Sep 13, 2018

Nit, Print help message with debugging options and exit.

@laanwj
Copy link
Member Author

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

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 2018_10_help_debug branch from ba6ab6e to d0b1cee Sep 13, 2018
@laanwj laanwj merged commit d0b1cee into bitcoin:master Sep 13, 2018
2 checks passed
laanwj added a commit that referenced this issue Sep 13, 2018
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
deadalnix pushed a commit to Bitcoin-ABC/bitcoin-abc that referenced this issue Mar 17, 2020
Summary:
d0b1cee1fe95eba7b968bed2c33ab681d169c91f 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

Backport of Core [[bitcoin/bitcoin#14207 | PR14207]]

Test Plan:
  ninja
  ./bitcoind --help-debug

Reviewers: O1 Bitcoin ABC, #bitcoin_abc, deadalnix

Reviewed By: O1 Bitcoin ABC, #bitcoin_abc, deadalnix

Differential Revision: https://reviews.bitcoinabc.org/D5486
ftrader pushed a commit to bitcoin-cash-node/bitcoin-cash-node that referenced this issue May 19, 2020
…-help/-h

This MR makes it possible to simply use `-??` or `-help-debug` instead
of the unnecesary long `-? -help-debug` or `-help -help-debug`. The new
`-??` option is also listed directly below `-?` at the top of the CLI
options list, where it is much easier to find. The long form
`-help-debug` becomes a hidden option, just like `-help` and `-h`
already are.

This MR supersedes the need to backport
[PR14207](bitcoin/bitcoin#14207).
The new behaviour of `-help-debug` is equal to current Bitcoin Core and
Bitcoin ABC; our availability of `-??` is the only behavioural
difference in the new situation. Apart from that, only the help text
differs.

Test plan:

1. `bitcoind -?` displays simple help
2. `bitcoind -??` displays help including advanced options
3. `bitcoind -help` displays simple help
4. `bitcoind -help-debug` displays help including advanced options
5. `bitcoind -help -help-debug` displays help including advanced options
6. `bitcoind -h` displays simple help
Munkybooty added a commit to Munkybooty/dash that referenced this issue Jul 8, 2021
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

# Conflicts:
#	src/init.cpp
Munkybooty added a commit to Munkybooty/dash that referenced this issue Jul 9, 2021
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

# Conflicts:
#	src/init.cpp
Munkybooty added a commit to Munkybooty/dash that referenced this issue Jul 11, 2021
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

# Conflicts:
#	src/init.cpp
Munkybooty added a commit to Munkybooty/dash that referenced this issue Jul 12, 2021
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

# Conflicts:
#	src/init.cpp
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants