Docs fix spelling issues (#10493)
* fix keystore.md * fix config.md * fix datastores.md * fix libp2p-resource-management.md
Elias Rad committed
Aug 26, 2024 at 21:32 UTC
91144f7bfc81f171c40161c17d8ae1fe779817ec
4 files changed
+7
-7
docs/config.md
+3
-3
@@ -571,7 +571,7 @@ Additional modes may be added in the future.
571
572
> [!IMPORTANT]
573
> We are in the progress of [rolling out AutoNAT V2](https://github.com/ipfs/kubo/issues/10091).
574
-> Right now, by default, a publicly diallable Kubo provides both V1 and V2 service to other peers,
574
+> Right now, by default, a publicly dialable Kubo provides both V1 and V2 service to other peers,
575
> but only V1 is used by Kubo as a client. In a future release we will remove V1 and switch client to use V2.
576
577
Default: `enabled`
@@ -1615,7 +1615,7 @@ is able to find the 20 final nodes by looking up the in-memory recorded network
1615
This means sustained higher memory to store the routing table
1616
and extra CPU and network bandwidth for each network scan.
1617
However the latency of individual read/write operations should be ~10x faster
1618
-and the provide throughput up to 6 million times faster on larger datasets!
1618
+and provide throughput up to 6 million times faster on larger datasets!
1619
1620
This is not compatible with `Routing.Type` `custom`. If you are using composable routers
1621
you can configure this individually on each router.
@@ -1918,7 +1918,7 @@ Type: `flag`
1918
1919
#### `Swarm.RelayService.Limit`
1920
1921
-Limits applied to every relayed connection.
1921
+Limits are applied to every relayed connection.
1922
1923
Default: `{}`
1924
docs/datastores.md
+1
-1
@@ -40,7 +40,7 @@ Uses a leveldb database to store key value pairs.
40
Uses [badger](https://github.com/dgraph-io/badger) as a key value store.
41
42
* `syncWrites`: Flush every write to disk before continuing. Setting this to false is safe as kubo will automatically flush writes to disk before and after performing critical operations like pinning. However, you can set this to true to be extra-safe (at the cost of a 2-3x slowdown when adding files).
43
-* `truncate`: Truncate the DB if a partially written sector is found (defaults to true). There is no good reason to set this to false unless you want to manually recover partially written (and unpinned) blocks if kubo crashes half-way through a adding a file.
43
+* `truncate`: Truncate the DB if a partially written sector is found (defaults to true). There is no good reason to set this to false unless you want to manually recover partially written (and unpinned) blocks if kubo crashes half-way through adding a file.
44
45
```json
46
{
docs/libp2p-resource-management.md
+2
-2
@@ -91,7 +91,7 @@ These values trump anything else and are parsed directly by go-libp2p.
91
## FAQ
92
93
### What do these "Protected from exceeding resource limits" log messages mean?
94
-"Protected from exceeding resource limits" log messages denote that the resource manager is working and that it prevented additional resources being used beyond the set limits. Per [libp2p code](https://github.com/libp2p/go-libp2p/blob/master/p2p/host/resource-manager/scope.go), these messages take the form of "$scope: cannot reserve $limitKey".
94
+"Protected from exceeding resource limits" log messages denote that the resource manager is working and that it prevented additional resources from being used beyond the set limits. Per [libp2p code](https://github.com/libp2p/go-libp2p/blob/master/p2p/host/resource-manager/scope.go), these messages take the form of "$scope: cannot reserve $limitKey".
95
96
As an example:
97
@@ -133,7 +133,7 @@ Kubo performs sanity checks to ensure that some of the hard limits of the Resour
133
The soft limit of `Swarm.ConnMgr.HighWater` needs to be less than the resource manager hard limit `System.ConnsInbound` for the configuration to make sense.
134
This ensures the ConnMgr cleans up connections based on connection priorities before the hard limits of the ResourceMgr are applied.
135
If `Swarm.ConnMgr.HighWater` is greater than resource manager's `System.ConnsInbound`,
136
-existing low priority idle connections can prevent new high priority connections from being established.
136
+existing low-priority idle connections can prevent new high-priority connections from being established.
137
The ResourceMgr doesn't know that the new connection is high priority and simply blocks it because of the limit its enforcing.
138
139
To ensure the ConnMgr and ResourceMgr are congruent, the ResourceMgr [computed default limits](#computed-default-limits) are adjusted such that:
docs/specifications/keystore.md
+1
-1
@@ -175,7 +175,7 @@ OPTIONS:
175
176
DESCRIPTION:
177
178
- 'ipfs crypt encrypt' is a command used to encypt data so that only holders of a certain
178
+ 'ipfs crypt encrypt' is a command used to encrypt data so that only holders of a certain
179
key can read it.
180
```
181