From 283e8274b2e08baac27208fd1fb775bfaca4aae9 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Sat, 24 Aug 2024 12:06:57 +0300 Subject: [PATCH 1/4] fix keystore.md --- docs/specifications/keystore.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/specifications/keystore.md b/docs/specifications/keystore.md index 7e588ca9853..9609b83c231 100644 --- a/docs/specifications/keystore.md +++ b/docs/specifications/keystore.md @@ -175,7 +175,7 @@ OPTIONS: DESCRIPTION: - 'ipfs crypt encrypt' is a command used to encypt data so that only holders of a certain + 'ipfs crypt encrypt' is a command used to encrypt data so that only holders of a certain key can read it. ``` From 07b21e2cfddbf6cda02733678b6a51e75d78b657 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Sat, 24 Aug 2024 12:15:15 +0300 Subject: [PATCH 2/4] fix config.md --- docs/config.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/config.md b/docs/config.md index 9119610dc7f..107050927b7 100644 --- a/docs/config.md +++ b/docs/config.md @@ -571,7 +571,7 @@ Additional modes may be added in the future. > [!IMPORTANT] > We are in the progress of [rolling out AutoNAT V2](https://github.com/ipfs/kubo/issues/10091). -> Right now, by default, a publicly diallable Kubo provides both V1 and V2 service to other peers, +> Right now, by default, a publicly dialable Kubo provides both V1 and V2 service to other peers, > but only V1 is used by Kubo as a client. In a future release we will remove V1 and switch client to use V2. Default: `enabled` @@ -1615,7 +1615,7 @@ is able to find the 20 final nodes by looking up the in-memory recorded network This means sustained higher memory to store the routing table and extra CPU and network bandwidth for each network scan. However the latency of individual read/write operations should be ~10x faster -and the provide throughput up to 6 million times faster on larger datasets! +and provide throughput up to 6 million times faster on larger datasets! This is not compatible with `Routing.Type` `custom`. If you are using composable routers you can configure this individually on each router. @@ -1918,7 +1918,7 @@ Type: `flag` #### `Swarm.RelayService.Limit` -Limits applied to every relayed connection. +Limits are applied to every relayed connection. Default: `{}` From b448597d419e5b7b5bb2cbc02c7c3b76f026c818 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Sat, 24 Aug 2024 13:50:28 +0300 Subject: [PATCH 3/4] fix datastores.md --- docs/datastores.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/datastores.md b/docs/datastores.md index db729bf97a0..ccedce4c715 100644 --- a/docs/datastores.md +++ b/docs/datastores.md @@ -40,7 +40,7 @@ Uses a leveldb database to store key value pairs. Uses [badger](https://github.com/dgraph-io/badger) as a key value store. * `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). -* `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. +* `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. ```json { From 52aa89522f556c90a5143ae6d67f6297b0b96ee6 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Sat, 24 Aug 2024 13:56:29 +0300 Subject: [PATCH 4/4] fix libp2p-resource-management.md --- docs/libp2p-resource-management.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/libp2p-resource-management.md b/docs/libp2p-resource-management.md index 410982dab94..a778f680dd9 100644 --- a/docs/libp2p-resource-management.md +++ b/docs/libp2p-resource-management.md @@ -91,7 +91,7 @@ These values trump anything else and are parsed directly by go-libp2p. ## FAQ ### What do these "Protected from exceeding resource limits" log messages mean? -"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". +"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". As an example: @@ -133,7 +133,7 @@ Kubo performs sanity checks to ensure that some of the hard limits of the Resour 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. This ensures the ConnMgr cleans up connections based on connection priorities before the hard limits of the ResourceMgr are applied. If `Swarm.ConnMgr.HighWater` is greater than resource manager's `System.ConnsInbound`, -existing low priority idle connections can prevent new high priority connections from being established. +existing low-priority idle connections can prevent new high-priority connections from being established. The ResourceMgr doesn't know that the new connection is high priority and simply blocks it because of the limit its enforcing. To ensure the ConnMgr and ResourceMgr are congruent, the ResourceMgr [computed default limits](#computed-default-limits) are adjusted such that: