From 9343a95f4d568deebde2df3a458f383be6934382 Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Fri, 8 Dec 2023 16:19:58 +0100 Subject: [PATCH] docs(config): clarify ReproviderStrategy roots --- docs/config.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/config.md b/docs/config.md index 495e9090682..fd0c0a23ed3 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1467,6 +1467,13 @@ Tells reprovider what should be announced. Valid strategies are: - `"all"` - announce all CIDs of stored blocks - `"pinned"` - only announce pinned CIDs recursively (both roots and child blocks) - `"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, + and a graceful resume does not have to be guaranteed: the lack of child + announcements means an interrupted retrieval won't be able to find + providers for the missing block in the middle of a file, unless the peer + happens to already be connected to a provider and ask for child CID over + bitswap. Default: `"all"`