Moving docs tree to docs-xml to make room for generated docs in the release tarball.

(This used to be commit 9f672c26d63955f613088489c6efbdc08b5b2d14)

1 files changed, 28 insertions, 0 deletions

diff --git a/docs-xml/smbdotconf/tuning/writecachesize.xml b/docs-xml/smbdotconf/tuning/writecachesize.xml
new file mode 100644
index 00000000000..12965b40487
--- /dev/null
+++ b/docs-xml/smbdotconf/tuning/writecachesize.xml
@@ -0,0 +1,28 @@
+<samba:parameter name="write cache size"
+                 context="S"
+				 type="integer"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+    <para>If this integer parameter is set to non-zero value,
+    Samba will create an in-memory cache for each oplocked file 
+    (it does <emphasis>not</emphasis> do this for 
+    non-oplocked files). All writes that the client does not request 
+    to be flushed directly to disk will be stored in this cache if possible. 
+    The cache is flushed onto disk when a write comes in whose offset 
+    would not fit into the cache or when the file is closed by the client. 
+    Reads for the file are also served from this cache if the data is stored 
+    within it.</para>
+
+    <para>This cache allows Samba to batch client writes into a more 
+    efficient write size for RAID disks (i.e. writes may be tuned to 
+    be the RAID stripe size) and can improve performance on systems 
+    where the disk subsystem is a bottleneck but there is free 
+    memory for userspace programs.</para>
+
+    <para>The integer parameter specifies the size of this cache 
+		(per oplocked file) in bytes.</para>
+</description>
+
+<value type="default">0</value>
+<value type="example">262144<comment> for a 256k cache size per file</comment></value>
+</samba:parameter>