Skip to content

Commit ca38cf7

Browse files
committed
doc: fix a few obvious typos in the affected files
1 parent ddab466 commit ca38cf7

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

doc/design/multiprocess.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ The libmultiprocess runtime is designed to place as few constraints as possible
115115

116116
### Interface Definition Maintenance
117117

118-
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.
118+
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.
119119

120120
In the current design, class names, method names, and parameter names are duplicated between C++ interfaces in [`src/interfaces/`](../../src/interfaces/) and Cap’n 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 Cap’n Proto declarations will result in compile errors. (Static type checking ensures these are not runtime errors.)
121121

doc/developer-notes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ tool to clean up patches automatically before submission.
2020
- Braces on the same line for everything else.
2121
- 4 space indentation (no tabs) for every block except namespaces.
2222
- No indentation for `public`/`protected`/`private` or for `namespace`.
23-
- No extra spaces inside parenthesis; don't do `( this )`.
23+
- No extra spaces inside parentheses; don't do `( this )`.
2424
- No space after function names; one space after `if`, `for` and `while`.
2525
- If an `if` only has a single-statement `then`-clause, it can appear
2626
on the same line as the `if`, without braces. In every other case,
@@ -263,7 +263,7 @@ but the above styles are favored.
263263

264264
Recommendations:
265265

266-
- Avoiding duplicating type and input/output information in function
266+
- Avoid duplicating type and input/output information in function
267267
descriptions.
268268

269269
- Use backticks (``) to refer to `argument` names in function and
@@ -1156,7 +1156,7 @@ $ lsof -p $(pidof bitcoind) |\
11561156
mem = 119, fd = 0
11571157
```
11581158

1159-
The `mem` value shows how many files are mmap'ed, and the `fd` value shows you
1159+
The `mem` value shows how many files are mmap'ed, and the `fd` value shows how
11601160
many file descriptors these files are using. You should check that `fd` is a
11611161
small number (usually 0 on 64-bit hosts).
11621162

doc/productivity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You _must not_ set base_dir to "/", or anywhere that contains system headers (ac
2727

2828
During the generation of the build system only essential build options are enabled by default to save on compilation time.
2929

30-
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.
30+
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.
3131

3232
### Make use of your threads with `-j`
3333

0 commit comments

Comments
 (0)