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.

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

Jump to bottom

docs: update man pages for 22.1 #6554

Merged
merged 1 commit into from
Feb 4, 2025
Merged

docs: update man pages for 22.1 #6554

merged 1 commit into from
Feb 4, 2025

Conversation

knst
Copy link
Collaborator

@knst knst commented Feb 4, 2025 •
edited
Loading

Issue being fixed or feature implemented

#6551

What was done?

Updated man pages by new script contrib/devtools/gen-manpages.py see #6555

How Has This Been Tested?

N/A

Breaking Changes

N/A

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)

@knst knst added this to the 22.1 milestone Feb 4, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Feb 4, 2025

Walkthrough

The pull request updates the manual pages for the Dash utilities, including dash-cli, dash-qt, dash-tx, dash-wallet, and dashd. All pages now reflect the version change from v22.0.0 to v22.1.0 and the date change from December 2024 to February 2025. The description sections in each manual have been modified to indicate the updated version. In addition, copyright sections have been added or revised across the documentation to include the appropriate years for both Dash Core and Bitcoin Core developers along with details regarding the experimental nature and MIT licensing of the software. Some debugging and testing options have been removed from certain pages, and default values for specific options (e.g., -v2transport in dash-qt) have been updated. The dashd manual now also features a reorganized copyright section consolidating the related information.

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a3d6db6 and ff785ed.

📒 Files selected for processing (5)
  • doc/man/dash-cli.1 (4 hunks)
  • doc/man/dash-qt.1 (5 hunks)
  • doc/man/dash-tx.1 (2 hunks)
  • doc/man/dash-wallet.1 (2 hunks)
  • doc/man/dashd.1 (5 hunks)
✅ Files skipped from review due to trivial changes (2)
  • doc/man/dash-tx.1
  • doc/man/dashd.1
⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: Build (linux64_ubsan, x86_64-pc-linux-gnu, linux64)
  • GitHub Check: Build (linux64_tsan, x86_64-pc-linux-gnu, linux64)
  • GitHub Check: Build (linux64_sqlite, x86_64-pc-linux-gnu, linux64)
  • GitHub Check: Build (linux64_nowallet, x86_64-pc-linux-gnu, linux64)
  • GitHub Check: Build (linux64_fuzz, x86_64-pc-linux-gnu, linux64)
  • GitHub Check: Build (linux64_cxx20, x86_64-pc-linux-gnu, linux64)
  • GitHub Check: Build (linux64, x86_64-pc-linux-gnu, linux64)
  • GitHub Check: Build (arm-linux, arm-linux-gnueabihf, arm-linux)
🔇 Additional comments (10)
doc/man/dash-cli.1 (3)

2-2: LGTM! Version and date updates are consistent.

The version has been correctly updated to v22.1.0 across all occurrences, and the date has been set to February 2025.

Also applies to: 4-4, 18-18

27-29: LGTM! Enhanced clarity in -addrinfo description.

The expanded description provides valuable clarity about the address filtering behavior and helps prevent misinterpretation of results.

155-165: LGTM! Complete and well-structured COPYRIGHT section.

The new COPYRIGHT section includes all essential elements:

  • Copyright notices with appropriate year ranges
  • Project information and links
  • License details
doc/man/dash-wallet.1 (3)

2-2: LGTM! Version and date updates are consistent.

The version has been correctly updated to v22.1.0 across all occurrences, and the date has been updated to February 2025.

Also applies to: 4-4, 6-6

102-112: LGTM! Copyright section is complete and well-structured.

The copyright section includes all necessary elements:

  • Copyright notices with correct year ranges
  • Contribution information and relevant links
  • Software license details

10-10: Verify argument order consistency across man pages.

The order of -regtest and -testnet arguments has been changed. Please ensure this order is consistent across all man pages.

✅ Verification successful

Man pages argument order is consistent.

The grep search indicates that the only instance where both -regtest and -testnet appear is in doc/man/dash-wallet.1, and they are ordered as -regtest followed by -testnet (i.e. \fB\-regtest\fR/\-testnet). There are no counter-examples in other man pages, ensuring consistency.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check the order of -regtest and -testnet arguments across all man pages.
# Expect: Consistent ordering across all man pages.

rg -A 2 -B 2 '\-regtest.*\-testnet|\-testnet.*\-regtest' doc/man/

Length of output: 494

doc/man/dash-qt.1 (4)

2-2: LGTM: Version and date updates are consistent.

The version number has been updated from v22.0.0 to v22.1.0 and the date has been updated to February 2025 consistently across all references.

Also applies to: 4-4, 9-9

859-868: LGTM: Debug output description is now more comprehensive.

The debug output description has been expanded to:

  • Clarify that it includes both debug and trace logging
  • List all available logging categories
  • Explain category specification behavior

Also applies to: 872-875

1167-1177: LGTM: Copyright section is complete and accurate.

