From 5601bab4f8b01fdef7a54c9e397d513217ab1c1f Mon Sep 17 00:00:00 2001 From: wgyt Date: Sat, 8 Mar 2025 09:26:18 +0800 Subject: [PATCH] Docs: fix typos in documentation files --- contrib/guix/INSTALL.md | 2 +- doc/design/libraries.md | 2 +- doc/design/multiprocess.md | 2 +- doc/multiprocess.md | 2 +- doc/tracing.md | 6 +++--- test/functional/data/README.md | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/contrib/guix/INSTALL.md b/contrib/guix/INSTALL.md index 10f5835bb88..515d4487d6e 100644 --- a/contrib/guix/INSTALL.md +++ b/contrib/guix/INSTALL.md @@ -456,7 +456,7 @@ Alternately, see `guix package --search-paths -p "$HOME/.guix-profile"'. However, this is somewhat tedious to do for both `guix pull` and `guix install` for each user on the system that wants to properly use `guix`. I recommend that -you instead add an entry to `/etc/profile.d` instead. This is done by default +you add an entry to `/etc/profile.d` instead. This is done by default when installing the Debian package later than 1.2.0-4 and when using the shell script installer. diff --git a/doc/design/libraries.md b/doc/design/libraries.md index 24185bf4776..7d7228803a6 100644 --- a/doc/design/libraries.md +++ b/doc/design/libraries.md @@ -103,7 +103,7 @@ class bitcoin-qt,bitcoind,bitcoin-cli,bitcoin-wallet bold - *libbitcoin_kernel* should only depend on *libbitcoin_util*, *libbitcoin_consensus*, and *libbitcoin_crypto*. -- 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*, *libbitcoin_crypto*, and *libbitcoin_util*, instead of *libbitcoin_kernel*. +- 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 able to get it from *libbitcoin_consensus*, *libbitcoin_common*, *libbitcoin_crypto*, 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. diff --git a/doc/design/multiprocess.md b/doc/design/multiprocess.md index ac9e930e12a..11e81527ce1 100644 --- a/doc/design/multiprocess.md +++ b/doc/design/multiprocess.md @@ -74,7 +74,7 @@ This section describes the major components of the Inter-Process Communication ( - These Cap’n Proto files ([learn more about Cap'n Proto RPC](https://capnproto.org/rpc.html)) define the structure and format of messages that are exchanged over IPC. They serve as blueprints for generating C++ code that bridges the gap between high-level C++ interfaces and low-level socket communication. ### The `mpgen` Code Generation Tool -- A central component of the IPC framework is the `mpgen` tool which is part the [`libmultiprocess` project](https://github.com/bitcoin-core/libmultiprocess). This tool takes the `.capnp` files as input and generates C++ code. +- A central component of the IPC framework is the `mpgen` tool which is part of the [`libmultiprocess` project](https://github.com/bitcoin-core/libmultiprocess). This tool takes the `.capnp` files as input and generates C++ code. - The generated code handles IPC communication, translating interface calls into socket reads and writes. ### C++ Client Subclasses in Generated Code diff --git a/doc/multiprocess.md b/doc/multiprocess.md index bd2464ffc34..f4c7375856a 100644 --- a/doc/multiprocess.md +++ b/doc/multiprocess.md @@ -32,5 +32,5 @@ Alternately, you can install [Cap'n Proto](https://capnproto.org/) and [libmulti ## Usage `bitcoin-node` is a drop-in replacement for `bitcoind`, and `bitcoin-gui` is a drop-in replacement for `bitcoin-qt`, and there are no differences in use or external behavior between the new and old executables. But internally after [#10102](https://github.com/bitcoin/bitcoin/pull/10102), `bitcoin-gui` will spawn a `bitcoin-node` process to run P2P and RPC code, communicating with it across a socket pair, and `bitcoin-node` will spawn `bitcoin-wallet` to run wallet code, also communicating over a socket pair. This will let node, wallet, and GUI code run in separate address spaces for better isolation, and allow future improvements like being able to start and stop components independently on different machines and environments. -[#19460](https://github.com/bitcoin/bitcoin/pull/19460) also adds a new `bitcoin-node` `-ipcbind` option and an `bitcoind-wallet` `-ipcconnect` option to allow new wallet processes to connect to an existing node process. +[#19460](https://github.com/bitcoin/bitcoin/pull/19460) also adds a new `bitcoin-node` `-ipcbind` option and a `bitcoind-wallet` `-ipcconnect` option to allow new wallet processes to connect to an existing node process. And [#19461](https://github.com/bitcoin/bitcoin/pull/19461) adds a new `bitcoin-gui` `-ipcconnect` option to allow new GUI processes to connect to an existing node process. diff --git a/doc/tracing.md b/doc/tracing.md index 53577438fa7..67c256a119f 100644 --- a/doc/tracing.md +++ b/doc/tracing.md @@ -73,7 +73,7 @@ Arguments passed: Note: The message is passed to the tracepoint in full, however, due to space limitations in the eBPF kernel VM it might not be possible to pass the message -to user-space in full. Messages longer than a 32kb might be cut off. This can +to user-space in full. Messages longer than 32kb might be cut off. This can be detected in tracing scripts by comparing the message size to the length of the passed message. @@ -92,7 +92,7 @@ Arguments passed: Note: The message is passed to the tracepoint in full, however, due to space limitations in the eBPF kernel VM it might not be possible to pass the message -to user-space in full. Messages longer than a 32kb might be cut off. This can +to user-space in full. Messages longer than 32kb might be cut off. This can be detected in tracing scripts by comparing the message size to the length of the passed message. @@ -122,7 +122,7 @@ Arguments passed: #### Tracepoint `net:evicted_inbound_connection` -Is called when a inbound connection is evicted by us. Passes information about the evicted peer and the time at connection establishment. +Is called when an inbound connection is evicted by us. Passes information about the evicted peer and the time at connection establishment. Arguments passed: 1. Peer ID as `int64` diff --git a/test/functional/data/README.md b/test/functional/data/README.md index eb217d6071e..bb03422f95f 100644 --- a/test/functional/data/README.md +++ b/test/functional/data/README.md @@ -32,7 +32,7 @@ pkh(xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg It uses `pkh()` because `tr()` outputs at low heights are not spendable (`unexpected-witness`). -This makes each block determinisic except for its timestamp and nonce, which +This makes each block deterministic except for its timestamp and nonce, which are stored in `mainnet_alt.json` and used to reconstruct the chain without having to redo the proof-of-work.