8000 docs: adds correct updated documentation links by Zeegaths · Pull Request #32699 · bitcoin/bitcoin · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: adds correct updated documentation links #32699

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Zeegaths
Copy link
@Zeegaths Zeegaths commented Jun 7, 2025

Added correct links to the docs in place of the missing docs' paths.
Fixes #32565

@DrahtBot
Copy link
Contributor
DrahtBot commented Jun 7, 2025

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage & Benchmarks

For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/32699.

Reviews

See the guideline for information on the review process.
A summary of reviews will appear here.

Conflicts

Reviewers, this pull request conflicts with the following ones:

  • #32541 (index: store per-block transaction locations for efficient lookups by romanz)
  • #31974 (Drop testnet3 by Sjors)
  • #31860 (init: Take lock on blocks directory in BlockManager ctor by TheCharlatan)
  • #31845 (Add -pruneduringinit option to temporarily use another prune target during IBD by luke-jr)
  • #29678 (Bugfix: Correct first-run free space checks by luke-jr)
  • #29278 (Wallet: Add maxfeerate wallet startup option by ismaelsadeeq)
  • #28792 (Embed default ASMap as binary dump header file by fjahr)
  • #26966 (index: initial sync speedup, parallelize process by furszy)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

LLM Linter (✨ experimental)

Possible typos and grammar issues:

  • In the -peerbloomfilters help text: “Support filtering of blocks and transaction with bloom filters” → “transactions” [plural “transactions” is needed]
    No other typos impacting comprehension were found.

drahtbot_id_4_m

Copy link
@mabu44 mabu44 left a comment

Choose a reason for hiding this comment

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

This makes it necessary to manually update the links with every release, or at least with every new version that contains changes to those documentation files.

@Zeegaths
Copy link
Author
Zeegaths commented Jun 9, 2025

This makes it necessary to manually update the links with every release, or at least with every new version that contains changes to those documentation files.

it does, still trying to get a workaround that automatically updates it

@Zeegaths
Copy link
Author

This makes it necessary to manually update the links with every release, or at least with every new version that contains changes to those documentation files.

i have update it so it fetches the docs based on build version

@@ -66,7 +67,7 @@ void WalletInit::AddWalletOptions(ArgsManager& argsman) const
argsman.AddArg("-paytxfee=<amt>", strprintf("(DEPRECATED) Fee rate (in %s/kvB) to add to transactions you send (default: %s)",
CURRENCY_UNIT, FormatMoney(CFeeRate{DEFAULT_PAY_TX_FEE}.GetFeePerK())), ArgsManager::ALLOW_ANY, OptionsCategory::WALLET);
#ifdef ENABLE_EXTERNAL_SIGNER
argsman.AddArg("-signer=<cmd>", "External signing tool, see doc/external-signer.md", ArgsManager::ALLOW_ANY, OptionsCategory::WALLET);
argsman.AddArg("-signer=<cmd>", strprintf("External signing tool, see https://github.com/bitcoin/bitcoin/blob/v%d.%d/doc/external-signer.md", CLIENT_VERSION_MAJOR, CLIENT_VERSION_MINOR), ArgsManager::ALLOW_ANY, OptionsCategory::WALLET);
Copy link
Contributor

Choose a reason for hiding this comment

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

Running on master branch, I get:

 -signer=<cmd>
       External signing tool, see
       https://github.com/bitcoin/bitcoin/blob/v29.99/doc/external-signer.md

...which is incorrect since there is no v29.99.

Copy link
Author

Choose a reason for hiding this comment

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

this could be because you are on developement version. Let me try set it to the latest stable version

@brunoerg
Copy link
Contributor

You can squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits.

@Zeegaths
Copy link
Author

You can squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits.

thankyou for this

Copy link
@musaHaruna musaHaruna left a comment

Choose a reason for hiding this comment

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

I checked out v29.0 with the changes, I got:
-cjdnsreachable If set, then this host is configured for CJDNS (connecting to fc00::/8 addresses would lead us to the CJDNS network, see https://github.com/bitcoin/bitcoin/blob/v29.0/doc/cjdns.md) (default: 0)
which links correctly, the function GetDocumentationUrl looks good to me

@Zeegaths
Copy link
Author
Zeegaths commented Jun 16, 2025 via email

@@ -157,7 +157,7 @@ static constexpr bool DEFAULT_STOPAFTERBLOCKIMPORT{false};
#endif

static constexpr int MIN_CORE_FDS = MIN_LEVELDB_FDS + NUM_FDS_MESSAGE_CAPTURE;
static const char* DEFAULT_ASMAP_FILENAME="ip_asn.map";
static const char* DEFAULT_ASMAP_FILENAME = "ip_asn.map";
Copy link

Choose a reason for hiding this comment

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

Thanks for the PR! I notice there are some whitespace changes that appear unrelated to the main goal of fixing documentation references.
While these changes don't affect functionality, it would be helpful to keep the diff focused on the actual documentation URL changes. This makes the PR easier to review and reduces the risk of merge conflicts.

Could you please remove these unrelated whitespace changes? This will make the PR's intent clearer and follow the principle of keeping changes minimal and focused.

The core changes to fix the documentation references look good.

@Zeegaths
Copy link
Author
Zeegaths commented Jun 16, 2025 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: references to unshipped documentation
6 participants
0