doc: fix comments referring to nonexistent functions #36782

pull fanquake wants to merge 1 commits into bitcoin:master from fanquake:doc_stale_func_refs changing 38 files +70 −72

fanquake commented at 3:12 PM on November 5, 2026: member

Fix documentation that refers to functions that don't exist, or were renamed.

Maybe there's a lint or Ralph type check we can add for these.
DrahtBot added the label Docs on Nov 5, 2026
DrahtBot commented at 3:13 PM on November 5, 2026: contributor


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



External sites
- Code coverage & benchmarks: https://corecheck.dev/bitcoin/bitcoin/pulls/36782
- Ralph review <img src=https://review.fish.foo/assets/bitcoin/bitcoin/36782.png alt="Ralph review status"> https://git.fish.foo/bitcoin/bitcoin/pulls/36782#author-ralph


Reviews

See the guideline and AI policy for information on the review process.

Type Reviewers

Stale ACK willcl-ark

If your review is incorrectly listed, please copy-paste <code></code> into the comment that the bot should ignore.



Conflicts

Reviewers, this pull request conflicts with the following ones:
- #36380 <img src="https://drahtbot.space/ack_count/bitcoin/bitcoin/36380.svg"> (wallet: extend -walletbroadcast to allow initial send only by vasild)
- #35733 <img src="https://drahtbot.space/ack_count/bitcoin/bitcoin/35733.svg"> (sign: Remove FillableSigningProvider by achow101)
- #35570 <img src="https://drahtbot.space/ack_count/bitcoin/bitcoin/35570.svg"> (refactor: Change some validation.cpp methods to return BlockValidationState by optout21)
- #30951 <img src="https://drahtbot.space/ack_count/bitcoin/bitcoin/30951.svg"> (net: option to disallow v1 connection on ipv4 and ipv6 peers by stratospher)
- #29409 <img src="https://drahtbot.space/ack_count/bitcoin/bitcoin/29409.svg"> (ipc: Expose Chain interface to IPC clients by ryanofsky)
- #17581 <img src="https://drahtbot.space/ack_count/bitcoin/bitcoin/17581.svg"> (refactor: Remove settings merge reverse precedence code by ryanofsky)
- #17493 <img src="https://drahtbot.space/ack_count/bitcoin/bitcoin/17493.svg"> (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.
in src/wallet/test/walletdb_tests.cpp:20 in 43ba29a7db
```
  16 | @@ -17,7 +17,7 @@ BOOST_FIXTURE_TEST_SUITE(walletdb_tests, BasicTestingSetup)
  17 |  BOOST_AUTO_TEST_CASE(walletdb_readkeyvalue)
  18 |  {
  19 |      /**
  20 | -     * When ReadKeyValue() reads from either a "key" or "wkey" it first reads the DataStream into a
  21 | +     * When LoadKey() reads from either a "key" or "wkey" it first reads the DataStream into a
```
willcl-ark commented at 9:32 AM on November 6, 2026:

In 43ba29a7dbec42a423e572e1acd5c4bfbe13db57

Could also drop the references to "wkey" and CWalletKey here I think. LoadKey() only handles "key" records now; LoadLegacyWalletRecords() explicitly rejects "wkey" records with DBErrors::LOAD_FAIL.

fanquake commented at 10:22 AM on November 6, 2026:

Pushed something up here.
willcl-ark approved
willcl-ark commented at 9:33 AM on November 6, 2026: member

ACK 43ba29a7dbec42a423e572e1acd5c4bfbe13db57

One further documentation nit. Otherwise, the updated references match the code.
willcl-ark commented at 9:35 AM on November 6, 2026: member

Maybe there's a lint or Ralph type check we can add for these. cc willcl-ark.

This is attempted (at least partially) in https://github.com/willcl-ark/nix/commit/d0aeeb22d46c2002170481ef908fc6fcdbcaed75

It checks symbol references in changed comments/docs, and looks for stale references left by function removals or renames, including in unchanged files. Obvsiouly itsan LLM review check rather than a deterministic lint, so we'll need to see how reliably it catches these in practice...
fanquake force-pushed on Nov 6, 2026
doc: fix comments referring to renamed members and functions 2ded801eae
fanquake force-pushed on Nov 9, 2026
fanquake commented at 4:38 PM on November 9, 2026: member

Rebased, and renamed m_section_only_args to m_network_only_args.

Type	Reviewers
Stale ACK	willcl-ark

Contributors

Labels

doc: fix comments referring to nonexistent functions #36782

External sites

Reviews

Conflicts