doc: fix a few obvious typos in the affected files

This commit is contained in:
Lőrinc
2025-07-23 22:00:40 -07:00
parent ddab466e0d
commit ca38cf701d
3 changed files with 5 additions and 5 deletions

View File

@@ -115,7 +115,7 @@ The libmultiprocess runtime is designed to place as few constraints as possible
### Interface Definition Maintenance
The choice to maintain interface definitions and C++ type mappings as `.capnp` files in the [`src/ipc/capnp/`](../../src/ipc/capnp/) was mostly done for convenience, and probably something that could be improved in the future.
The choice to maintain interface definitions and C++ type mappings as `.capnp` files in the [`src/ipc/capnp/`](../../src/ipc/capnp/) was mostly done for convenience, and is probably something that could be improved in the future.
In the current design, class names, method names, and parameter names are duplicated between C++ interfaces in [`src/interfaces/`](../../src/interfaces/) and Capn Proto files in [`src/ipc/capnp/`](../../src/ipc/capnp/). While this keeps C++ interface headers simple and free of references to IPC, it is a maintenance burden because it means inconsistencies between C++ declarations and Capn Proto declarations will result in compile errors. (Static type checking ensures these are not runtime errors.)

View File

@@ -20,7 +20,7 @@ tool to clean up patches automatically before submission.
- Braces on the same line for everything else.
- 4 space indentation (no tabs) for every block except namespaces.
- No indentation for `public`/`protected`/`private` or for `namespace`.
- No extra spaces inside parenthesis; don't do `( this )`.
- No extra spaces inside parentheses; don't do `( this )`.
- No space after function names; one space after `if`, `for` and `while`.
- If an `if` only has a single-statement `then`-clause, it can appear
on the same line as the `if`, without braces. In every other case,
@@ -263,7 +263,7 @@ but the above styles are favored.
Recommendations:
- Avoiding duplicating type and input/output information in function
- Avoid duplicating type and input/output information in function
descriptions.
- Use backticks (``) to refer to `argument` names in function and
@@ -1156,7 +1156,7 @@ $ lsof -p $(pidof bitcoind) |\
mem = 119, fd = 0
```
The `mem` value shows how many files are mmap'ed, and the `fd` value shows you
The `mem` value shows how many files are mmap'ed, and the `fd` value shows how
many file descriptors these files are using. You should check that `fd` is a
small number (usually 0 on 64-bit hosts).

View File

@@ -27,7 +27,7 @@ You _must not_ set base_dir to "/", or anywhere that contains system headers (ac
During the generation of the build system only essential build options are enabled by default to save on compilation time.
Run `cmake -B build -LH` to see the full list of available options. GUI tools, such as `ccmake` and `cmake-gui`, can be also helpful.
Run `cmake -B build -LH` to see the full list of available options. GUI tools, such as `ccmake` and `cmake-gui`, can also be helpful.
### Make use of your threads with `-j`