contrib: list other binaries in manpage output #29585

pull fanquake wants to merge 1 commits into bitcoin:master from fanquake:list_other_pages_in_man changing 1 files +4 −0

fanquake commented at 1:19 PM on March 7, 2024: member

Add a SEE ALSO section to the manpages.

Master:

This PR:

Should be enough to close #29558.
contrib: list other binaries in manpage output 7c3ac598dd
DrahtBot commented at 1:20 PM on March 7, 2024: contributor



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



Code Coverage

For detailed information about the code coverage, see the test coverage report.



Reviews

See the guideline for information on the review process.

Type Reviewers

ACK jarolrod, willcl-ark, pablomartin4btc, laanwj

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.
DrahtBot added the label Scripts and tools on Mar 7, 2024
jarolrod commented at 5:50 AM on March 9, 2024: member

tACK 7c3ac598dd9a1f1a506c4931249ff6c9f1c949ba

master <img width="654" alt="Screenshot 2024-03-08 at 11 48 53 PM" src="https://github.com/bitcoin/bitcoin/assets/23396902/18dc622e-6c91-4c79-8104-a45df19a3c6c">

pr <img width="671" alt="Screenshot 2024-03-08 at 11 42 11 PM" src="https://github.com/bitcoin/bitcoin/assets/23396902/b8c5de19-fb19-49c2-92ab-f4754030a8f4">
luke-jr referenced this in commit 53c6f77e86 on Mar 14, 2024
luke-jr changes_requested
luke-jr commented at 11:40 PM on March 14, 2024: member

The manpage you're viewing shouldn't be listed in See Also...
luke-jr commented at 12:01 AM on March 15, 2024: member

https://github.com/bitcoin/bitcoin/commit/96008babf55d9d70aeff716e138e363016da6fd2
willcl-ark approved
willcl-ark commented at 9:16 AM on March 21, 2024: member

ACK 7c3ac598dd9a1f1a506c4931249ff6c9f1c949ba

I don't see it as a big issue to list all related binaries in the bitcoin "ecosystem" in the SEE ALSO section myself.
pablomartin4btc approved
pablomartin4btc commented at 2:33 PM on April 15, 2024: member

utACK 7c3ac598dd9a1f1a506c4931249ff6c9f1c949ba

Type	Reviewers
ACK	jarolrod, willcl-ark, pablomartin4btc, laanwj

in contrib/devtools/gen-manpages.py:67 in 7c3ac598dd

  61 | @@ -62,6 +62,10 @@
  62 |      # Copyright is the same for all binaries, so just use the first.
  63 |      footer.write('[COPYRIGHT]\n')
  64 |      footer.write('\n'.join(versions[0][2]).strip())
  65 | +    # Create SEE ALSO section
  66 | +    footer.write('\n[SEE ALSO]\n')
  67 | +    footer.write(', '.join(s.rpartition('/')[2] + '(1)' for s in BINARIES))

laanwj commented at 7:44 AM on April 24, 2024:

Could use os.path.basename it's slightly more readable and will always pick the last path item.

Edit: wait, so does rpartition, confused it for normal split. It's fine like this.

laanwj commented at 7:44 AM on April 24, 2024: member

Good idea, concept ACK.
laanwj approved
laanwj commented at 7:49 AM on April 24, 2024: member

Code review ACK 7c3ac598dd9a1f1a506c4931249ff6c9f1c949ba
fanquake merged this on Apr 24, 2024
fanquake closed this on Apr 24, 2024
fanquake deleted the branch on Apr 24, 2024
hebasto referenced this in commit ee9491369f on May 12, 2024
PastaPastaPasta referenced this in commit 9c85378443 on Oct 25, 2024
PastaPastaPasta referenced this in commit 700b8c5ac5 on Oct 26, 2024
bitcoin locked this on Apr 24, 2025

Contributors

Labels

Linked (view graph)

contrib: list other binaries in manpage output #29585

Code Coverage

Reviews