s3:docs: Document "cache directory" and "state directory".

Part of a fix for bug #6890 (Some smb.conf parameters are undocumented).

Karolin

diff --git a/docs-xml/smbdotconf/misc/cachedirectory.xml b/docs-xml/smbdotconf/misc/cachedirectory.xml
new file mode 100644 (file)
index 0000000..5216998
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/cachedirectory.xml
@@ -0,0 +1,22 @@
+<samba:parameter name="cache directory"
+                 context="G"
+                 advanced="1" developer="1"
+                type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+       <para>Usually, most of the TDB files are stored in the <parameter
+       moreinfo="none">lock directory</parameter>. Since Samba 3.4.0, it is
+       possible to differentiate between TDB files with persistent data and
+       TDB files with non-persistent data using the
+       <parameter moreinfo="none">state directory</parameter> and the
+       <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>
+</description>
+
+<value type="default">${prefix}/var/locks</value>
+<value type="example">/var/run/samba/locks/cache</value>
+</samba:parameter>

diff --git a/docs-xml/smbdotconf/misc/statedirectory.xml b/docs-xml/smbdotconf/misc/statedirectory.xml
new file mode 100644 (file)
index 0000000..f8cfcdf
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/statedirectory.xml
@@ -0,0 +1,22 @@
+<samba:parameter name="state directory"
+                 context="G"
+                 advanced="1" developer="1"
+                type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+       <para>Usually, most of the TDB files are stored in the
+       <parameter moreinfo="none">lock directory</parameter>. Since
+       Samba 3.4.0, it is possible to differentiate between TDB files
+       with persistent data and TDB files with non-persistent data using
+       the <parameter moreinfo="none">state directory</parameter> and the
+       <parameter moreinfo="none">cache directory</parameter> options.
+       </para>
+
+       <para> This option specifies the directory where TDB files containing
+       persistent data will be stored.
+       </para>
+</description>
+
+<value type="default">${prefix}/var/locks</value>
+<value type="example">/var/run/samba/locks/state</value>
+</samba:parameter>