changeset 3669:23be54db81f1

doc (cli/pubsub_cache): add a warning for `reset`
author Goffi <goffi@goffi.org>
date Wed, 08 Sep 2021 17:58:48 +0200 (2021-09-08)
parents 0eacda79b5d1
children d0b66efc6c0e
files doc/libervia-cli/pubsub_cache.rst
diffstat 1 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/libervia-cli/pubsub_cache.rst	Wed Sep 08 17:58:48 2021 +0200
+++ b/doc/libervia-cli/pubsub_cache.rst	Wed Sep 08 17:58:48 2021 +0200
@@ -90,6 +90,16 @@
 from cache. After this command, cache will be re-filled progressively as if it where a new
 one.
 
+.. note::
+
+    Use this command with caution: even if cache will be re-constructed with time, that
+    means that items will have to be retrieved again, that may be resource intensive both
+    for your machine and for the pubsub services which will be used. That also means that
+    searching items will return less results until all desired items are cached again.
+
+    Also note that all items of cached nodes are retrieved, even if you have previously
+    purged items, they will be retrieved again.
+
 example
 -------