Skip to content

fix: stabilize par help text in manpages#7394

Merged
PastaPastaPasta merged 1 commit into
dashpay:developfrom
thepastaclaw:fix/manpage-stable-par
Jun 30, 2026
Merged

fix: stabilize par help text in manpages#7394
PastaPastaPasta merged 1 commit into
dashpay:developfrom
thepastaclaw:fix/manpage-stable-par

Conversation

@thepastaclaw

Copy link
Copy Markdown

fix: stabilize par help text in manpages

Issue being fixed or feature implemented

Regenerating manpages currently records the local machine's CPU count in the
-par and -parbls help text. That makes otherwise unrelated release
manpage regeneration change those entries depending on which machine generated
the pages.

What was done?

Updated the -par and -parbls help text to avoid printing the dynamic lower
bound derived from GetNumCores().

Runtime behavior is unchanged: negative values still mean "leave that many
cores free", 0 still auto-detects, and the existing max/default values remain
documented. The checked-in dashd and dash-qt manpages were updated to match
the new stable generated text.

How Has This Been Tested?

Tested on macOS arm64:

git diff --check
python3 -m py_compile contrib/devtools/gen-manpages.py
rg -n -e '\\fB\\-[0-9]+\\fR to' doc/man/dashd.1 doc/man/dash-qt.1

The grep command returned no matches, confirming the affected generated
manpages no longer contain a CPU-count-specific lower bound.

Also ran a pre-PR code review gate against the exact worktree diff:

Recommendation: ship

Note: this worktree did not have configured Dash Core build artifacts and
help2man is not installed locally, so I did not rerun full manpage generation
from rebuilt binaries here. The manpage edits mirror the changed src/init.cpp
help text.

Breaking Changes

None.

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have made corresponding changes to the documentation
  • I have assigned this pull request to a milestone (for repository
    code-owners and collaborators only)

@thepastaclaw

Copy link
Copy Markdown
Author

@coderabbitai review

@thepastaclaw

thepastaclaw commented Jun 30, 2026

Copy link
Copy Markdown
Author

✅ Review complete (commit 4e5cc4b)

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@github-actions

Copy link
Copy Markdown

✅ No Merge Conflicts Detected

This PR currently has no conflicts with other open PRs.

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 947d3633-bb33-45da-aee8-48acc9d9eeb6

📥 Commits

Reviewing files that changed from the base of the PR and between cdcf00a and 4e5cc4b.

📒 Files selected for processing (3)
  • doc/man/dash-qt.1
  • doc/man/dashd.1
  • src/init.cpp

Walkthrough

The help text for -par and -parbls options is updated in src/init.cpp and both man pages (dash-qt.1, dashd.1). The prior wording described a numeric range (e.g., -12 to 15); the new wording uses a standardized format: 0 = auto, negative values reserve that many cores, with explicit maximum caps (15 for -par, 33 for -parbls) and default of 0.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: stabilizing par help text in manpages.
Description check ✅ Passed The description accurately matches the changes to stabilize -par and -parbls help text and update the manpages.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@PastaPastaPasta PastaPastaPasta left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

utACK 4e5cc4b

@thepastaclaw thepastaclaw left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Code Review

Verified PR #7394 at exact head SHA 4e5cc4b. The diff is limited to stabilizing the -par and -parbls help/manpage text, the generated manpage entries match src/init.cpp, and the runtime parsing still supports auto, negative values, and max clamping as documented.

Note: posted as a COMMENT review because GitHub does not allow approving my own PR.

@thepastaclaw thepastaclaw marked this pull request as ready for review June 30, 2026 14:32
@PastaPastaPasta PastaPastaPasta requested review from UdjinM6 and knst June 30, 2026 14:47

@UdjinM6 UdjinM6 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

utACK 4e5cc4b

@PastaPastaPasta PastaPastaPasta merged commit dfe1e5d into dashpay:develop Jun 30, 2026
47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants