Skip to content

Commit

Permalink
docs: document order in Reprovider.Strategy
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel committed Apr 3, 2024
1 parent 2b9575f commit 4012ea4
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/changelogs/v0.28.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 4012ea4

Please sign in to comment.