From d4bfded7d418e0e07108e329b57ff3f309ac731b Mon Sep 17 00:00:00 2001
From: Alexander Bokovoy <ab@samba.org>
Date: Thu, 17 May 2007 12:19:46 +0000
Subject: [PATCH] Document async I/O options

---
 docs/smbdotconf/tuning/aioreadsize.xml  | 22 ++++++++++++++++++++++
 docs/smbdotconf/tuning/aiowritesize.xml | 22 ++++++++++++++++++++++
 2 files changed, 44 insertions(+)
 create mode 100644 docs/smbdotconf/tuning/aioreadsize.xml
 create mode 100644 docs/smbdotconf/tuning/aiowritesize.xml

diff --git a/docs/smbdotconf/tuning/aioreadsize.xml b/docs/smbdotconf/tuning/aioreadsize.xml
new file mode 100644
index 00000000000..082cf5ddfde
--- /dev/null
+++ b/docs/smbdotconf/tuning/aioreadsize.xml
@@ -0,0 +1,22 @@
+<samba:parameter name="aio read size"
+                 context="S"
+		 type="integer"
+                 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
+    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>
+
+  <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>
+</samba:parameter>
diff --git a/docs/smbdotconf/tuning/aiowritesize.xml b/docs/smbdotconf/tuning/aiowritesize.xml
new file mode 100644
index 00000000000..e33a60e98e0
--- /dev/null
+++ b/docs/smbdotconf/tuning/aiowritesize.xml
@@ -0,0 +1,22 @@
+<samba:parameter name="aio write size"
+                 context="S"
+		 type="integer"
+                 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
+    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>
+  
+  <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>
+</samba:parameter>
-- 
2.47.3