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

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).

doc: remove library commentary from src/Makefile.am

This duplicates and is less explanatory than doc/libraries.md.

9e9ae6101f

doc: fix typo in doc/libraries.md af781bf4b2
fanquake added the label Docs on Oct 14, 2022
fanquake cross-referenced this on Oct 14, 2022 from issue util: move threadinterrupt into util/ by fanquake
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).
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?
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.
DrahtBot cross-referenced this on Oct 14, 2022 from issue refactor: Move src/interfaces/*.cpp files to libbitcoin_common.a by ryanofsky
ryanofsky approved
ryanofsky commented at 2:13 PM on October 14, 2022: contributor

Code review ACK af781bf4b2998eb17e89b6b24d26a2590e548259, nice cleanups
hebasto approved
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.
maflcko merged this on Oct 18, 2022
maflcko closed this on Oct 18, 2022
fanquake deleted the branch on Oct 18, 2022
sidhujag referenced this in commit 9c72c59c6b on Oct 23, 2022
bitcoin locked this on Oct 18, 2023

Contributors

Labels

Linked (view graph)

#26292 util: move threadinterrupt into util/

doc: consolidate library documentation to libraries.md #26313

Conflicts