From: James Peach <jpeach@samba.org>
Date: Wed, 28 Feb 2007 19:53:33 +0000 (+0000)
Subject: Document the commit VFS module.
X-Git-Tag: samba-3.3.0pre1~1695
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=b8f5837a8de3c9b673ffaab427642fafa2661ec0;p=thirdparty%2Fsamba.git

Document the commit VFS module.
---

diff --git a/docs/manpages-3/smb-vfs-cacheprime.8.xml b/docs/manpages-3/smb-vfs-cacheprime.8.xml
index 0fa23cbf1ed..1aafec01981 100644
--- a/docs/manpages-3/smb-vfs-cacheprime.8.xml
+++ b/docs/manpages-3/smb-vfs-cacheprime.8.xml
@@ -49,9 +49,8 @@
 		<term>cacheprime:rsize = BYTES</term>
 		<listitem>
 		<para>The number of bytes with which to prime
-		the kernel data cache.
-		
-		The following suffixes may be applied to BYTES:</para>
+		the kernel data cache.</para>
+		<para>The following suffixes may be applied to BYTES:</para>
 		<itemizedlist>
 		<listitem><para><command>K</command> - BYTES is a number of kilobytes</para></listitem>
 		<listitem><para><command>M</command> - BYTES is a number of megabytes</para></listitem>
diff --git a/docs/manpages-3/smb-vfs-commit.8.xml b/docs/manpages-3/smb-vfs-commit.8.xml
new file mode 100644
index 00000000000..7650e75a977
--- /dev/null
+++ b/docs/manpages-3/smb-vfs-commit.8.xml
@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
+<refentry id="smb-vfs-commit.8">
+
+<refmeta>
+	<refentrytitle>smb-vfs-commit</refentrytitle>
+	<manvolnum>8</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+	<refname>commit</refname>
+	<refpurpose>flush dirty data at specified intervals</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+	<cmdsynopsis>
+		<command>vfs objects = commit</command>
+	</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+	<title>DESCRIPTION</title>
+
+	<para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
+	<manvolnum>7</manvolnum></citerefentry> suite.</para>
+
+	<para>The <command>commit</command> VFS module keeps track of
+	the amount of data written to a file and synchronizes it to
+	disk when a specified amount accumulates.
+	</para>
+
+	<para><command>commit</command> is useful in two
+	circumstances. First, if you have very precious data, the
+	impact of unexpected power loss can be minimized by a small
+	commit:dthresh value. Secondly, write performance can be
+	improved on some systems by flushing file data early and at
+	regular intervals.</para>
+
+	<para>This module is stackable.</para>
+
+</refsect1>
+
+
+<refsect1>
+	<title>OPTIONS</title>
+
+	<variablelist>
+
+		<varlistentry>
+		<term>commit:dthresh = BYTES</term>
+		<listitem>
+		<para>Synchronize file data each time the specified
+		number of bytes has been written.
+		</para>
+
+		<para>The following suffixes may be applied to BYTES:</para>
+		<itemizedlist>
+		<listitem><para><command>K</command> - BYTES is a number of kilobytes</para></listitem>
+		<listitem><para><command>M</command> - BYTES is a number of megabytes</para></listitem>
+		<listitem><para><command>G</command> - BYTES is a number of gigabytes</para></listitem>
+		</itemizedlist>
+
+		</listitem>
+		</varlistentry>
+
+	</variablelist>
+</refsect1>
+
+<refsect1>
+	<title>EXAMPLES</title>
+
+	<para>Synchronize the file data on the [precious] share after
+	every 512 kilobytes (524288 bytes) of data is written:</para>
+<programlisting>
+        <smbconfsection name="[precious]"/>
+	<smbconfoption name="path">/data/precious</smbconfoption>
+	<smbconfoption name="vfs objects">commit</smbconfoption>
+	<smbconfoption name="commit:dthresh">512K</smbconfoption>
+</programlisting>
+</refsect1>
+
+<refsect1>
+	<title>CAVEATS</title>
+	<para>On some systems, the data synchronization performed by
+	<command>commit</command> may reduce performance.
+	</para>
+</refsect1>
+
+<refsect1>
+	<title>VERSION</title>
+	<para>This man page is correct for version 3.0.25 of the Samba suite.
+	</para>
+</refsect1>
+
+<refsect1>
+	<title>AUTHOR</title>
+
+	<para>The original Samba software and related utilities
+	were created by Andrew Tridgell. Samba is now developed
+	by the Samba Team as an Open Source project similar
+	to the way the Linux kernel is developed.</para>
+
+</refsect1>
+
+</refentry>