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
  1. fanquake commented at 1:19 pm on March 7, 2024: member

    Add a SEE ALSO section to the manpages.

    Master: master

    This PR: pr

    Should be enough to close #29558.

  2. contrib: list other binaries in manpage output 7c3ac598dd
  3. 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.

  4. DrahtBot added the label Scripts and tools on Mar 7, 2024
  5. jarolrod commented at 5:50 am on March 9, 2024: member

    tACK 7c3ac598dd9a1f1a506c4931249ff6c9f1c949ba

    master

    pr

  6. luke-jr referenced this in commit 53c6f77e86 on Mar 14, 2024
  7. luke-jr changes_requested
  8. luke-jr commented at 11:40 pm on March 14, 2024: member
    The manpage you’re viewing shouldn’t be listed in See Also…
  9. willcl-ark approved
  10. 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.

  11. pablomartin4btc approved
  12. pablomartin4btc commented at 2:33 pm on April 15, 2024: member
    utACK 7c3ac598dd9a1f1a506c4931249ff6c9f1c949ba
  13. 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.

  14. laanwj commented at 7:44 am on April 24, 2024: member
    Good idea, concept ACK.
  15. laanwj approved
  16. laanwj commented at 7:49 am on April 24, 2024: member
    Code review ACK 7c3ac598dd9a1f1a506c4931249ff6c9f1c949ba
  17. fanquake merged this on Apr 24, 2024
  18. fanquake closed this on Apr 24, 2024

  19. fanquake deleted the branch on Apr 24, 2024

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: 2024-12-21 15:12 UTC

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