diff options
author | MacroFake <falke.marco@gmail.com> | 2022-10-24 10:27:54 +0200 |
---|---|---|
committer | MacroFake <falke.marco@gmail.com> | 2022-10-24 10:28:03 +0200 |
commit | c05673577d6467cee23b8eed961312b86fb5c9a5 (patch) | |
tree | e9ded262bcfccee6e604573fecb0854f69064268 | |
parent | 50cc8ef5a72b927cd30f12e6583cad85c43d3c01 (diff) | |
parent | 1184a66347afbaeca69e2d891a138e435fbfd5bb (diff) |
Merge bitcoin/bitcoin#26358: doc: Rearrange a few lines in the dependency graph of libraries
1184a66347afbaeca69e2d891a138e435fbfd5bb doc: Rearrange some lines in the dependency graph of libraries (Stacie Waleyko)
Pull request description:
In this PR, I've attempted to improve readability in the [dependency graph of libraries](https://github.com/bitcoin/bitcoin/blob/master/doc/design/libraries.md) by untangling a few crossed lines. I'm not sure if this is that big of an improvement but wanted to throw it out there.
I used an extremely scientific method of manually counting the number of crossed lines in the original diagram and got 15. This PR reduces that number down to about 10.
I also changed the curve of the lines to "basis" which rounds the edges out. Again, not sure if it really is that much of an improvement, but it seems marginally easier on the eyes.
Here is what the new graph looks like rendered:
![Screenshot from 2022-10-20 22-09-30](https://user-images.githubusercontent.com/1823216/197095545-5fc90cce-a817-4db2-a0f5-1a8a95380b70.png)
The changes can be verified independently with [Mermaid](https://mermaid-js.github.io/mermaid/#/), with the easiest way being the online editor: https://mermaid.live/
I did try moving some more stuff around, particularly the top level of library callers, but was not able to simplify the graph any further.
ACKs for top commit:
shaavan:
ACK 1184a66347afbaeca69e2d891a138e435fbfd5bb
Tree-SHA512: 61d33d68c1e6fa354aebdda5e06e9c7a722ca20886c6acc30dd08af7133d737130d7a646d87f9e5a8ae0bc5a5aabfbc64ded9ee04dfeed8f23d948444add916b
-rw-r--r-- | doc/design/libraries.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/design/libraries.md b/doc/design/libraries.md index 5e51f1e63f..7cda64e713 100644 --- a/doc/design/libraries.md +++ b/doc/design/libraries.md @@ -35,7 +35,7 @@ ```mermaid -%%{ init : { "flowchart" : { "curve" : "linear" }}}%% +%%{ init : { "flowchart" : { "curve" : "basis" }}}%% graph TD; @@ -51,18 +51,18 @@ bitcoin-qt[bitcoin-qt]-->libbitcoin_wallet; bitcoin-wallet[bitcoin-wallet]-->libbitcoin_wallet; bitcoin-wallet[bitcoin-wallet]-->libbitcoin_wallet_tool; -libbitcoin_cli-->libbitcoin_common; libbitcoin_cli-->libbitcoin_util; +libbitcoin_cli-->libbitcoin_common; -libbitcoin_common-->libbitcoin_util; libbitcoin_common-->libbitcoin_consensus; +libbitcoin_common-->libbitcoin_util; libbitcoin_kernel-->libbitcoin_consensus; libbitcoin_kernel-->libbitcoin_util; -libbitcoin_node-->libbitcoin_common; libbitcoin_node-->libbitcoin_consensus; libbitcoin_node-->libbitcoin_kernel; +libbitcoin_node-->libbitcoin_common; libbitcoin_node-->libbitcoin_util; libbitcoinqt-->libbitcoin_common; @@ -71,8 +71,8 @@ libbitcoinqt-->libbitcoin_util; libbitcoin_wallet-->libbitcoin_common; libbitcoin_wallet-->libbitcoin_util; -libbitcoin_wallet_tool-->libbitcoin_util; libbitcoin_wallet_tool-->libbitcoin_wallet; +libbitcoin_wallet_tool-->libbitcoin_util; classDef bold stroke-width:2px, font-weight:bold, font-size: smaller; class bitcoin-qt,bitcoind,bitcoin-cli,bitcoin-wallet bold |