[master] f29a25b5b improve documentation about the deprecated persistent storage engine

Nils Goroll nils.goroll at uplex.de
Fri Dec 13 13:47:07 UTC 2019


commit f29a25b5b1a56053052071d77780f29009a9beb0
Author: Nils Goroll <nils.goroll at uplex.de>
Date:   Fri Dec 13 14:45:45 2019 +0100

    improve documentation about the deprecated persistent storage engine
    
    Ref #2575

diff --git a/doc/sphinx/phk/persistent.rst b/doc/sphinx/phk/persistent.rst
index 2e0c40f32..cdcb2d9c0 100644
--- a/doc/sphinx/phk/persistent.rst
+++ b/doc/sphinx/phk/persistent.rst
@@ -1,4 +1,4 @@
-.. _phk_pesistent:
+.. _phk_persistent:
 
 ====================
 A persistent message
@@ -15,9 +15,16 @@ Under narrow and ill defined circumstances, -spersistent works well,
 but in general it is more trouble than it is worth for you to run
 it, and we don't presently have the development resources to fix that.
 
-If you think you have these circumstances, you need to specify
+If you think you have these circumstances, you need to
 
-	-sdeprecated_persistent
+* call ``configure`` with ``--with-persistent-storage`` before
+  compilation
+
+* use the storage engine name ``deprecated_persistent``, use a::
+
+    -sdeprecated_persistent,<options>
+
+  argument when starting varnish
 
 in order to use it.
 
diff --git a/doc/sphinx/users-guide/storage-backends.rst b/doc/sphinx/users-guide/storage-backends.rst
index b99972120..1b4dbddbe 100644
--- a/doc/sphinx/users-guide/storage-backends.rst
+++ b/doc/sphinx/users-guide/storage-backends.rst
@@ -162,10 +162,12 @@ and MADV_SEQUENTIAL madvise() advice argument, respectively.  Defaults to
 On Linux, large objects and rotational disk should benefit from
 "sequential".
 
-persistent (experimental)
-~~~~~~~~~~~~~~~~~~~~~~~~~
+deprecated_persistent
+~~~~~~~~~~~~~~~~~~~~~
 
-syntax: persistent,path,size {experimental}
+syntax: deprecated_persistent,path,size {experimental}
+
+*Before using, read `phk_persistent`_!*
 
 Persistent storage. Varnish will store objects in a file in a manner
 that will secure the survival of *most* of the objects in the event of
@@ -193,9 +195,10 @@ starts after a shutdown it will discard the content of any silo that
 isn't sealed.
 
 Note that taking persistent silos offline and at the same time using
-bans can cause problems. This is due to the fact that bans added while the silo was
-offline will not be applied to the silo when it reenters the cache. Consequently enabling
-previously banned objects to reappear.
+bans can cause problems. This is due to the fact that bans added while
+the silo was offline will not be applied to the silo when it reenters
+the cache. Consequently enabling previously banned objects to
+reappear.
 
 Transient Storage
 -----------------


More information about the varnish-commit mailing list