doc: remove unshipped doc references from help and warning text #34839

pull AgusR7 wants to merge 1 commits into bitcoin:master from AgusR7:doc/unshipped-doc-links-helptext changing 5 files +8 −14
  1. AgusR7 commented at 5:51 AM on March 17, 2026: none

    This addresses #32565 by removing user-facing runtime/help text references to markdown files under doc/ that are present in the source tree but are not shipped with Bitcoin Core binary releases.

    The updated strings are in:

    • src/init.cpp
    • src/wallet/init.cpp
    • src/rpc/blockchain.cpp
    • src/rpc/mempool.cpp
    • src/rpc/output_script.cpp

    The scope is intentionally narrow. It does not:

    • change behavior
    • ship documentation files
    • add online documentation links
    • refactor the help system

    Testing:

    • git diff --check 52e8c1ce32a24d94b8fe06fa5e17bf8a176e50f0..HEAD
    • rg -n "doc/(policy/packages|design/assumeutxo|descriptors)\.md|github\.com/bitcoin/bitcoin/blob/master/doc/design/assumeutxo\.md" src/rpc src/init.cpp src/wallet/init.cpp

    The grep returns no matches. No new tests were added, since this change only updates user-facing help text and does not modify behavior.

  2. DrahtBot added the label Docs on Mar 17, 2026
  3. DrahtBot commented at 5:52 AM on March 17, 2026: contributor

    <!--e57a25ab6845829454e8d69fc972939a-->

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

    <!--006a51241073e994b41acfe9ec718e94-->

    Code Coverage & Benchmarks

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

    <!--021abf342d371248e50ceaed478a90ca-->

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK fanquake
    Stale ACK savagemechanic

    If your review is incorrectly listed, please copy-paste <code>&lt;!--meta-tag:bot-skip--&gt;</code> into the comment that the bot should ignore.

    <!--174a7506f384e20aa4161008e828411d-->

    Conflicts

    Reviewers, this pull request conflicts with the following ones:

    • #35027 (net: add -outboundbind option for outgoing source address by 8144225309)
    • #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.

    <!--5faf32d7da4f0f540f40219e4f7537a3-->

    LLM Linter (✨ experimental)

    Possible typos and grammar issues:

    • by below -> below / by default [“specified by below” is grammatically broken and unclear]

    <sup>2026-05-19 09:15:08</sup>

  4. savagemechanic commented at 1:21 AM on May 18, 2026: none

    ACK 4ed0cc624f8b3457f632ac1698270d2f40bcfe91

    Reviewed the diff and verified that the touched help/warning files no longer contain doc/*.md references.

    Ran:

    • git diff --check 52e8c1ce32a24d94b8fe06fa5e17bf8a176e50f0..HEAD
    • rg -n 'doc/[A-Za-z0-9_./-]+\\.md|doc/[A-Za-z0-9_./-]+' src/init.cpp src/wallet/init.cpp\n\nI did not build binaries, since this is a help/warning text-only change.
  5. fanquake commented at 11:03 AM on May 18, 2026: member

    Concept ACK - You've missed a few:

    • doc/policy/packages.md
    • doc/design/assumeutxo.md (links to master, not sure we want that)
    • doc/descriptors.md
  6. AgusR7 commented at 2:22 AM on May 19, 2026: none

    Updated in 160900070476cff1f79d0e7a7aefbf7ffe7979cc.

    This removes the additional C++ RPC help references mentioned in the CACK:

    • doc/policy/packages.md from submitpackage
    • doc/design/assumeutxo.md / the master-branch link from loadtxoutset
    • doc/descriptors.md from both scantxoutset and deriveaddresses

    Re-ran:

    • git diff --check 52e8c1ce32a24d94b8fe06fa5e17bf8a176e50f0..HEAD
    • rg -n "doc/(policy/packages|design/assumeutxo|descriptors)\.md|github\.com/bitcoin/bitcoin/blob/master/doc/design/assumeutxo\.md" src/rpc src/init.cpp src/wallet/init.cpp

    The grep now returns no matches. I did not build binaries, since this is still only help text changes.

  7. fanquake commented at 8:25 AM on May 19, 2026: member

    You'll need to squash your commits.

  8. doc: remove unshipped doc references from help and warning text 0ec1ce2e06
  9. AgusR7 force-pushed on May 19, 2026
  10. AgusR7 commented at 9:15 AM on May 19, 2026: none

    Squashed into one commit and force-pushed: 0ec1ce2e064bebb71412ef98a611f0fcbef7eee8.

    Re-ran:

    • git diff --check 52e8c1ce32a24d94b8fe06fa5e17bf8a176e50f0..HEAD
    • rg -n "doc/(policy/packages|design/assumeutxo|descriptors)\.md|github\.com/bitcoin/bitcoin/blob/master/doc/design/assumeutxo\.md" src/rpc src/init.cpp src/wallet/init.cpp

    The grep returns no matches.

  11. fanquake commented at 1:37 PM on May 20, 2026: member

    ACK 0ec1ce2e064bebb71412ef98a611f0fcbef7eee8

  12. maflcko commented at 2:47 PM on May 20, 2026: member

    Hmm, seems fine, but what is the point of the docs, if they can not be referred to? This just means less people will read them, and they might be confused. Also, the docs are shipped in the git archive tarball for every release, no?

    This is a small follow-up to #34693

    Also, I don't see how those are related pulls. One is fixing links inside the docs itself, this one is removing link from "outside" completely.

  13. fanquake commented at 3:02 PM on May 20, 2026: member

    they might be confused

    They are probably also confused by the fact we reference docs we don't ship. I don't think the fact that they exist in the archive is that relevant, given that isn't (generally) what ships to end users.

  14. maflcko commented at 3:12 PM on May 20, 2026: member

    Yeah, I see, but has there been a complaint by users? IIUC a search engine can trivially find the file: E.g. https://duckduckgo.com/?t=ffab&q=bitcoin+core+doc%2Fdescriptors.md . I know it doesn't point to the right branch and it is online-only, but it seems better than no reference to docs at all.

    This is just my opinion, but I think leaving this as-is is better than removing them.

  15. DrahtBot added the label CI failed on May 20, 2026
  16. fanquake commented at 3:37 PM on May 20, 2026: member

    Ok. Closed #32565 to consolidate any further discussion here. I'm also fine if we leave this as-is.

  17. AgusR7 commented at 6:33 PM on May 21, 2026: none

    Updated the PR description to avoid framing this as a direct follow-up to #34693 and to include the RPC help strings in the scope.

    The intent here is #32565: avoid pointing binary users at local doc/*.md paths that are not included with binary releases. I agree this trades off some documentation discoverability; I’m not trying to settle a broader documentation-linking policy in this PR.

  18. maflcko commented at 9:00 AM on May 27, 2026: member

    Closing for now. I think this may be too controversial. Though, happy to re-open if another reviewer thinks this is important.

  19. maflcko closed this on May 27, 2026


github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-06-02 01:50 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me