docs-xml: add "smbd max async dosmode"
authorRalph Boehme <slow@samba.org>
Sun, 2 Dec 2018 08:22:56 +0000 (09:22 +0100)
committerJeremy Allison <jra@samba.org>
Thu, 6 Dec 2018 00:43:13 +0000 (01:43 +0100)
The parameter is added to the lists of ignored-paremteres in the
samba.docs tests, as the given default "aio max threads * 2" works only
as manpage string.

"aio max threads" can only be calculated at run time and requires a
handle to a pthreadpool_tevent which loadparm will never have.

Because of that lp_smbd_max_async_dosmode() will always return 0 as
default and it's up to the caller to calculate "aio max threads * 2" if
lp_smbd_max_async_dosmode() returns 0. Cf the next commit.

Signed-off-by: Ralph Boehme <slow@samba.org>
Reviewed-by: Jeremy Allison <jra@samba.org>
docs-xml/smbdotconf/misc/smbdmaxasyncdosmode.xml [new file with mode: 0644]
python/samba/tests/docs.py

diff --git a/docs-xml/smbdotconf/misc/smbdmaxasyncdosmode.xml b/docs-xml/smbdotconf/misc/smbdmaxasyncdosmode.xml
new file mode 100644 (file)
index 0000000..b375298
--- /dev/null
@@ -0,0 +1,12 @@
+<samba:parameter name="smbd max async dosmode"
+                 context="S"
+                 type="integer"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+       <para>
+         This parameter controls how many async operations to fetch the DOS
+         attributes the fileserver will queue when doing directory listings.
+       </para>
+</description>
+<value type="default">aio max threads * 2</value>
+</samba:parameter>
index b64f9726367131fddb8b7b5329787decf2100537..b6c15b7d8def9f948ea0895b4f7fdccf61bfa3a6 100644 (file)
@@ -125,6 +125,7 @@ class SmbDotConfTests(TestCase):
         'include system krb5 conf',
         'rpc server dynamic port range',
         'mit kdc command',
+        'smbd max async dosmode',
     ])
 
     def setUp(self):
@@ -247,6 +248,7 @@ class SmbDotConfTests(TestCase):
             exceptions = set([
                 'printing',
                 'rpc server dynamic port range',
+                'smbd max async dosmode',
             ])
 
             if param in exceptions: