docs: adds correct updated documentation links #32699
Conversation
|
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers. Code Coverage & BenchmarksFor details see: https://corecheck.dev/bitcoin/bitcoin/pulls/32699. ReviewsSee the guideline for information on the review process. ConflictsReviewers, this pull request conflicts with the following ones:
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. |
mabu44
left a comment
There was a problem hiding this comment.
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 |
i have update it so it fetches the docs based on build version |
src/wallet/init.cpp
Outdated
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
this could be because you are on developement version. Let me try set it to the latest stable version
|
You can squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits. |
thankyou for this |
df115d0 to
40c2323
Compare
musaHaruna
left a comment
There was a problem hiding this comment.
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
|
Thankyou for the feedback
…On Mon, 16 Jun 2025 at 15:09, musaHaruna ***@***.***> wrote:
***@***.**** commented on this pull request.
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
—
Reply to this email directly, view it on GitHub
<#32699 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AZVGWLGZSNRGKGVIZRYRJGL3D2XYVAVCNFSM6AAAAAB6ZXKXIOVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDSMZRHA4DANJYHA>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
src/init.cpp
Outdated
There was a problem hiding this comment.
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.
|
Thank you, I will do just that
…On Mon, 16 Jun 2025 at 18:12, Winnie Gitau ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In src/init.cpp
<#32699 (comment)>:
> @@ -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";
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.
—
Reply to this email directly, view it on GitHub
<#32699 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AZVGWLD5HTPO47YKQ2QXSG33D3NEPAVCNFSM6AAAAAB6ZXKXIOVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDSMZSGU2DSMBTGQ>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
40c2323 to
d3f0b45
Compare
|
Can this be drafted/closed, or are you still working on this? |
|
Yes, it's done.
…On Fri, 18 Jul 2025 at 15:41, maflcko ***@***.***> wrote:
*maflcko* left a comment (bitcoin/bitcoin#32699)
<#32699 (comment)>
Can this be drafted/closed, or are you still working on this?
—
Reply to this email directly, view it on GitHub
<#32699 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AZVGWLBQ4RMG7UWJVYM6WG33JDTOFAVCNFSM6AAAAAB6ZXKXIOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTAOBZGM3DAMJYHA>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
|
No, you haven't replied/addressed the feedback from June: #32699 (comment) |
|
thanks for pointing that out. all good now
…On Mon, 21 Jul 2025 at 17:19, maflcko ***@***.***> wrote:
*maflcko* left a comment (bitcoin/bitcoin#32699)
<#32699 (comment)>
No, you haven't replied/addressed the feedback from June: #32699 (comment)
<#32699 (comment)>
—
Reply to this email directly, view it on GitHub
<#32699 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AZVGWLHFAQADBZYLO2USSGD3JTZFVAVCNFSM6AAAAAB6ZXKXIOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTAOJWHE4DIOBWGI>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
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 |
cad125e to
7796bc0
Compare
|
🚧 At least one of the CI tasks failed. HintsTry to run the tests locally, according to the documentation. However, a CI failure may still
Leave a comment here, if you need help tracking down a confusing failure. |
7796bc0 to
11c6a86
Compare
src/init.cpp
Outdated
There was a problem hiding this comment.
There's an unnecessary semicolon on its own line that should be removed.
|
Fixed!
…On Tue, 22 Jul 2025 at 23:44, Winnie Gitau ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In src/init.cpp
<#32699 (comment)>:
> @@ -438,6 +438,18 @@ static void registerSignalHandler(int signal, void(*handler)(int))
}
#endif
+std::string GetDocumentationUrl(const std::string& doc_path)
+{
+ 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);
+ ;
There's an unnecessary semicolon on its own line that should be removed.
—
Reply to this email directly, view it on GitHub
<#32699 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AZVGWLA4EKFVAEIR6Z77EPT3J2PCVAVCNFSM6AAAAAB6ZXKXIOVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZTANBUHAYTQNRWGY>
.
You are receiving this because you modified the open/close state.Message
ID: ***@***.***>
|
adds correct documentation links
cca2903 to
44ac87b
Compare
|
This PR does not seem to have attracted much attention from reviewers. As such, it does not seem important enough right now to keep it sitting idle in the list of open PRs. Closing due to lack of interest. |
Added correct links to the docs in place of the missing docs' paths.
Fixes #32565