docs: Clarify description for cache, lock and state directory settings

Signed-off-by: Christof Schmitt <cs@samba.org>
Reviewed-by: Andreas Schneider <asn@samba.org>

diff --git a/docs-xml/smbdotconf/misc/cachedirectory.xml b/docs-xml/smbdotconf/misc/cachedirectory.xml
index 6ffda0b1b0354559b0e6ade088e07ff365bd0053..21d7d9461d8988bcf83c8226ce1d795aa43c9138 100644 (file)
--- a/docs-xml/smbdotconf/misc/cachedirectory.xml
+++ b/docs-xml/smbdotconf/misc/cachedirectory.xml
@@ -12,8 +12,11 @@
        <parameter moreinfo="none">cache directory</parameter> options.
        </para>
 
-       <para> This option specifies the directory where TDB files containing
-       non-persistent data will be stored.
+       <para>This option specifies the directory for storing TDB
+       files containing non-persistent data that will be kept across
+       service restarts. The directory should be placed on persistent
+       storage, but the data can be safely deleted by an
+       administrator.
        </para>
 </description>
 

diff --git a/docs-xml/smbdotconf/misc/lockdirectory.xml b/docs-xml/smbdotconf/misc/lockdirectory.xml
index 738de2e96449d956bde866c5cb487171c6d80f29..f8f64ff9fef3113ff82d4b56eb3ad61b523c88c1 100644 (file)
--- a/docs-xml/smbdotconf/misc/lockdirectory.xml
+++ b/docs-xml/smbdotconf/misc/lockdirectory.xml
@@ -14,6 +14,10 @@
                Note: This option can not be set inside registry
                configurations.
        </para>
+       <para>The files placed in this directory are not required
+       across service restarts and can be safely placed on volatile
+       storage (e.g. tmpfs in Linux)</para>
+
 </description>
 
 <value type="default">&pathconfig.LOCKDIR;</value>

diff --git a/docs-xml/smbdotconf/misc/statedirectory.xml b/docs-xml/smbdotconf/misc/statedirectory.xml
index 084f145039894c032f0a0d2380663f7b6e64e8f5..2f2b0642ea9b75bb31d83f5504150ea9e7289433 100644 (file)
--- a/docs-xml/smbdotconf/misc/statedirectory.xml
+++ b/docs-xml/smbdotconf/misc/statedirectory.xml
@@ -13,7 +13,7 @@
        </para>
 
        <para> This option specifies the directory where TDB files containing
-       persistent data will be stored.
+       important persistent data will be stored.
        </para>
 </description>