Skip to content

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:

  • #31974 (Drop testnet3 by Sjors)
  • #30277 ([DO NOT MERGE] Erlay: bandwidth-efficient transaction relay protocol (Full implementation) by sr-gi)
  • #17783 (common: Disallow calling IsArgSet() on ALLOW_LIST options by ryanofsky)
  • #17581 (refactor: Remove settings merge reverse precedence code by ryanofsky)
  • #17580 (refactor: Add ALLOW_LIST flags and enforce usage in CheckArgFlags by ryanofsky)
  • #17493 (util: Forbid ambiguous multiple assignments in config file by ryanofsky)

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.

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

src/init.cpp Outdated
@@ -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

@maflcko
Copy link
Member

maflcko commented Jul 18, 2025

Can this be drafted/closed, or are you still working on this?

@Zeegaths
Copy link
Author

Zeegaths commented Jul 18, 2025 via email

@maflcko
Copy link
Member

maflcko commented Jul 21, 2025

No, you haven't replied/addressed the feedback from June: #32699 (comment)

@Zeegaths
Copy link
Author

Zeegaths commented Jul 21, 2025 via email

@maflcko
Copy link
Member

maflcko commented Jul 22, 2025

all good now

no, it is not. This can be seen if you take a look at the changes yourself.

Also, it would have to be squashed, as already explained above as well.

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

@Zeegaths Zeegaths force-pushed the ship-docs-32565 branch 2 times, most recently from cad125e to 7796bc0 Compare July 22, 2025 19:08
@DrahtBot
Copy link
Contributor

🚧 At least one of the CI tasks failed.
Task ARM, unit tests, no functional tests: https://github.com/bitcoin/bitcoin/runs/46503198633
LLM reason (✨ experimental): The failure is caused by a syntax error and an undefined function in init.cpp.

Hints

Try to run the tests locally, according to the documentation. However, a CI failure may still
happen due to a number of reasons, for example:

  • Possibly due to a silent merge conflict (the changes in this pull request being
    incompatible with the current code in the target branch). If so, make sure to rebase on the latest
    commit of the target branch.

  • A sanitizer issue, which can only be found by compiling with the sanitizer and running the
    affected test.

  • An intermittent issue.

Leave a comment here, if you need help tracking down a confusing failure.

@Zeegaths Zeegaths closed this Jul 22, 2025
@Zeegaths Zeegaths deleted the ship-docs-32565 branch July 22, 2025 19:39
@Zeegaths Zeegaths restored the ship-docs-32565 branch July 22, 2025 19:40
@Zeegaths Zeegaths reopened this Jul 22, 2025
src/init.cpp Outdated
if (CLIENT_VERSION_MINOR == 99) {
std::string stable_version = strprintf("v%d.0", CLIENT_VERSION_MAJOR);
return strprintf("https://github.com/bitcoin/bitcoin/blob/%s/doc/%s", stable_version, doc_path);
;
Copy link

Choose a reason for hiding this comment

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

There's an unnecessary semicolon on its own line that should be removed.

@Zeegaths
Copy link
Author

Zeegaths commented Jul 23, 2025 via email

adds correct documentation links
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
8 participants