-
Notifications
You must be signed in to change notification settings - Fork 1.2k
docs: update man pages for 23.0 #6928
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
base: develop
Are you sure you want to change the base?
Conversation
✅ No Merge Conflicts DetectedThis PR currently has no conflicts with other open PRs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Greptile Overview
Greptile Summary
This PR updates all man pages (dashd, dash-cli, dash-qt, dash-tx, dash-wallet) from v22.1.0 to v23.0.0 as part of the release process tracked in issue #6884. The changes are auto-generated by help2man from the compiled v23.0 binaries and include version number updates (date changed from February 2025 to October 2025), new feature documentation (-parbls for BLS threading, -consolidatefeerate for UTXO optimization), updated consensus checkpoints (-assumevalid hashes for mainnet/testnet), clarified masternode-specific behavior (automatic block filter enablement), default value changes (UPnP disabled, DNS seed/listen behavior with maxconnections=0), Unix domain socket support for proxy options, removal of deprecated -statsport, and section reorganization (moving -permitbaremultisig to node relay options). These man pages provide Unix/Linux system documentation for command-line options and are regenerated using contrib/devtools/gen-manpages.py during every release to ensure documentation matches actual binary behavior.
Important Files Changed
| Filename | Score | Overview |
|---|---|---|
| doc/man/dashd.1 | 5/5 | Updated dashd man page with v23.0 features: new BLS threading, updated assumevalid hashes, masternode block filter auto-enablement, UTXO consolidation feerate, proxy unix socket support, and deprecated option removal |
| doc/man/dash-qt.1 | 5/5 | Updated GUI wallet man page with v23.0 features including URI parameter in synopsis, new consolidatefeerate/parbls options, updated consensus checkpoints, and clarified default behaviors |
| doc/man/dash-cli.1 | 5/5 | Updated CLI tool man page to v23.0.0 with improved help text clarity for -generate and -getinfo flags |
| doc/man/dash-tx.1 | 5/5 | Updated transaction utility man page version from 22.1.0 to 23.0.0-rc.3 with date change |
| doc/man/dash-wallet.1 | 5/5 | Updated wallet tool man page version from 22.1.0 to 23.0.0 with copyright year extension to 2025 |
Confidence score: 5/5
- This PR is safe to merge with minimal risk as it only updates auto-generated documentation files with no code changes.
- Score reflects that these are standard release documentation updates generated mechanically from help2man, containing only version metadata and help text extracted directly from compiled binaries, with no possibility of introducing runtime bugs or breaking changes.
- No files require special attention; all changes are documentation-only updates consistent with the v23.0 release process checklist.
Context used:
- Context from
dashboard- CLAUDE.md (source)
5 files reviewed, no comments
WalkthroughMan pages updated for dash-cli, dash-qt, dash-tx, dash-wallet, and dashd to v23.0.0 (October 2025). Changes include date/version metadata bumps and minor trailing-newline/licensing formatting fixes. dash-cli adds named-argument synopsis variants and refines wording for -generate and -getinfo. dash-qt and dashd expand and reword many option descriptions (widened -par range, new -parbls, -consolidatefeerate, proxy/onion path and Sequence Diagram(s)(omitted — changes are documentation-only and do not introduce new runtime control-flow that requires a sequence diagram) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🧹 Nitpick comments (2)
doc/man/dashd.1 (1)
513-518: Unit consistency for -consolidatefeerate (kvB vs kB).This option uses DASH/kvB while other fee options use DASH/kB. If kvB (vbytes) is intentional here, consider adding a short parenthetical to avoid confusion; otherwise align units.
As per coding guidelines
doc/man/dash-qt.1 (1)
515-520: Unit consistency for -consolidatefeerate (kvB vs kB).Same note as dashd: consider clarifying kvB vs kB or aligning units.
As per coding guidelines
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
doc/man/dash-cli.1(5 hunks)doc/man/dash-qt.1(13 hunks)doc/man/dash-tx.1(1 hunks)doc/man/dash-wallet.1(2 hunks)doc/man/dashd.1(13 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
doc/**
📄 CodeRabbit inference engine (CLAUDE.md)
Unless specifically prompted, avoid making changes to the doc directory (documentation)
Files:
doc/man/dash-cli.1doc/man/dash-wallet.1doc/man/dash-qt.1doc/man/dash-tx.1doc/man/dashd.1
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Build container / Build container
🔇 Additional comments (11)
doc/man/dash-wallet.1 (1)
2-2: LGTM on version/date bump.No other semantic changes detected.
Also applies to: 4-4, 6-6
doc/man/dash-qt.1 (3)
7-11: SYNOPSIS and BIP21 note look good.Clearer UX with optional [URI] and explicit BIP21 mention.
28-31: Assumevalid hashes verified—no drift detected.Confirmed that both doc/man/dashd.1 and doc/man/dash-qt.1 contain identical v23 mainnet and testnet hashes:
- Mainnet:
000000000000000630fdfb37764bc6df460d301effa5e0fd4e8ef9ba821f36da- Testnet:
000001d20827f1394354452ba2e836de387e4fbf2d1d35b3281adbb14adf89a1No changes needed.
314-319: Documentation is accurate; unix: path support is implemented.The Qt binary does support 'unix:' prefixed paths for both -proxy and -onion settings. The implementation is present in the core code: the
Proxyclass has dedicated members for unix socket paths (m_unix_socket_path,m_is_unix_socket), and the parsing logic validates paths with the "unix:" prefix insrc/netbase.cpp. The documentation indoc/man/dash-qt.1correctly reflects this functionality.doc/man/dashd.1 (6)
1024-1027: Compiled default for -permitbaremultisig matches documented value.The source code defines
DEFAULT_PERMIT_BAREMULTISIGastrueinsrc/policy/policy.h:41, which evaluates to 1 in numeric context. This matches the documented default of 1 in the man page. The relay policy documentation is accurate.
26-29: Assumevalid mainnet/testnet hashes verified as accurate.The hashes in doc/man/dashd.1 match the source code in src/chainparams.cpp:
- Mainnet:
000000000000000630fdfb37764bc6df460d301effa5e0fd4e8ef9ba821f36da✓- Testnet:
000001d20827f1394354452ba2e836de387e4fbf2d1d35b3281adbb14adf89a1✓No mismatches found.
126-133: Documentation ranges verified as accurate.The documented ranges in doc/man/dashd.1 are correct:
-parrange "-24 to 15" matchesMAX_SCRIPTCHECK_THREADS = 15in src/validation.h-parblsrange "-24 to 33" matchesMAX_BLSCHECK_THREADS = 33in src/llmq/options.hBoth use the same minimum (-GetNumCores(), which equals -24 on a 24-core system) as shown in src/init.cpp. No adjustments needed.
237-239: Documentation condition imprecise: code checks-maxconnections <= 0, not just= 0The implementation at src/init.cpp:919 checks
args.GetIntArg("-maxconnections", ...) <= 0, which is more general than the documented condition stating= 0. While practically equivalent (the check occurs before normalization at line 1207, and users rarely set negative values), the documentation could be more precise. The corresponding help text in src/init.cpp:576 similarly states "default: %u unless -connect used or -maxconnections=0" rather than<= 0.
2-2: Verification confirms dashd.1 is correctly formatted; however, cross-check reveals dash-tx.1 still contains v23.0.0-rc.3 tag.All .TH dates are set to October 2025 ✓. MIT license footers present in all 5 manpages ✓. However, dash-tx.1 contains lingering rc references (v23.0.0-rc.3 in .TH, NAME, and description lines), while dashd.1 and other manpages are at clean v23.0.0. Verify whether dash-tx.1 rc.3 tag is intentional or requires correction to match the v23.0.0 release version.
312-317: No issues found - documentation accurately reflects implementation.Both
-proxyand-onionoptions parse argument strings through identical code paths (src/init.cpp:1820-1828 and 1849-1868), using the sameIsUnixSocketPath()detection andProxyconstructors. The manpage correctly documents<ip:port|path>syntax for both, with unix socket support conditionally gated byHAVE_SOCKADDR_UN. Runtime parity is confirmed.doc/man/dash-cli.1 (1)
10-16: SYNOPSIS and DESCRIPTION sections verified—all additions and tweaks confirmed correct.The -named command variant, help command variants, and -generate/-getinfo descriptions are all present and properly formatted. Manpage structure is intact with no formatting issues.
| Set the number of script verification threads (\fB\-24\fR to 15, 0 = auto, <0 = | ||
| leave that many cores free, default: 0) | ||
| .HP | ||
| \fB\-parbls=\fR<n> | ||
| .IP | ||
| Set the number of BLS verification threads (\fB\-24\fR to 33, 0 = auto, <0 = | ||
| leave that many cores free, default: 0) | ||
| .HP |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
Check -par and -parbls ranges (GUI doc).
Same concern as dashd: confirm documented ranges align with v23 defaults.
🏁 Script executed:
#!/bin/bash
rg -n '^-par=|^-parbls=' doc/man/dash-qt.1Length of output: 0
I need to view the actual file content to see the exact ranges documented. Let me search more broadly in the file:
Also, let me search for any references to these parameters more broadly:
🏁 Script executed:
#!/bin/bash
# View the specific lines in the man page file
sed -n '128,135p' doc/man/dash-qt.1Length of output: 267
🏁 Script executed:
#!/bin/bash
# Search for parbls and par with broader context
rg -n 'parbls|par=' doc/man/dash-qt.1 -C2Length of output: 292
Let me search the codebase to find the actual parameter definitions and their valid ranges:
Also, let me check the dashd man page for comparison:
🏁 Script executed:
#!/bin/bash
# Search for -par parameter definition in source code
rg -n '\-par|par\s*=' src/ --type=cpp --type=h -C3 | grep -i 'arg\|param\|range\|min\|max' -C2Length of output: 7456
🏁 Script executed:
#!/bin/bash
# Check if dashd man page has similar parameters with ranges
if [ -f doc/man/dashd.1 ]; then
rg -n 'parbls|par=' doc/man/dashd.1 -C3
fiLength of output: 412
Update documented ranges to reflect dynamic core-based minimums.
The documented ranges in dash-qt.1 lines 128 and 133 hardcode -24 as the minimum, but the actual implementation in src/init.cpp uses -GetNumCores(), which varies per system. The maximums are correct (15 for -par, 33 for -parbls), but the minimums should be updated to accurately reflect that the lower bound is dynamic based on the number of CPU cores, not a fixed -24.
🤖 Prompt for AI Agents
In doc/man/dash-qt.1 around lines 128–135, the minimum values for the -par and
-parbls options are hardcoded as "-24" but the implementation uses a dynamic
minimum of -GetNumCores(); update both occurrences to describe the dynamic
core-based minimum (e.g., "-(number of CPU cores)" or "-(number of cores on the
system)") instead of "-24", keep the rest of the sentence (0 = auto, <0 = leave
that many cores free, default: 0) and preserve the existing max values (15 for
-par, 33 for -parbls) and man formatting.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
utACK 5583a3f
doc/man/dash-qt.1
Outdated
| 000000000000000630fdfb37764bc6df460d301effa5e0fd4e8ef9ba821f36da, | ||
| testnet: | ||
| 000000eef20eb0062abd4e799967e98bdebb165dd1c567ab4118c1c86c6e948f) | ||
| 000001d20827f1394354452ba2e836de387e4fbf2d1d35b3281adbb14adf89a1) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should update these values for 23.0 (can be done in a separate PR but docs should be updated too after that)
I will rebase or create follow-up PR after #6920 is merged |
5583a3f to
28a0689
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
♻️ Duplicate comments (2)
doc/man/dash-qt.1 (1)
128-134: Hardcoded minimum values don't reflect dynamic implementation.The documented minimum of
-24for both-parand-parblsdoesn't match the implementation, which uses-GetNumCores()(dynamic based on system CPU cores). This was previously flagged and remains unresolved.Apply this diff to document the dynamic minimum:
-Set the number of script verification threads (\fB\-24\fR to 15, 0 = auto, <0 = +Set the number of script verification threads (-(number of cores) to 15, 0 = auto, <0 = leave that many cores free, default: 0) .HP \fB\-parbls=\fR<n> .IP -Set the number of BLS verification threads (\fB\-24\fR to 33, 0 = auto, <0 = +Set the number of BLS verification threads (-(number of cores) to 33, 0 = auto, <0 = leave that many cores free, default: 0)doc/man/dashd.1 (1)
126-132: Same hardcoded minimum issue as dash-qt.1.The
-parand-parblsminimum values are documented as-24but should reflect the dynamic-GetNumCores()implementation. This is identical to the issue in dash-qt.1.Apply the same fix as dash-qt.1:
-Set the number of script verification threads (\fB\-24\fR to 15, 0 = auto, <0 = +Set the number of script verification threads (-(number of cores) to 15, 0 = auto, <0 = leave that many cores free, default: 0) .HP \fB\-parbls=\fR<n> .IP -Set the number of BLS verification threads (\fB\-24\fR to 33, 0 = auto, <0 = +Set the number of BLS verification threads (-(number of cores) to 33, 0 = auto, <0 = leave that many cores free, default: 0)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
doc/man/dash-cli.1(5 hunks)doc/man/dash-qt.1(13 hunks)doc/man/dash-tx.1(2 hunks)doc/man/dash-wallet.1(2 hunks)doc/man/dashd.1(13 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- doc/man/dash-wallet.1
- doc/man/dash-tx.1
- doc/man/dash-cli.1
🧰 Additional context used
📓 Path-based instructions (1)
doc/**
📄 CodeRabbit inference engine (CLAUDE.md)
Unless specifically prompted, avoid making changes to the doc directory (documentation)
Files:
doc/man/dashd.1doc/man/dash-qt.1
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Build container / Build container
🔇 Additional comments (9)
doc/man/dash-qt.1 (5)
2-11: Version metadata and description updates look correct.The version references are consistently updated to v23.0.0 (October 2025), and the added URI description provides helpful context for users.
240-240: Connection option documentation improvements look good.The updates clarify:
- DNS seed and listen behavior with
-maxconnections=0- Unix socket support for proxy/onion connections
- Masternode auto-enablement for peer block filters
- UPnP default change to 0
These documentation changes accurately reflect the v23.0 functionality.
Also applies to: 268-269, 314-318, 329-330, 349-353, 389-389
36-37: Masternode auto-enable documentation is helpful.Documenting that block filter index is automatically enabled for masternodes clarifies the default behavior in that context.
515-519: New consolidatefeerate option is well documented.The description clearly explains the purpose (UTXO pool reduction) and provides the default value. Good addition to wallet options.
1026-1028: RPC and relay option updates look good.The expanded
-rpcallowipdocumentation now includes examples for allowing all IPv4/IPv6 addresses, and the-permitbaremultisigoption is properly documented. License URL formatting is also updated.Also applies to: 1061-1065, 1191-1191
doc/man/dashd.1 (4)
2-9: Version metadata consistent with dash-qt.1.The version updates match across both man pages. The checkpoint hashes are identical to those in dash-qt.1 and should be verified as noted in the dash-qt.1 review.
Also applies to: 26-28
238-238: Connection options consistent with dash-qt.1.All connection option updates match the dash-qt.1 documentation, ensuring consistency across the man pages. The clarifications for DNS seed behavior, listen defaults, unix socket support, and masternode auto-enablement are well documented.
Also applies to: 266-267, 312-316, 327-328, 347-351, 387-387
513-517: Wallet and relay options consistent with dash-qt.1.The
-consolidatefeerateand-permitbaremultisigoptions are documented identically to dash-qt.1, maintaining consistency across the man pages.Also applies to: 1024-1026
1059-1063: RPC options and license formatting consistent.The
-rpcallowipexpanded documentation and MIT license URL update match dash-qt.1, maintaining consistency across all man pages.Also applies to: 1140-1140
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
doc/man/dash-qt.1(13 hunks)doc/man/dashd.1(13 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
doc/**
📄 CodeRabbit inference engine (CLAUDE.md)
Unless specifically prompted, avoid making changes to the doc directory (documentation)
Files:
doc/man/dashd.1doc/man/dash-qt.1
🧠 Learnings (11)
📓 Common learnings
Learnt from: knst
Repo: dashpay/dash PR: 6871
File: contrib/guix/libexec/build.sh:358-360
Timestamp: 2025-10-05T20:38:28.457Z
Learning: In the Dash repository, when backporting code from Bitcoin Core, typos and minor issues in comments should be kept as-is to reduce merge conflicts in future backports, even if they remain unfixed in Bitcoin Core's master branch.
📚 Learning: 2025-07-23T09:30:34.631Z
Learnt from: kwvg
Repo: dashpay/dash PR: 6761
File: src/chainlock/signing.h:5-6
Timestamp: 2025-07-23T09:30:34.631Z
Learning: Dash Core uses BITCOIN_ prefix for header guards as the standard convention, inherited from Bitcoin Core. Only a few BLS-specific files in src/bls/ use DASH_ prefix. The vast majority of files (385+) use BITCOIN_ prefix.
Applied to files:
doc/man/dashd.1doc/man/dash-qt.1
📚 Learning: 2025-10-05T20:38:28.457Z
Learnt from: knst
Repo: dashpay/dash PR: 6871
File: contrib/guix/libexec/build.sh:358-360
Timestamp: 2025-10-05T20:38:28.457Z
Learning: In the Dash repository, when backporting code from Bitcoin Core, typos and minor issues in comments should be kept as-is to reduce merge conflicts in future backports, even if they remain unfixed in Bitcoin Core's master branch.
Applied to files:
doc/man/dashd.1doc/man/dash-qt.1
📚 Learning: 2025-08-11T17:16:36.654Z
Learnt from: PastaPastaPasta
Repo: dashpay/dash PR: 6804
File: src/qt/proposalwizard.cpp:40-42
Timestamp: 2025-08-11T17:16:36.654Z
Learning: In the Dash repository, when a PR adds new files that are not from Bitcoin backports, these files must be added to the list in test/util/data/non-backported.txt. This applies to newly created files like qt/proposalwizard.{h,cpp} and forms/proposalwizard.ui. Limited exemptions may exist for subtrees and similar cases.
Applied to files:
doc/man/dash-qt.1
📚 Learning: 2025-08-19T14:57:31.801Z
Learnt from: knst
Repo: dashpay/dash PR: 6692
File: src/llmq/blockprocessor.cpp:217-224
Timestamp: 2025-08-19T14:57:31.801Z
Learning: In PR #6692, knst acknowledged a null pointer dereference issue in ProcessBlock() method where LookupBlockIndex may return nullptr but is passed to gsl::not_null, and created follow-up PR #6789 to address it, consistent with avoiding scope creep in performance-focused PRs.
Applied to files:
doc/man/dash-qt.1
📚 Learning: 2025-07-29T14:32:48.369Z
Learnt from: kwvg
Repo: dashpay/dash PR: 6761
File: src/chainlock/signing.cpp:247-250
Timestamp: 2025-07-29T14:32:48.369Z
Learning: In PR #6761, kwvg acknowledged a null pointer check issue in ChainLockSigner::Cleanup() method but deferred it to follow-up, consistent with the pattern of avoiding scope creep in refactoring PRs.
Applied to files:
doc/man/dash-qt.1
📚 Learning: 2025-08-08T04:30:37.971Z
Learnt from: PastaPastaPasta
Repo: dashpay/dash PR: 6804
File: src/qt/proposalwizard.cpp:0-0
Timestamp: 2025-08-08T04:30:37.971Z
Learning: In the Dash codebase, direct RPC calling has been removed in recent commits, making suggestions about RPC command validation and error handling for direct RPC calls obsolete. The ProposalWizard and related components no longer use direct RPC calling patterns.
Applied to files:
doc/man/dash-qt.1
📚 Learning: 2025-10-25T07:08:51.918Z
Learnt from: knst
Repo: dashpay/dash PR: 6916
File: src/univalue/include/univalue.h:81-88
Timestamp: 2025-10-25T07:08:51.918Z
Learning: For backport PRs from bitcoin/bitcoin, bitcoin-core/gui, etc., backported changes should match the original upstream PRs even if they appear strange, modify vendored code, or seem to violate coding guidelines. Still flag genuine issues like bugs, undefined behavior, crashes, compilation errors, or linter failures.
Applied to files:
doc/man/dash-qt.1
📚 Learning: 2025-02-06T14:34:30.466Z
Learnt from: kwvg
Repo: dashpay/dash PR: 6543
File: src/wallet/receive.cpp:240-251
Timestamp: 2025-02-06T14:34:30.466Z
Learning: Pull request #6543 is focused on move-only changes and refactoring, specifically backporting from Bitcoin. Behavior changes should be proposed in separate PRs.
Applied to files:
doc/man/dash-qt.1
📚 Learning: 2025-10-13T12:37:12.357Z
Learnt from: knst
Repo: dashpay/dash PR: 6883
File: src/rpc/rawtransaction.cpp:1088-1125
Timestamp: 2025-10-13T12:37:12.357Z
Learning: In backport pull requests (especially from Bitcoin Core), treat "moved" or refactored code as out-of-scope for content-level review. Focus validation on verifying that code is moved correctly: no fields added, no fields removed, no fields reordered, and no unexpected changes beyond whitespace adjustments. Pre-existing issues in the upstream code should be preserved to maintain fidelity to the original implementation.
Applied to files:
doc/man/dash-qt.1
📚 Learning: 2025-06-09T16:43:20.996Z
Learnt from: kwvg
Repo: dashpay/dash PR: 6718
File: test/functional/test_framework/test_framework.py:2102-2102
Timestamp: 2025-06-09T16:43:20.996Z
Learning: In the test framework consolidation PR (#6718), user kwvg prefers to limit functional changes to those directly related to MasternodeInfo, avoiding scope creep even for minor improvements like error handling consistency.
Applied to files:
doc/man/dash-qt.1
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Build container / Build container
🔇 Additional comments (13)
doc/man/dashd.1 (7)
2-2: Version metadata correctly updated to v23.0.0.The version and date references are consistently updated across the man page header, title, and description sections.
Also applies to: 4-4, 9-9
26-28: Checkpoint hashes correctly updated for v23.0.Both mainnet and testnet assumevalid checkpoint hashes have been updated to match the v23.0 release values.
34-35: Masternode auto-enable behavior clearly documented.The automatic enabling of block filter index and peer block filters for masternodes is properly documented with clear wording.
Also applies to: 327-328
238-238: Network option documentation enhanced for v23.0.The updates correctly document:
- Edge case handling for
-maxconnections=0with-dnsseedand-listen- Unix domain socket support (
unix:prefix) for-onionand-proxy- Changed default for
-upnpfrom 1 to 0These align with the v23.0 feature set.
Also applies to: 266-267, 312-316, 347-351, 387-387
513-517: New wallet and relay options properly documented.The
-consolidatefeeratewallet option and-permitbaremultisigrelay option are clearly documented with appropriate descriptions and defaults.Also applies to: 1024-1026
1059-1063: RPC allow-IP documentation enhanced with explicit format examples.The expanded description clearly enumerates all valid input formats with concrete examples, improving usability.
1140-1140: MIT license URL properly formatted.The license reference uses the canonical OSI URL format.
doc/man/dash-qt.1 (6)
2-2: Version metadata and URI support properly documented.The version is consistently updated to v23.0.0, and the optional URI parameter is clearly documented with proper BIP21 format reference.
Also applies to: 4-4, 7-7, 9-11
28-30: Checkpoint hashes correctly synchronized with dashd.1.Both mainnet and testnet checkpoint values match the v23.0 release configuration.
36-37: Network and masternode option updates consistent with dashd.1.The documentation changes parallel those in dashd.1, maintaining consistency across man pages for:
- Masternode auto-enable behavior for block filters
- Edge case handling for
-maxconnections=0- Unix socket support for proxy options
- Changed
-upnpdefaultAlso applies to: 240-240, 268-269, 314-318, 329-330, 349-353, 389-389
515-519: Wallet and relay options properly documented.The
-consolidatefeerateand-permitbaremultisigoptions are correctly documented, consistent with dashd.1.Also applies to: 1026-1028
1061-1065: RPC allow-IP documentation enhanced with explicit format examples.Consistent with dashd.1, the expanded description provides clear examples of all valid input formats.
1191-1191: MIT license URL properly formatted.Consistent with dashd.1, using the canonical OSI license URL.
| Set the number of script verification threads (\fB\-24\fR to 15, 0 = auto, <0 = | ||
| leave that many cores free, default: 0) | ||
| .HP | ||
| \fB\-parbls=\fR<n> | ||
| .IP | ||
| Set the number of BLS verification threads (\fB\-24\fR to 33, 0 = auto, <0 = | ||
| leave that many cores free, default: 0) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hardcoded minimum value doesn't reflect dynamic implementation.
Same issue as in dashd.1: the documented ranges show -24 as the minimum for both -par and -parbls, but the implementation uses -GetNumCores() which varies per system.
Consider updating the documentation to indicate the minimum is dynamic (e.g., "-(number of CPU cores)") rather than the fixed "-24" value.
Based on past review comments.
🤖 Prompt for AI Agents
In doc/man/dash-qt.1 around lines 128 to 134, the manpage shows a hardcoded
minimum value "-24" for the -par and -parbls options but the implementation uses
-GetNumCores() (dynamic per system); update the text to reflect a dynamic
minimum (for example, replace "-24" with "-(number of CPU cores)" or a phrasing
like "-(number of CPU cores)" and mention 0 = auto and <0 leaves that many cores
free) so the documented range matches the actual behavior.
| Set the number of script verification threads (\fB\-24\fR to 15, 0 = auto, <0 = | ||
| leave that many cores free, default: 0) | ||
| .HP | ||
| \fB\-parbls=\fR<n> | ||
| .IP | ||
| Set the number of BLS verification threads (\fB\-24\fR to 33, 0 = auto, <0 = | ||
| leave that many cores free, default: 0) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hardcoded minimum value doesn't reflect dynamic implementation.
The documented ranges show -24 as the minimum for both -par and -parbls, but the implementation uses -GetNumCores() which varies per system. Users on systems with more than 24 cores could specify values below -24 (e.g., -32 on a 32-core system).
Consider updating the documentation to indicate the minimum is dynamic (e.g., "-(number of CPU cores)" or "-(system core count)") rather than the fixed "-24" value.
Based on past review comments.
🤖 Prompt for AI Agents
In doc/man/dashd.1 around lines 126 to 132, the manpage currently shows a
hardcoded minimum of "-24" for the -par and -parbls options but the code uses
-GetNumCores() so the minimum is dynamic; update the wording to indicate the
minimum is negative the system core count (e.g., "-(number of CPU cores)" or
"-(system core count)") or replace "-24" with a parenthetical note like
"-(number of CPU cores, e.g. -GetNumCores())" so the documented range reflects
the runtime-dependent minimum.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
utACK 25ecd50
Issue being fixed or feature implemented
#6884
What was done?
updated man pages for v23 release
How Has This Been Tested?
N/A
Breaking Changes
N/A
Checklist: