Skip to content

Commit 4012ea4

Browse files
committed
docs: document order in Reprovider.Strategy
1 parent 2b9575f commit 4012ea4

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

docs/changelogs/v0.28.md

+2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ The Object API commands deprecated back in [2021](https://github.com/ipfs/kubo/i
3333

3434
The pin roots are now prioritized when announcing content in the Amino DHT, making the content accessible faster.
3535

36+
More details in [`Reprovider.Strategy` docs](https://github.com/ipfs/kubo/blob/master/docs/config.md#reproviderstrategy).
37+
3638
### 📝 Changelog
3739

3840
### 👨‍👩‍👧‍👦 Contributors

docs/config.md

+2
Original file line numberDiff line numberDiff line change
@@ -1500,7 +1500,9 @@ Type: `optionalDuration` (unset for the default)
15001500
Tells reprovider what should be announced. Valid strategies are:
15011501

15021502
- `"all"` - announce all CIDs of stored blocks
1503+
- Order: the root CIDs of pins are announced first, then the rest of CIDs in the blockstore.
15031504
- `"pinned"` - only announce pinned CIDs recursively (both roots and child blocks)
1505+
- Order: the root CIDs of pins are announced first, then the internal child CIDs of recursively pinned DAGs.
15041506
- `"roots"` - only announce the root block of explicitly pinned CIDs
15051507
- **⚠️ BE CAREFUL:** node with `roots` strategy will not announce child blocks.
15061508
It makes sense only for use cases where the entire DAG is fetched in full,

0 commit comments

Comments
 (0)