Change dfree command to be a share level parameter.
authorJeremy Allison <jra@samba.org>
Wed, 19 Oct 2005 21:06:01 +0000 (21:06 +0000)
committerGerald W. Carter <jerry@samba.org>
Wed, 23 Apr 2008 14:01:08 +0000 (09:01 -0500)
Add docs for dfree cache time.
Jeremy.

docs/smbdotconf/misc/dfreecachetime.xml [new file with mode: 0644]
docs/smbdotconf/misc/dfreecommand.xml

diff --git a/docs/smbdotconf/misc/dfreecachetime.xml b/docs/smbdotconf/misc/dfreecachetime.xml
new file mode 100644 (file)
index 0000000..96088bb
--- /dev/null
@@ -0,0 +1,27 @@
+<samba:parameter name="dfree cache time"
+                context="S"
+                        type="integer"
+                advanced="1" developer="1"
+                xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+
+       <para>The <parameter moreinfo="none">dfree cache time</parameter>
+       should only be used on systems where a problem occurs with the
+       internal disk space calculations. This has been known to happen
+       with Ultrix, but may occur with other operating systems. The
+       symptom that was seen was an error of &quot;Abort Retry
+       Ignore&quot; at the end of each directory listing.</para>
+
+       <para>This is a new parameter introduced in Samba version 3.0.21.
+       It specifies in seconds the time that smbd will cache the output
+       of a disk free query. If set to zero (the default) no caching is
+       done. This allows a heavily loaded server to prevent rapid spawning
+       of <smbconfoption name="dfree command"/>dfree command scripts
+       increasing the load.
+       </para>
+
+</description>
+<value type="default"><comment>By default this parameter is zero, meaning no caching
+               will be done.</comment></value>
+<value type="example">dfree cache time = 60</value>
+</samba:parameter>
index 4a9de5c84d9ec596bba9bfade4130f76aaff94a3..be5f00aabd1b9662f01895c8f4deb819cd90b569 100644 (file)
@@ -1,5 +1,5 @@
 <samba:parameter name="dfree command"
-                context="G"
+                context="S"
                         type="string"
                 advanced="1" developer="1"
                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
        with Ultrix, but may occur with other operating systems. The
        symptom that was seen was an error of &quot;Abort Retry
        Ignore&quot; at the end of each directory listing.</para>
-               
+
        <para>This setting allows the replacement of the internal routines to
        calculate the total disk space and amount available with an external
        routine. The example below gives a possible script that might fulfill
        this function.</para>
 
+       <para>In Samba version 3.0.21 this parameter has been changed to be
+       a per-share parameter, and in addition the parameter
+       <smbconfoption name="dfree cache time"/>dfree cache time was added
+       to allow the output of this script to be cached for systems under
+       heavy load.
+       </para>
+
        <para>The external program will be passed a single parameter indicating 
        a directory in the filesystem being queried. This will typically consist
        of the string <filename moreinfo="none">./</filename>. The script should return two