From: Volker Lendecke <vl@samba.org>
Date: Mon, 20 Nov 2017 16:18:44 +0000 (+0100)
Subject: docs: Fix the "aio r/w size" smb.conf entries
X-Git-Tag: talloc-2.1.11~424
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8212c34ae409f64615a53f9665134a3e7a04312d;p=thirdparty%2Fsamba.git

docs: Fix the "aio r/w size" smb.conf entries

Signed-off-by: Volker Lendecke <vl@samba.org>
Reviewed-by: Jeremy Allison <jra@samba.org>

Autobuild-User(master): Volker Lendecke <vl@samba.org>
Autobuild-Date(master): Tue Nov 21 15:45:20 CET 2017 on sn-devel-144
---

diff --git a/docs-xml/smbdotconf/tuning/aioreadsize.xml b/docs-xml/smbdotconf/tuning/aioreadsize.xml
index 0c9cc529ed8..c6028b8f9ac 100644
--- a/docs-xml/smbdotconf/tuning/aioreadsize.xml
+++ b/docs-xml/smbdotconf/tuning/aioreadsize.xml
@@ -3,20 +3,17 @@
                  type="bytes"
                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
 <description>
-  <para>If Samba has been built with asynchronous I/O support and this
-    integer parameter is set to non-zero value,
-    Samba will read from file asynchronously when size of request is bigger
+  <para>If this integer parameter is set to a non-zero value,
+    Samba will read from files asynchronously when the request size is bigger
     than this value. Note that it happens only for non-chained and non-chaining
     reads and when not using write cache.</para>
-
-  <para>Current implementation of asynchronous I/O in Samba 3.0 does support
-    only up to 10 outstanding asynchronous requests, read and write combined.</para>
-
+  <para>The only reasonable values for this parameter are 0 (no async I/O) and
+    1 (always do async I/O).</para>
   <related>write cache size</related>
   <related>aio write size</related>
 </description>
 
 <value type="default">0</value>
-<value type="example">16384<comment> Use asynchronous I/O for reads bigger than 16KB
-    request size</comment></value>
+<value type="example">1<comment>Always do reads asynchronously
+  </comment></value>
 </samba:parameter>
diff --git a/docs-xml/smbdotconf/tuning/aiowritesize.xml b/docs-xml/smbdotconf/tuning/aiowritesize.xml
index c2ad118def0..8f42284111e 100644
--- a/docs-xml/smbdotconf/tuning/aiowritesize.xml
+++ b/docs-xml/smbdotconf/tuning/aiowritesize.xml
@@ -3,20 +3,22 @@
                  type="bytes"
                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
 <description>
-  <para>If Samba has been built with asynchronous I/O support and this
-    integer parameter is set to non-zero value,
-    Samba will write to file asynchronously when size of request is bigger
+  <para>If this integer parameter is set to a non-zero value,
+    Samba will write to files asynchronously when the request size is bigger
     than this value. Note that it happens only for non-chained and non-chaining
     reads and when not using write cache.</para>
-
-  <para>Current implementation of asynchronous I/O in Samba 3.0 does support
-    only up to 10 outstanding asynchronous requests, read and write combined.</para>
+  <para>The only reasonable values for this parameter are 0 (no async I/O) and
+    1 (always do async I/O).</para>
+  <para>Compared to <smbconfoption name="aio read size"/> this parameter has
+    a smaller effect, most writes should end up in the
+    file system cache. Writes that require space allocation might
+    benefit most from going asynchronous.</para>
   
   <related>write cache size</related>
   <related>aio read size</related>
 </description>
 
 <value type="default">0</value>
-<value type="example">16384<comment> Use asynchronous I/O for writes bigger than 16KB
-    request size</comment></value>
+<value type="example">1<comment>Always do writes asynchronously
+    </comment></value>
 </samba:parameter>