docs(config): clarify ReproviderStrategy roots
Marcin Rataj committed
Dec 8, 2023 at 16:19 UTC
9343a95f4d568deebde2df3a458f383be6934382
1 file changed
+7
docs/config.md
+7
@@ -1467,6 +1467,13 @@ Tells reprovider what should be announced. Valid strategies are:
1467
- `"all"` - announce all CIDs of stored blocks
1468
- `"pinned"` - only announce pinned CIDs recursively (both roots and child blocks)
1469
- `"roots"` - only announce the root block of explicitly pinned CIDs
1470
+ - **⚠️ BE CAREFUL:** node with `roots` strategy will not announce child blocks.
1471
+ It makes sense only for use cases where the entire DAG is fetched in full,
1472
+ and a graceful resume does not have to be guaranteed: the lack of child
1473
+ announcements means an interrupted retrieval won't be able to find
1474
+ providers for the missing block in the middle of a file, unless the peer
1475
+ happens to already be connected to a provider and ask for child CID over
1476
+ bitswap.
1477
1478
Default: `"all"`
1479