The added copyright section includes:

  • Correct copyright years (2014-2025) for Dash Core developers
  • Correct copyright years (2009-2025) for Bitcoin Core developers
  • Project website and source code links
  • Experimental software notice
  • MIT license reference

386-386: Verify impact of v2transport default value change.

The default value for -v2transport has been changed from 0 to 1, enabling v2 transport by default. This change could affect network connectivity and compatibility.

Run the following script to check for any related configuration or compatibility notes:

✅ Verification successful

Action: Verify v2transport default change integration and compatibility impact

  • The source code (e.g. in src/init.cpp, src/net.cpp, and RPC files) now uses DEFAULT_V2_TRANSPORT set to 1 and updates argument definitions, which is reflected in the man pages (doc/man/dash-qt.1 and doc/man/dashd.1).
  • Numerous functional tests explicitly exercise both v2transport enabled and disabled cases, confirming appropriate fallback behavior.
  • The compatibility/migration search did not reveal any additional notes or warnings, indicating that the change has been accounted for within the existing implementation.

Based on these observations, the default change is fully integrated and tested with no further compatibility issues to address.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for v2transport references and compatibility notes

# Search for v2transport references in code and documentation
rg -A 5 "v2transport"

# Search for any compatibility notes or discussions
rg -i "transport.*(compatibility|migration|upgrade)"

Length of output: 49690

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@knst knst mentioned this pull request Feb 4, 2025
Merged
5 tasks
PastaPastaPasta
PastaPastaPasta approved these changes Feb 4, 2025
View reviewed changes
Copy link
Member

@PastaPastaPasta PastaPastaPasta left a comment

Choose a reason for hiding this comment

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

utACK ff785ed; diff looks good

UdjinM6
UdjinM6 approved these changes Feb 4, 2025
View reviewed changes
Copy link

@UdjinM6 UdjinM6 left a comment

Choose a reason for hiding this comment

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

utACK ff785ed

@PastaPastaPasta PastaPastaPasta merged commit 7a97528 into dashpay:develop Feb 4, 2025
21 of 22 checks passed
PastaPastaPasta added a commit that referenced this pull request Feb 4, 2025
@PastaPastaPasta
Merge #6555: backport: Merge bitcoin#24263: doc: Fix gen-manpages, re…
21fb709 
…write in Python

69b1328 Merge bitcoin#24263: doc: Fix gen-manpages, rewrite in Python (fanquake)

