doc: consolidate library documentation to libraries.md #26313

pull fanquake wants to merge 2 commits into bitcoin:master from fanquake:lib_doc_consolidate changing 2 files +18 −14
  1. fanquake commented at 9:09 am on October 14, 2022: member
    Deduplicate the makefile comments, in favour of doc/libraries.md. I think a single, more comprehensive source of truth is preferable. Diagrams are also useful. Came up in #26292 (comment).
  2. doc: remove library commentary from src/Makefile.am
    This duplicates and is less explanatory than doc/libraries.md.
    9e9ae6101f
  3. doc: fix typo in doc/libraries.md af781bf4b2
  4. fanquake added the label Docs on Oct 14, 2022
  5. hebasto commented at 9:54 am on October 14, 2022: member

    Deduplicate the makefile comments…

    Concept ACK on that (especially, in the light of #25797).

  6. in src/Makefile.am:438 in 9e9ae6101f outdated
    434@@ -439,7 +435,9 @@ endif
    435 if !ENABLE_WALLET
    436 libbitcoin_node_a_SOURCES += dummywallet.cpp
    437 endif
    438+#
    


    yancyribbens commented at 10:35 am on October 14, 2022:
    @fanquake, just curious why the trailing comment line here without any comment. Is this for automated documentation?
  7. DrahtBot commented at 10:45 am on October 14, 2022: contributor

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

    Conflicts

    Reviewers, this pull request conflicts with the following ones:

    • #26298 (refactor: Move src/interfaces/*.cpp files to libbitcoin_common.a 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.

  8. ryanofsky approved
  9. ryanofsky commented at 2:13 pm on October 14, 2022: contributor
    Code review ACK af781bf4b2998eb17e89b6b24d26a2590e548259, nice cleanups
  10. hebasto approved
  11. hebasto commented at 11:25 am on October 17, 2022: member
    ACK af781bf4b2998eb17e89b6b24d26a2590e548259, I have reviewed the code and it looks OK, I agree it can be merged.
  12. maflcko merged this on Oct 18, 2022
  13. maflcko closed this on Oct 18, 2022

  14. fanquake deleted the branch on Oct 18, 2022
  15. sidhujag referenced this in commit 9c72c59c6b on Oct 23, 2022
  16. bitcoin locked this on Oct 18, 2023

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-07-05 22:12 UTC

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