docs: update kernel oplocks documentation
authorChristian Ambach <ambi@samba.org>
Fri, 30 Mar 2012 14:11:37 +0000 (16:11 +0200)
committerJeremy Allison <jra@samba.org>
Wed, 11 Apr 2012 18:11:39 +0000 (11:11 -0700)
Signed-off-by: Jeremy Allison <jra@samba.org>
docs-xml/smbdotconf/locking/kerneloplocks.xml

index c4f12b9bd425389647d550042e3ae7645849c814..9ac7256fb9f7592099be4af5947f134540f20f60 100644 (file)
@@ -1,11 +1,13 @@
 <samba:parameter name="kernel oplocks"
                                 type="boolean"
-                 context="G"
+                context="S"
                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
 <description>
        <para>For UNIXes that support kernel based <smbconfoption name="oplocks"/>
        (currently only IRIX and the Linux 2.4 kernel), this parameter 
-       allows the use of them to be turned on or off.</para>
+       allows the use of them to be turned on or off. However, this disables
+       Level II oplocks for clients as the Linux and IRIX kernels do not
+       support them properly.</para>
 
        <para>Kernel oplocks support allows Samba <parameter moreinfo="none">oplocks
        </parameter> to be broken whenever a local UNIX process or NFS operation 
@@ -13,6 +15,9 @@
        <manvolnum>8</manvolnum></citerefentry> has oplocked. This allows complete 
        data consistency between SMB/CIFS, NFS and local file access (and is 
        a <emphasis>very</emphasis> cool feature :-).</para>
+       <para>If you do not need this interaction, you should disable the
+       parameter on Linux and IRIX to get Level II oplocks and the associated
+       performance benefit.</para>
 
        <para>This parameter defaults to <constant>on</constant>, but is translated
        to a no-op on systems that no not have the necessary kernel support.