Pull request description:

  ## Issue being fixed or feature implemented
  gen-pages.sh doesn't work correctly for `dash-cli`, it removes all hyphens somehow:
  ```diff
   .IP
   Set a whitelist to filter incoming RPC calls for a specific user. The
   field <whitelist> comes in the format: <USERNAME>:<rpc 1>,<rpc
   2>,...,<rpc n>. If multiple whitelists are set for a given user,
  -they are set\-intersected. See \fB\-rpcwhitelistdefault\fR documentation
  +they are setintersected. See \fBrpcwhitelistdefault\fR documentation
   for information on default whitelist behavior.
   .HP
  ```

  ## What was done?
   - backport  bitcoin#24263

   Rewrite the manual page generation script in Python.

    This:
    - solves '-' stripping issue (fixes bitcoin#22681)
    - makes that a copyright footer is generated correctly again

    Also change the release process to swap gen-manpages and update RC steps, so that the pages will have the correct rc and/or final version.

  ## How Has This Been Tested?
  Produced correct documents for Dash Core v22.1: #6554

  ## Breaking Changes
  N/A

  ## Checklist:
  - [x] 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
  - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_

ACKs for top commit:
  PastaPastaPasta:
    utACK 69b1328; looks correct
  UdjinM6:
    utACK 69b1328
  kwvg:
    utACK 69b1328

Tree-SHA512: 01a7a9a8a4ba762e6ff36035a3fb554d998232d62da8c3441b12741e6a3b626c01c581c1ff3f6aa3dcac02e15d62eec7f2a7f94be9399895557cd0a7115424a7
PastaPastaPasta added a commit to PastaPastaPasta/dash that referenced this pull request Feb 4, 2025
@PastaPastaPasta
Merge dashpay#6554: docs: update man pages for 22.1
4571d89 
ff785ed docs: update man pages for 22.1 (Konstantin Akimov)

Pull request description:

  ## Issue being fixed or feature implemented
  dashpay#6551

  ## What was done?
  Updated man pages by new script `contrib/devtools/gen-manpages.py` see dashpay#6555

  ## How Has This Been Tested?
  N/A

  ## Breaking Changes
  N/A

  ## 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
  - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_

ACKs for top commit:
  PastaPastaPasta:
    utACK ff785ed; diff looks good
  UdjinM6:
    utACK ff785ed

Tree-SHA512: 60a81c880e6ff824fc661dc6c6da20d85aa662fe228f7080dcb8c47db69c88adc30a40ab84832d83994ab56a26ed1de4d800dd45cd282c61233fde2d4e2212b7
PastaPastaPasta added a commit to PastaPastaPasta/dash that referenced this pull request Feb 4, 2025
@PastaPastaPasta
Merge dashpay#6555: backport: Merge bitcoin#24263: doc: Fix gen-manpa…
e62b4eb 
…ges, rewrite in Python

69b1328 Merge bitcoin#24263: doc: Fix gen-manpages, rewrite in Python (fanquake)

Pull request description:

  ## Issue being fixed or feature implemented
  gen-pages.sh doesn't work correctly for `dash-cli`, it removes all hyphens somehow:
  ```diff
   .IP
   Set a whitelist to filter incoming RPC calls for a specific user. The
   field <whitelist> comes in the format: <USERNAME>:<rpc 1>,<rpc
   2>,...,<rpc n>. If multiple whitelists are set for a given user,
  -they are set\-intersected. See \fB\-rpcwhitelistdefault\fR documentation
  +they are setintersected. See \fBrpcwhitelistdefault\fR documentation
   for information on default whitelist behavior.
   .HP
  ```

  ## What was done?
   - backport  bitcoin#24263

   Rewrite the manual page generation script in Python.

    This:
    - solves '-' stripping issue (fixes bitcoin#22681)
    - makes that a copyright footer is generated correctly again

    Also change the release process to swap gen-manpages and update RC steps, so that the pages will have the correct rc and/or final version.

  ## How Has This Been Tested?
  Produced correct documents for Dash Core v22.1: dashpay#6554

  ## Breaking Changes
  N/A

  ## Checklist:
  - [x] 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
  - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_

ACKs for top commit:
  PastaPastaPasta:
    utACK 69b1328; looks correct
  UdjinM6:
    utACK 69b1328
  kwvg:
    utACK 69b1328

Tree-SHA512: 01a7a9a8a4ba762e6ff36035a3fb554d998232d62da8c3441b12741e6a3b626c01c581c1ff3f6aa3dcac02e15d62eec7f2a7f94be9399895557cd0a7115424a7
PastaPastaPasta added a commit that referenced this pull request Feb 4, 2025
@PastaPastaPasta
Merge #6556: [v22.1.x] backport: 22.1 final backports
b59422c 
e62b4eb Merge #6555: backport: Merge bitcoin#24263: doc: Fix gen-manpages, rewrite in Python (pasta)
53d0ff1 Merge #6552: docs: update supported versions in SECURITY.md (pasta)
4571d89 Merge #6554: docs: update man pages for 22.1 (pasta)
bc91a83 Merge #6553: chore: bump assume valid / checkpoints for v22.1 (pasta)

Pull request description:

  ## Issue being fixed or feature implemented
  Backports from develop to 22.1

  ## What was done?

  ## How Has This Been Tested?

  ## Breaking Changes

  ## Checklist:
    _Go over all the following points, and put an `x` in all the boxes that apply._
  - [ ] 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
  - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_

ACKs for top commit:
  UdjinM6:
    utACK e62b4eb

Tree-SHA512: 9f88c1a77ec1adc453b023b764f91760e13064c86d109c29bb7856f2588c6450e518c9479f8c3e245f7eeaf5ef6d28aa85f00b4b5e94ef5a4d80cb5b3d7fdff2
PastaPastaPasta added a commit that referenced this pull request Feb 11, 2025
@PastaPastaPasta
Merge #6571: chore: merge master back into develop
b115fc7 
774a018 chore: set release to true (pasta)
e62b4eb Merge #6555: backport: Merge bitcoin#24263: doc: Fix gen-manpages, rewrite in Python (pasta)
53d0ff1 Merge #6552: docs: update supported versions in SECURITY.md (pasta)
4571d89 Merge #6554: docs: update man pages for 22.1 (pasta)
bc91a83 Merge #6553: chore: bump assume valid / checkpoints for v22.1 (pasta)
c11ec40 docs: add release notes for 22.1.0 (pasta)

Pull request description:

  ## Issue being fixed or feature implemented
  Manually suppressed configure.ac changes

  ## What was done?

  ## How Has This Been Tested?

  ## Breaking Changes

  ## Checklist:
    _Go over all the following points, and put an `x` in all the boxes that apply._
  - [ ] 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
  - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_

ACKs for top commit:
  UdjinM6:
    utACK fd51512
  kwvg:
    utACK fd51512

Tree-SHA512: 41f08e1879596c0dd339209f869f2e4c7497f275df1928154ed8dfd2df1ff66c0618792afbff8313a818ac4d14ed8aa04f00e0fa96468adcc494042a7a28cc2b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@UdjinM6 UdjinM6 UdjinM6 approved these changes

@PastaPastaPasta PastaPastaPasta PastaPastaPasta approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
22.1
Development

Successfully merging this pull request may close these issues.
3 participants
@knst @UdjinM6 @PastaPastaPasta