mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-03-12 10:30:08 +01:00
Merge bitcoin/bitcoin#32011: Docs: fix typos in documentation files
5601bab4f8
Docs: fix typos in documentation files (wgyt) Pull request description: ACKs for top commit: jonatack: ACK5601bab4f8
mabu44: crACK5601bab4f8
maflcko: lgtm ACK5601bab4f8
Tree-SHA512: 66c14638090f472f6c68d094cd9b0fc2e47e40d29e4f30a0a798992317cce8e96ef053ff159cf950a1d44cffb24554c6cebccec5cf49d24f105b367fc29382c1
This commit is contained in:
commit
45719390a1
6 changed files with 8 additions and 8 deletions
|
@ -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`
|
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
|
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
|
when installing the Debian package later than 1.2.0-4 and when using the shell
|
||||||
script installer.
|
script installer.
|
||||||
|
|
||||||
|
|
|
@ -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*.
|
- *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.
|
- 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.
|
||||||
|
|
||||||
|
|
|
@ -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.
|
- 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
|
### 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.
|
- The generated code handles IPC communication, translating interface calls into socket reads and writes.
|
||||||
|
|
||||||
### C++ Client Subclasses in Generated Code
|
### C++ Client Subclasses in Generated Code
|
||||||
|
|
|
@ -32,5 +32,5 @@ Alternately, you can install [Cap'n Proto](https://capnproto.org/) and [libmulti
|
||||||
## Usage
|
## 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.
|
`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.
|
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.
|
||||||
|
|
|
@ -73,7 +73,7 @@ Arguments passed:
|
||||||
|
|
||||||
Note: The message is passed to the tracepoint in full, however, due to space
|
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
|
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
|
be detected in tracing scripts by comparing the message size to the length of
|
||||||
the passed message.
|
the passed message.
|
||||||
|
|
||||||
|
@ -92,7 +92,7 @@ Arguments passed:
|
||||||
|
|
||||||
Note: The message is passed to the tracepoint in full, however, due to space
|
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
|
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
|
be detected in tracing scripts by comparing the message size to the length of
|
||||||
the passed message.
|
the passed message.
|
||||||
|
|
||||||
|
@ -122,7 +122,7 @@ Arguments passed:
|
||||||
|
|
||||||
#### Tracepoint `net:evicted_inbound_connection`
|
#### 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:
|
Arguments passed:
|
||||||
1. Peer ID as `int64`
|
1. Peer ID as `int64`
|
||||||
|
|
|
@ -32,7 +32,7 @@ pkh(xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg
|
||||||
|
|
||||||
It uses `pkh()` because `tr()` outputs at low heights are not spendable (`unexpected-witness`).
|
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
|
are stored in `mainnet_alt.json` and used to reconstruct the chain without
|
||||||
having to redo the proof-of-work.
|
having to redo the proof-of-work.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue