doc: fix arg name hints so bugprone can validate them #34397

1. 
   l0rinc commented at 11:16 pm on January 23, 2026: contributor

   The extra leading = or missing trailing = prevented clang-tidy’s bugprone-argument-comment check from validating the parameter name, as it only matches comments formatted strictly as /*parameter_name=*/ (see https://clang.llvm.org/extra/clang-tidy/checks/bugprone/argument-comment.html).

   I have considered doing a scripted diff, but the values I found aren’t so numerous and can easily be reviewed manually.

2. DrahtBot added the label Docs on Jan 23, 2026
3. 
   DrahtBot commented at 11:16 pm on January 23, 2026: contributor

   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/34397.

   Reviews

   See the guideline for information on the review process.

   Type	Reviewers
   ACK	b-l-u-e, maflcko, Sjors

   If your review is incorrectly listed, please copy-paste <!–meta-tag:bot-skip–> into the comment that the bot should ignore.

   Conflicts

   Reviewers, this pull request conflicts with the following ones:

   • #34193 (wallet: make migration more robust against failures by furszy)
   • #34037 (wallet, doc: clarify the coin selection filters that enforce cluster count by glozow)
   • #29700 (kernel, refactor: return error status on all fatal errors 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.

4. l0rinc referenced this in commit 94959b8dee on Jan 23, 2026
5. l0rinc force-pushed on Jan 23, 2026
6. DrahtBot added the label CI failed on Jan 23, 2026
7. l0rinc renamed this:
   doc: fix arg name typo in parameter hint in src/node/interfaces.cpp
   doc: fix invalid arg name hints for bugprone validation
   on Jan 23, 2026
8. doc: fix invalid arg name hints for bugprone validation

   The extra leading `=` or missing trailing `=` prevented clang-tidy's `bugprone-argument-comment` check from validating the parameter name, as it only matches comments formatted strictly as `/*arg=*/` (see https://clang.llvm.org/extra/clang-tidy/checks/bugprone/argument-comment.html).

   a73a3ec553
9. l0rinc force-pushed on Jan 23, 2026
10. DrahtBot removed the label CI failed on Jan 24, 2026
11. l0rinc renamed this:
    doc: fix invalid arg name hints for bugprone validation
    doc: fix arg name hints so bugprone can validate them
    on Jan 24, 2026
12. 
    b-l-u-e commented at 5:58 am on January 25, 2026: contributor

    ACK a73a3ec tested and saw that argument comments now use the strict “/param=/” format required by bugprone-argument-comment
13. 
    maflcko commented at 8:48 am on January 26, 2026: member

    makes sense to use a consistent format here

    review ACK a73a3ec5532ddc05c1b013d868d9994f2889c9cf 🍦

    Signature:

    0untrusted comment: signature from minisign secret key on empty file; verify via: minisign -Vm "${path_to_any_empty_file}" -P RWTRmVTMeKV5noAMqVlsMugDDCyyTSbA3Re5AkUrhvLVln0tSaFWglOw -x "${path_to_this_whole_four_line_signature_blob}"
    1RUTRmVTMeKV5npGrKx1nqXCw5zeVHdtdYURB/KlyA/LMFgpNCs+SkW9a8N95d+U4AP1RJMi+krxU1A3Yux4bpwZNLvVBKy0wLgM=
    2trusted comment: review ACK a73a3ec5532ddc05c1b013d868d9994f2889c9cf 🍦
    3tyxeYGmkh1FiRAXrp91x+qbDarNQHUKKw+OL2CdO4E0FoyBRq0fEHU5GUPeY0fyyqNY1r1cLGDvKjsQBVnq8Cw==
    

14. 
    Sjors commented at 3:44 pm on January 26, 2026: member

    utACK a73a3ec5532ddc05c1b013d868d9994f2889c9cf

    The parameter signatures improvements look good to me, but I didn’t check the impact on clang-tidy.

    Some sort of before and after comparison would be nice.

15. 
    l0rinc commented at 3:53 pm on January 26, 2026: contributor

    Some sort of before and after comparison would be nice.

    I have renamed the invalid ones, they would probably fail CI. In my IDE they show up as: and without the trailing equals sign it would just be a dead comment:

16. 
    Sjors commented at 4:16 pm on January 26, 2026: member

    This PR doesn’t change our clang configuration, so presumably it would only trip on those if the lines are touched?
17. 
    l0rinc commented at 4:38 pm on January 26, 2026: contributor

    This PR doesn’t change our clang configuration, so presumably it would only trip on those if the lines are touched?

    I meant that if I had just made the name hints standard (/*parameter_name=*/ format) without adjusting the invalid ones, https://github.com/bitcoin/bitcoin/blob/52096de2121dc86adaab9fbcf31653ba422bc80a/src/.clang-tidy#L4 should have failed the CI.

18. fanquake merged this on Jan 26, 2026
19. fanquake closed this on Jan 26, 2026

    ---

20. l0rinc deleted the branch on Jan 26, 2026

Contributors
l0rinc DrahtBot b-l-u-e maflcko Sjors

Labels
Docs