From: Jeremy Allison <jra@samba.org>
Date: Fri, 2 Nov 2007 21:54:22 +0000 (+0000)
Subject: Add "min receivefile size" docs.
X-Git-Tag: samba-3.3.0pre1~1553
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3a8e086d240668bc5093c33506e0ed0a22557d4d;p=thirdparty%2Fsamba.git

Add "min receivefile size" docs.
Jeremy.
---

diff --git a/docs/smbdotconf/protocol/minreceivefilesize.xml b/docs/smbdotconf/protocol/minreceivefilesize.xml
new file mode 100644
index 00000000000..7c31e6b86cd
--- /dev/null
+++ b/docs/smbdotconf/protocol/minreceivefilesize.xml
@@ -0,0 +1,22 @@
+<samba:parameter name="min receivefile size"
+		type="integer"
+		context="G"
+		advanced="1" developer="1"
+		xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+<para>This option changes the behavior of <citerefentry><refentrytitle>smbd</refentrytitle>
+<manvolnum>8</manvolnum></citerefentry> when processing SMBwriteX calls. Any incoming
+SMBwriteX call on a non-signed SMB/CIFS connection greater than this value will not be processed in the normal way but will
+be passed to any underlying kernel recvfile or splice system call (if there is no such
+call Samba will emulate in user space). This allows zero-copy writes directly from network
+socket buffers into the filesystem buffer cache, if available. It may improve performance
+but user testing is recommended. If set to zero Samba processes SMBwriteX calls in the
+normal way. To enable POSIX large write support (SMB/CIFS writes up to 16Mb) this option must be
+nonzero.</para>
+<para>Note this option will have NO EFFECT if set on a SMB signed connection.</para>
+<para>The default is zero, which diables this option.</para>
+</description>
+
+<related>min receivefile size</related>
+<value type="default">0</value>
+</samba:parameter>