Moving docs tree to docs-xml to make room for generated docs in the release tarball.
[sfrench/samba-autobuild/.git] / docs-xml / smbdotconf / locking / kerneloplocks.xml
1 <samba:parameter name="kernel oplocks"
2                                  type="boolean"
3                  context="G"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6         <para>For UNIXes that support kernel based <smbconfoption name="oplocks"/>
7         (currently only IRIX and the Linux 2.4 kernel), this parameter 
8         allows the use of them to be turned on or off.</para>
9
10         <para>Kernel oplocks support allows Samba <parameter moreinfo="none">oplocks
11         </parameter> to be broken whenever a local UNIX process or NFS operation 
12         accesses a file that <citerefentry><refentrytitle>smbd</refentrytitle>
13         <manvolnum>8</manvolnum></citerefentry> has oplocked. This allows complete 
14         data consistency between SMB/CIFS, NFS and local file access (and is 
15         a <emphasis>very</emphasis> cool feature :-).</para>
16
17         <para>This parameter defaults to <constant>on</constant>, but is translated
18         to a no-op on systems that no not have the necessary kernel support.
19         You should never need to touch this parameter.</para>
20 </description>
21
22 <related>oplocks</related>
23 <related>level2 oplocks</related>
24 <value type="default">yes</value>
25 </samba:parameter>