Skip to content

Use debug instead of hidden in debug conf options #7803

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.

Sign up for GitHub

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

Open
nitely wants to merge 5 commits into
base: unstable
Choose a base branch
from
Open

Use debug instead of hidden in debug conf options #7803

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2e4a90b
test confutils debug
nitely Dec 15, 2025
3fc2471
wip
nitely Dec 15, 2025
674c187
wip
nitely Dec 15, 2025
dd8aaed
back to hidden
nitely Dec 15, 2025
a178360
remove debug
nitely Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions beacon_chain/conf.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ type
name: "subscribe-all-subnets" .}: bool

debugPeerdasSupernode* {.
hidden
debug
Copy link
Contributor

@tersec tersec Dec 16, 2025

Choose a reason for hiding this comment

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

This one is going away soon anyway, as announced in a recent release notes. It's --debug and that's what --debug-foo options do.

So definitely not something to add visibility to now.

Copy link
Contributor

@tersec tersec Dec 16, 2025

Choose a reason for hiding this comment

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

Also this one has been replaced by a supported option, anyway. Turned out there was nontrivial demand due to the blob use cases. So especially useless as a "debug" option.

Copy link
Member

@arnetheduck arnetheduck Dec 16, 2025

Choose a reason for hiding this comment

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

again, the key is to set expectations and document the change: 'In release XYZ, --debug-frob has migrated to --frob - the old name will be removed in the 25.x release'

Copy link
Contributor

@tersec tersec Dec 16, 2025

Choose a reason for hiding this comment

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

See elsewhere. The point is for this PR that it's a useless thing to expose.

defaultValue: false,
name: "debug-peerdas-supernode" .}: bool

Expand Down Expand Up @@ -397,7 +397,7 @@ type
name: "verify-finalization" .}: bool

stopAtEpoch* {.
hidden
debug
desc: "The wall-time epoch at which to exit the program. (for testing purposes)"
defaultValue: 0
name: "debug-stop-at-epoch" .}: uint64
Copy link
Contributor Author

@nitely nitely Dec 15, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

There is a hidden stopAtSyncedEpoch below this option. Should that be switched to debug? (also adding debug- prefix).

Expand Down Expand Up @@ -557,7 +557,7 @@ type
name: "light-client-data-max-periods" .}: Option[uint64]

longRangeSync* {.
hidden
debug
Copy link
Contributor

@tersec tersec Dec 16, 2025

Choose a reason for hiding this comment

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

This isn't really a "debugging" option, it's a feature that we never ended up enforcing, for various reasons.

etc etc etc

All of these have similar stories. hidden, not debug insofar as it would make them visible with a --help:debug option.

desc: "Enable long-range syncing (genesis sync)",
defaultValue: LongRangeSyncMode.Lenient,
name: "debug-long-range-sync".}: LongRangeSyncMode
Expand Down Expand Up @@ -601,7 +601,7 @@ type
# `--debug-invalidate-block-root` flag present until finality has
# advanced beyond the problematic chain segment
invalidBlockRoots* {.
hidden
debug
desc: "List of beacon block roots that, if the EL responds with SYNCING/ACCEPTED, are treated as if their execution payload was INVALID"
name: "debug-invalidate-block-root" .}: seq[Eth2Digest]

Expand Down Expand Up @@ -685,14 +685,14 @@ type
name: "history".}: HistoryMode

trustedSetupFile* {.
hidden
debug
Copy link
Contributor

@tersec tersec Dec 16, 2025

Choose a reason for hiding this comment

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

This is/was something to help Ethpandaops run their devnets. That's ... I think? the only use it ever got, and better that it would not be visible at all.

Copy link
Contributor

@tersec tersec Dec 16, 2025

Choose a reason for hiding this comment

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

Also regarding this one, I'm not sure it's been used since the Dencun devnets, or has any remaining usecases now that the KZG setup is confirmed/set.

For theoretical-other-KZG setups, they'd be coming with other changes realistically anyway. A parameter to tweak this specifically is likely obsolete even for testing.

desc: "Alternative EIP-4844 trusted setup file"
defaultValue: none(string)
defaultValueDesc: "Baked in trusted setup"
name: "debug-trusted-setup-file" .}: Option[string]

bandwidthEstimate* {.
hidden
debug
desc: "Bandwidth estimate for the node (bits per second)"
name: "debug-bandwidth-estimate" .}: Option[Natural]

Expand Down
4 changes: 2 additions & 2 deletions beacon_chain/conf_light_client.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,13 +141,13 @@ type LightClientConf* = object
name: "jwt-secret" .}: Option[InputFile]

bandwidthEstimate* {.
hidden
debug
desc: "Bandwidth estimate for the node (bits per second)"
name: "debug-bandwidth-estimate" .}: Option[Natural]

# Testing
stopAtEpoch* {.
hidden
debug
desc: "The wall-time epoch at which to exit the program. (for testing purposes)"
defaultValue: 0
name: "debug-stop-at-epoch" .}: uint64
Expand Down
2 changes: 2 additions & 0 deletions docs/the_nimbus_book/src/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ nimbus_beacon_node [OPTIONS]... command

The following options are available:

--help Show this help message and exit. Available arguments: debug.
--version Show program's version and exit.
--config-file Loads the configuration from a TOML file.
--log-level Sets the log level for process and topics (e.g. "DEBUG; TRACE:discv5,libp2p;
REQUIRED:none; DISABLED:none") [=INFO].
Expand Down
2 changes: 1 addition & 1 deletion vendor/nim-confutils
Open in desktop
Submodule nim-confutils updated 29 files
+1 −0 .gitignore
+225 −260 README.md
+130 −59 confutils.nim
+1 −0 confutils/defs.nim
+5 −1 tests/help/snapshots/test_argument.txt
+1 −0 tests/help/snapshots/test_argument_abbr.txt
+17 −0 tests/help/snapshots/test_builtins.txt
+10 −0 tests/help/snapshots/test_builtins_lvl1Cmd1.txt
+1 −0 tests/help/snapshots/test_case_opt.txt
+1 −0 tests/help/snapshots/test_case_opt_cmdBlockProcessing.txt
+16 −0 tests/help/snapshots/test_debug.txt
+18 −0 tests/help/snapshots/test_debug_debug.txt
+11 −0 tests/help/snapshots/test_debug_lvl1Cmd1_debug.txt
+1 −0 tests/help/snapshots/test_default_value_desc.txt
+11 −0 tests/help/snapshots/test_dispatch.txt
+1 −0 tests/help/snapshots/test_longdesc.txt
+1 −0 tests/help/snapshots/test_longdesc_lvl1Cmd1.txt
+1 −0 tests/help/snapshots/test_nested_cmd.txt
+1 −0 tests/help/snapshots/test_nested_cmd_lvl1Cmd1.txt
+1 −0 tests/help/snapshots/test_nested_cmd_lvl1Cmd1_lvl2Cmd2.txt
+1 −0 tests/help/snapshots/test_separator.txt
+30 −0 tests/help/test_builtins.nim
+49 −0 tests/help/test_debug.nim
+16 −0 tests/help/test_dispatch.nim
+5 −2 tests/test_all.nim
+134 −0 tests/test_dispatch.nim
+43 −3 tests/test_duplicates.nim
+24 −3 tests/test_help.nim
+33 −8 tests/test_parsecmdarg.nim
Loading