diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/design/libraries.md | 2 | ||||
| -rw-r--r-- | doc/design/multiprocess.md | 2 | ||||
| -rw-r--r-- | doc/developer-notes.md | 5 |
3 files changed, 4 insertions, 5 deletions
diff --git a/doc/design/libraries.md b/doc/design/libraries.md index 3346c8e81b..251c52199d 100644 --- a/doc/design/libraries.md +++ b/doc/design/libraries.md @@ -95,7 +95,7 @@ class bitcoin-qt,bitcoind,bitcoin-cli,bitcoin-wallet bold - The only thing that should depend on *libbitcoin_kernel* internally should be *libbitcoin_node*. GUI and wallet libraries *libbitcoinqt* and *libbitcoin_wallet* in particular should not depend on *libbitcoin_kernel* and the unneeded functionality it would pull in, like block validation. To the extent that GUI and wallet code need scripting and signing functionality, they should be get able it from *libbitcoin_consensus*, *libbitcoin_common*, and *libbitcoin_util*, instead of *libbitcoin_kernel*. -- GUI, node, and wallet code internal implementations should all be independent of each other, and the *libbitcoinqt*, *libbitcoin_node*, *libbitcoin_wallet* libraries should never reference each other's symbols. They should only call each other through [`src/interfaces/`](`../../src/interfaces/`) abstract interfaces. +- GUI, node, and wallet code internal implementations should all be independent of each other, and the *libbitcoinqt*, *libbitcoin_node*, *libbitcoin_wallet* libraries should never reference each other's symbols. They should only call each other through [`src/interfaces/`](../../src/interfaces/) abstract interfaces. ## Work in progress diff --git a/doc/design/multiprocess.md b/doc/design/multiprocess.md index 636d78d905..49410a4213 100644 --- a/doc/design/multiprocess.md +++ b/doc/design/multiprocess.md @@ -142,7 +142,7 @@ In the current design, class names, method names, and parameter names are duplic An alternate approach could use custom [C++ Attributes](https://en.cppreference.com/w/cpp/language/attributes) embedded in interface declarations to automatically generate `.capnp` files from C++ headers. This has not been pursued because parsing C++ headers is more complicated than parsing Cap’n Proto interface definitions, especially portably on multiple platforms. -In the meantime, the developer guide [Internal interface guidelines](developer-notes.md#internal-interface-guidelines) can provide guidance on keeping interfaces consistent and functional and avoiding compile errors. +In the meantime, the developer guide [Internal interface guidelines](../developer-notes.md#internal-interface-guidelines) can provide guidance on keeping interfaces consistent and functional and avoiding compile errors. ### Interface Stability diff --git a/doc/developer-notes.md b/doc/developer-notes.md index cc3f0518e5..3458a71467 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -334,7 +334,7 @@ Recommendations: - Avoid linking to external documentation; links can break. - Javadoc and all valid Doxygen comments are stripped from Doxygen source code - previews (`STRIP_CODE_COMMENTS = YES` in [Doxyfile.in](doc/Doxyfile.in)). If + previews (`STRIP_CODE_COMMENTS = YES` in [Doxyfile.in](/doc/Doxyfile.in)). If you want a comment to be preserved, it must instead use `//` or `/* */`. ### Generating Documentation @@ -1335,8 +1335,7 @@ Release notes should be written for any PR that: Release notes should be added to a PR-specific release note file at `/doc/release-notes-<PR number>.md` to avoid conflicts between multiple PRs. -All `release-notes*` files are merged into a single -[/doc/release-notes.md](/doc/release-notes.md) file prior to the release. +All `release-notes*` files are merged into a single `release-notes-<version>.md` file prior to the release. RPC interface guidelines -------------------------- |