mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-02-20 14:05:23 +01:00
Merge bitcoin/bitcoin#30025: doc: fix broken relative md links
4b9f49da2b
doc: fix broken relative md links (willcl-ark) Pull request description: These relative links in our documentation are broken, fix them. ACKs for top commit: maflcko: ACK4b9f49da2b
ryanofsky: Code review ACK4b9f49da2b
. Thanks for the updates! ismaelsadeeq: Re ACK4b9f49da2b
Tree-SHA512: df4ef5ddece6c21125ce719ed6a4f69aba4f884c353ff7a8445ecb6438ed6bf0ff8268a1ae19cdd910adaadc189c6861c445b4d469f92ee81874d810dcbd0846
This commit is contained in:
commit
09d3ad2861
5 changed files with 15 additions and 16 deletions
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
--------------------------
|
||||
|
|
|
@ -123,11 +123,11 @@ We can also log custom events to the logger.
|
|||
```
|
||||
|
||||
**Note: Please also consider the functional test
|
||||
[readme](../test/functional/README.md), which provides an overview of the
|
||||
[readme](/test/functional/README.md), which provides an overview of the
|
||||
test-framework**. Modules such as
|
||||
[key.py](../test/functional/test_framework/key.py),
|
||||
[script.py](../test/functional/test_framework/script.py) and
|
||||
[messages.py](../test/functional/test_framework/messages.py) are particularly
|
||||
[key.py](/test/functional/test_framework/key.py),
|
||||
[script.py](/test/functional/test_framework/script.py) and
|
||||
[messages.py](/test/functional/test_framework/messages.py) are particularly
|
||||
useful in constructing objects which can be passed to the bitcoind nodes managed
|
||||
by a running `TestShell` object.
|
||||
|
||||
|
|
|
@ -30,13 +30,13 @@ Then you can use:
|
|||
|
||||
| Lint test | Dependency |
|
||||
|-----------|:----------:|
|
||||
| [`lint-python.py`](lint/lint-python.py) | [flake8](https://gitlab.com/pycqa/flake8)
|
||||
| [`lint-python.py`](lint/lint-python.py) | [lief](https://github.com/lief-project/LIEF)
|
||||
| [`lint-python.py`](lint/lint-python.py) | [mypy](https://github.com/python/mypy)
|
||||
| [`lint-python.py`](lint/lint-python.py) | [pyzmq](https://github.com/zeromq/pyzmq)
|
||||
| [`lint-python-dead-code.py`](lint/lint-python-dead-code.py) | [vulture](https://github.com/jendrikseipp/vulture)
|
||||
| [`lint-shell.py`](lint/lint-shell.py) | [ShellCheck](https://github.com/koalaman/shellcheck)
|
||||
| [`lint-spelling.py`](lint/lint-spelling.py) | [codespell](https://github.com/codespell-project/codespell)
|
||||
| [`lint-python.py`](/test/lint/lint-python.py) | [flake8](https://github.com/PyCQA/flake8)
|
||||
| [`lint-python.py`](/test/lint/lint-python.py) | [lief](https://github.com/lief-project/LIEF)
|
||||
| [`lint-python.py`](/test/lint/lint-python.py) | [mypy](https://github.com/python/mypy)
|
||||
| [`lint-python.py`](/test/lint/lint-python.py) | [pyzmq](https://github.com/zeromq/pyzmq)
|
||||
| [`lint-python-dead-code.py`](/test/lint/lint-python-dead-code.py) | [vulture](https://github.com/jendrikseipp/vulture)
|
||||
| [`lint-shell.py`](/test/lint/lint-shell.py) | [ShellCheck](https://github.com/koalaman/shellcheck)
|
||||
| [`lint-spelling.py`](/test/lint/lint-spelling.py) | [codespell](https://github.com/codespell-project/codespell)
|
||||
|
||||
In use versions and install instructions are available in the [CI setup](../../ci/lint/04_install.sh).
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue