From 9af9b436ed3bc3e74ca7ddf437d16c26a8d540b8 Mon Sep 17 00:00:00 2001
From: David Disseldorp <ddiss@samba.org>
Date: Wed, 26 Nov 2014 13:01:00 +0100
Subject: [PATCH] doc: "prune stale" and "sequence timeout" fssd parameters

This change adds smb.conf documentation for the "fss: prune stale" and
"fss: sequence timeout" parameters accepted by Samba's FSRVP server.

Signed-off-by: David Disseldorp <ddiss@samba.org>
Reviewed-by: Jeremy Allison <jra@samba.org>
---
 docs-xml/smbdotconf/misc/fssprunestale.xml      | 16 ++++++++++++++++
 docs-xml/smbdotconf/misc/fsssequencetimeout.xml | 16 ++++++++++++++++
 docs-xml/smbdotconf/misc/rpcdaemon.xml          |  7 ++++---
 python/samba/tests/docs.py                      |  2 +-
 4 files changed, 37 insertions(+), 4 deletions(-)
 create mode 100644 docs-xml/smbdotconf/misc/fssprunestale.xml
 create mode 100644 docs-xml/smbdotconf/misc/fsssequencetimeout.xml

diff --git a/docs-xml/smbdotconf/misc/fssprunestale.xml b/docs-xml/smbdotconf/misc/fssprunestale.xml
new file mode 100644
index 00000000000..d583104bb1f
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/fssprunestale.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="fss: prune stale"
+                 context="G"
+		 type="boolean"
+		 advanced="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>
+	When enabled, Samba's File Server Remove VSS Protocol (FSRVP) server
+	checks all FSRVP initiated snapshots on startup, and removes any
+	corresponding state (including share definitions) for nonexistent
+	snapshot paths.
+	</para>
+</description>
+<value type="default">no</value>
+<value type="example">yes</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/misc/fsssequencetimeout.xml b/docs-xml/smbdotconf/misc/fsssequencetimeout.xml
new file mode 100644
index 00000000000..9419a3332e1
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/fsssequencetimeout.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="fss: sequence timeout"
+                 context="G"
+		 type="integer"
+		 advanced="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>
+	The File Server Remove VSS Protocol (FSRVP) server includes a message
+	sequence timer to ensure cleanup on unexpected client disconnect. This
+	parameter overrides the default timeout between FSRVP operations.
+	FSRVP timeouts can be completely disabled via a value of 0.
+	</para>
+</description>
+<value type="default">180 or 1800, depending on operation</value>
+<value type="example">0</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/misc/rpcdaemon.xml b/docs-xml/smbdotconf/misc/rpcdaemon.xml
index 5fbe88625b8..a06e91d613e 100644
--- a/docs-xml/smbdotconf/misc/rpcdaemon.xml
+++ b/docs-xml/smbdotconf/misc/rpcdaemon.xml
@@ -56,13 +56,14 @@
 	</para>
 
 	<para>
-	Samba includes separate daemons for spoolss and the lsarpc/lsass,
-	netlogon and samr pipes. Currently three daemons are available and they
-	are called:
+	Samba includes separate daemons for spoolss, lsarpc/lsass, netlogon,
+	samr, and FSRVP. Currently four daemons are available and they are
+	called:
 	<programlisting>
 		epmd
 		lsasd
 		spoolssd
+		fssd
 	</programlisting>
 	Example:
 	<programlisting>
diff --git a/python/samba/tests/docs.py b/python/samba/tests/docs.py
index d57701d47d0..3e7dcbc8e2f 100644
--- a/python/samba/tests/docs.py
+++ b/python/samba/tests/docs.py
@@ -131,7 +131,7 @@ class SmbDotConfTests(TestCase):
                          'queuepause command','lpresume command', 'lppause command',
                          'lprm command', 'lpq command', 'print command', 'template homedir',
                          'spoolss: os_major', 'spoolss: os_minor', 'spoolss: os_build',
-                         'max open files'])
+                         'max open files', 'fss: prune stale', 'fss: sequence timeout'])
 
     def setUp(self):
         super(SmbDotConfTests, self).setUp()