summaryrefslogtreecommitdiff
path: root/docs-xml
diff options
context:
space:
mode:
authorJeremy Allison <jra@samba.org>2014-10-14 10:34:53 -0700
committerKarolin Seeger <kseeger@samba.org>2014-12-04 21:11:13 +0100
commit1e2a5435edbe9dbdf722dc5c0a4394697327fae6 (patch)
tree1c3b1cb5edb792befbdee146498a7030d502a824 /docs-xml
parentb93a2d4b5d45dddac34045d1f1cb02c994d387f2 (diff)
downloadsamba-1e2a5435edbe9dbdf722dc5c0a4394697327fae6.tar.gz
s3:param: Add "smb2 leases" parameter. Default "false".
This is currently marked as experimental! Signed-off-by: Jeremy Allison <jra@samba.org> Reviewed-by: Stefan Metzmacher <metze@samba.org> (cherry picked from commit 44d2612822a39b980fe2b85b2a780de2f3902155)
Diffstat (limited to 'docs-xml')
-rw-r--r--docs-xml/smbdotconf/locking/kerneloplocks.xml1
-rw-r--r--docs-xml/smbdotconf/locking/oplocks.xml1
-rw-r--r--docs-xml/smbdotconf/locking/smb2leases.xml28
3 files changed, 30 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/locking/kerneloplocks.xml b/docs-xml/smbdotconf/locking/kerneloplocks.xml
index 8e3bba51226..d8fe22321e9 100644
--- a/docs-xml/smbdotconf/locking/kerneloplocks.xml
+++ b/docs-xml/smbdotconf/locking/kerneloplocks.xml
@@ -25,5 +25,6 @@
<related>oplocks</related>
<related>level2 oplocks</related>
+<related>smb2 leases</related>
<value type="default">no</value>
</samba:parameter>
diff --git a/docs-xml/smbdotconf/locking/oplocks.xml b/docs-xml/smbdotconf/locking/oplocks.xml
index a56e9214104..a5e163ba74b 100644
--- a/docs-xml/smbdotconf/locking/oplocks.xml
+++ b/docs-xml/smbdotconf/locking/oplocks.xml
@@ -25,5 +25,6 @@
<related>kernel oplocks</related>
<related>level2 oplocks</related>
+<related>smb2 leases</related>
<value type="default">yes</value>
</samba:parameter>
diff --git a/docs-xml/smbdotconf/locking/smb2leases.xml b/docs-xml/smbdotconf/locking/smb2leases.xml
new file mode 100644
index 00000000000..0a734ec8e9f
--- /dev/null
+++ b/docs-xml/smbdotconf/locking/smb2leases.xml
@@ -0,0 +1,28 @@
+<samba:parameter name="smb2 leases"
+ context="G"
+ type="boolean"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>
+ This boolean option tells <command moreinfo="none">smbd</command> whether to
+ globally negotiate SMB2 leases on file open requests. Leasing is an SMB2-only
+ feature which allows clients to aggressively cache files locally above and
+ beyond the caching allowed by SMB1 oplocks. This (experimental) parameter is
+ set to off by default until the SMB2 leasing code is declared fully stable.
+ </para>
+
+ <para>
+ This is only available with <smbconfoption name="oplocks">yes</smbconfoption>
+ and <smbconfoption name="kernel oplocks">no</smbconfoption>.
+ </para>
+
+ <para>
+ The Samba implementation of leases is currently marked as experimental!
+ </para>
+</description>
+
+<related>oplocks</related>
+<related>kernel oplocks</related>
+<related>level2 oplocks</related>
+<value type="default">no</value>
+</samba:parameter>