summaryrefslogtreecommitdiff
path: root/docs-xml
diff options
context:
space:
mode:
authorSimo Sorce <idra@samba.org>2010-07-19 13:48:31 -0400
committerSimo Sorce <idra@samba.org>2010-07-19 13:48:31 -0400
commitf9f3358348229b14d368316e327cfd2a4cb48c7c (patch)
tree9fb61c2ed61dd1ff93a64fc4498a4ec8d3a0607d /docs-xml
parent7e4de49bfceed18c81abf93703a61d0a22617a24 (diff)
parent630a2eb68af0d523a1bb4451bbaa75d2ba47d252 (diff)
downloadsamba-f9f3358348229b14d368316e327cfd2a4cb48c7c.tar.gz
samba-f9f3358348229b14d368316e327cfd2a4cb48c7c.tar.bz2
samba-f9f3358348229b14d368316e327cfd2a4cb48c7c.zip
Merge branch 'master' of ssh://git.samba.org/data/git/samba
Diffstat (limited to 'docs-xml')
-rw-r--r--docs-xml/smbdotconf/misc/ctdblocktimewarnthreshold.xml26
-rw-r--r--docs-xml/smbdotconf/misc/logwriteablefilesonexit.xml15
-rw-r--r--docs-xml/smbdotconf/security/usernamemapcachetime.xml23
-rw-r--r--docs-xml/smbdotconf/tuning/smb2maxread.xml13
-rw-r--r--docs-xml/smbdotconf/tuning/smb2maxtrans.xml13
-rw-r--r--docs-xml/smbdotconf/tuning/smb2maxwrite.xml13
6 files changed, 46 insertions, 57 deletions
diff --git a/docs-xml/smbdotconf/misc/ctdblocktimewarnthreshold.xml b/docs-xml/smbdotconf/misc/ctdblocktimewarnthreshold.xml
index 149d8d67e3..a3289a93bc 100644
--- a/docs-xml/smbdotconf/misc/ctdblocktimewarnthreshold.xml
+++ b/docs-xml/smbdotconf/misc/ctdblocktimewarnthreshold.xml
@@ -4,13 +4,25 @@
advanced="1"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
- <para>In a cluster, ctdb is very unhappy if tdb database locks
- are held for extended periods of time. This parameter adds a
- warning threshold in milliseconds. If Samba holds a lock for
- longer that ctdb locktime warn threshold milliseconds, a debug
- level 0 message is printed when the lock is released. This is
- mainly a debugging aid for post-mortem analysis.</para>
- <para>If this parameter is set to 0, no message is printed.</para>
+
+ <para>
+ In a cluster environment using Samba and ctdb it is critical
+ that locks on central ctdb-hosted databases like locking.tdb
+ are not held for long. With the current Samba architecture
+ it happens that Samba takes a lock and while holding that
+ lock makes file system calls into the shared cluster file
+ system. This option makes Samba warn if it detects that it
+ has held locks for the specified number of milliseconds. If
+ this happens, <emphasis>smbd</emphasis> will emit a debug level 0
+ message into its logs and potentially into syslog. The most likely
+ reason for such a log message is that an operation of the cluster
+ file system Samba exports is taking longer than expected.
+ The messages are meant as a debugging aid for potential
+ cluster problems.
+ </para>
+
+ <para>The default value of 0 disables this logging.</para>
+
</description>
<value type="default">0</value>
</samba:parameter>
diff --git a/docs-xml/smbdotconf/misc/logwriteablefilesonexit.xml b/docs-xml/smbdotconf/misc/logwriteablefilesonexit.xml
index 1c75457803..9d2b750943 100644
--- a/docs-xml/smbdotconf/misc/logwriteablefilesonexit.xml
+++ b/docs-xml/smbdotconf/misc/logwriteablefilesonexit.xml
@@ -5,10 +5,17 @@
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
<para>
- This boolean option controls whether at exit time the server
- dumps a list of files with debug level 0 that were still open
- for write. This is an administrative aid to find the files
- that were potentially corrupt if the network connection died.
+ When the network connection between a CIFS client and Samba
+ dies, Samba has no option but to simply shut down the server
+ side of the network connection. If this happens, there is a
+ risk of data corruption because the Windows client did not
+ complete all write operations that the Windows application
+ requested. Setting this option to "yes" makes smbd log with
+ a level 0 message a list of all files that have been opened
+ for writing when the network connection died. Those are the
+ files that are potentially corrupted. It is meant as an aid
+ for the administrator to give him a list of files to do
+ consistency checks on.
</para>
</description>
diff --git a/docs-xml/smbdotconf/security/usernamemapcachetime.xml b/docs-xml/smbdotconf/security/usernamemapcachetime.xml
index 5461cb1a6c..4361b1896d 100644
--- a/docs-xml/smbdotconf/security/usernamemapcachetime.xml
+++ b/docs-xml/smbdotconf/security/usernamemapcachetime.xml
@@ -4,13 +4,22 @@
type="integer"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
- <para>This option controls if and how long the result of the
- <smbconfoption name="username map"/> and
- <smbconfoption name="username map script"/> across smbds in gencache.
- If set to non-zero, it denotes the number of seconds the output of
- both mappings will be cached.</para>
- <para>This option is mainly useful for heavy-weight
- <smbconfoption name="username map script"/> scripts.</para>
+ <para>
+ Mapping usernames with the <smbconfoption name="username map"/>
+ or <smbconfoption name="username map script"/>
+ features of Samba can be relatively expensive.
+ During login of a user, the mapping is done several times.
+ In particular, calling the <smbconfoption name="username map script"/>
+ can slow down logins if external databases have to be queried from
+ the script being called.
+ </para>
+
+ <para>
+ The parameter <smbconfoption name="username map cache time"/>
+ controls a mapping cache. It specifies the number of seconds a
+ mapping from the username map file or script is to be efficiently cached.
+ The default of 0 means no caching is done.
+ </para>
</description>
<value type="default">0</value>
diff --git a/docs-xml/smbdotconf/tuning/smb2maxread.xml b/docs-xml/smbdotconf/tuning/smb2maxread.xml
deleted file mode 100644
index a3abbbc4ca..0000000000
--- a/docs-xml/smbdotconf/tuning/smb2maxread.xml
+++ /dev/null
@@ -1,13 +0,0 @@
-<samba:parameter name="smb2 max read"
- context="G"
- advanced="1" developer="1"
- xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
-<description>
- <para>This sets the maximum read size in bytes for a single SMB2 read request.
- It exists to allow the Samba developers to experiment with different
- size requests for tuning purposes.
- </para>
-</description>
-
-<value type="default">65536</value>
-</samba:parameter>
diff --git a/docs-xml/smbdotconf/tuning/smb2maxtrans.xml b/docs-xml/smbdotconf/tuning/smb2maxtrans.xml
deleted file mode 100644
index 4e6fee0e75..0000000000
--- a/docs-xml/smbdotconf/tuning/smb2maxtrans.xml
+++ /dev/null
@@ -1,13 +0,0 @@
-<samba:parameter name="smb2 max trans"
- context="G"
- advanced="1" developer="1"
- xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
-<description>
- <para>This sets the maximum read size in bytes for a single SMB2 transact request.
- It exists to allow the Samba developers to experiment with different
- size requests for tuning purposes.
- </para>
-</description>
-
-<value type="default">65536</value>
-</samba:parameter>
diff --git a/docs-xml/smbdotconf/tuning/smb2maxwrite.xml b/docs-xml/smbdotconf/tuning/smb2maxwrite.xml
deleted file mode 100644
index 5085dba435..0000000000
--- a/docs-xml/smbdotconf/tuning/smb2maxwrite.xml
+++ /dev/null
@@ -1,13 +0,0 @@
-<samba:parameter name="smb2 max write"
- context="G"
- advanced="1" developer="1"
- xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
-<description>
- <para>This sets the maximum read size in bytes for a single SMB2 write request.
- It exists to allow the Samba developers to experiment with different
- size requests for tuning purposes.
- </para>
-</description>
-
-<value type="default">65536</value>
-</samba:parameter>