From 4012ea40c10eff60f0014ba3dcb55f942360e365 Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Wed, 3 Apr 2024 19:58:11 +0200 Subject: [PATCH] docs: document order in Reprovider.Strategy --- docs/changelogs/v0.28.md | 2 ++ docs/config.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/changelogs/v0.28.md b/docs/changelogs/v0.28.md index c4f2fdff791c..bc1687d008c6 100644 --- a/docs/changelogs/v0.28.md +++ b/docs/changelogs/v0.28.md @@ -33,6 +33,8 @@ The Object API commands deprecated back in [2021](https://github.com/ipfs/kubo/i The pin roots are now prioritized when announcing content in the Amino DHT, making the content accessible faster. +More details in [`Reprovider.Strategy` docs](https://github.com/ipfs/kubo/blob/master/docs/config.md#reproviderstrategy). + ### ๐Ÿ“ Changelog ### ๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Contributors diff --git a/docs/config.md b/docs/config.md index 0fa5000ac45b..deed359d5f6e 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1500,7 +1500,9 @@ Type: `optionalDuration` (unset for the default) Tells reprovider what should be announced. Valid strategies are: - `"all"` - announce all CIDs of stored blocks + - Order: the root CIDs of pins are announced first, then the rest of CIDs in the blockstore. - `"pinned"` - only announce pinned CIDs recursively (both roots and child blocks) + - Order: the root CIDs of pins are announced first, then the internal child CIDs of recursively pinned DAGs. - `"roots"` - only announce the root block of explicitly pinned CIDs - **โš ๏ธ BE CAREFUL:** node with `roots` strategy will not announce child blocks. It makes sense only for use cases where the entire DAG is fetched in full,