[SCM] Samba Shared Repository - branch master updated
Jeremy Allison
jra at samba.org
Mon Aug 19 20:20:03 MDT 2013
The branch, master has been updated
via 1808316 docs: Fix variable list in man vfs_crossrename.
via 3e11421 Man pages for ntdb tools missing
from 4f96d57 libsmb: Fix a bunch of Coverity IDs
http://gitweb.samba.org/?p=samba.git;a=shortlog;h=master
- Log -----------------------------------------------------------------
commit 1808316b1245290fd4a4aa87a801410899e4c1e3
Author: Karolin Seeger <kseeger at samba.org>
Date: Tue Aug 13 11:04:50 2013 +0200
docs: Fix variable list in man vfs_crossrename.
The varlist entries need a paragraph, otherwise the list is broken and the list
entries end with ".RE".
Fix bug #10076 - varlist in man vfs_crossrename broken.
Signed-off-by: Karolin Seeger <kseeger at samba.org>
Reviewed-by: Jeremy Allison <jra at samba.org>
Autobuild-User(master): Jeremy Allison <jra at samba.org>
Autobuild-Date(master): Tue Aug 20 04:19:42 CEST 2013 on sn-devel-104
commit 3e11421e7476d968a3d550491279d0ad6b6c398f
Author: Rusty Russell <rusty at rustcorp.com.au>
Date: Thu Aug 15 12:32:06 2013 +0930
Man pages for ntdb tools missing
Copied and modified from tdb man pages. Avoided reproducing API documentation
which is extensively documented in the ntdb.h header already.
BUG: https://bugzilla.samba.org/show_bug.cgi?id=10000
Signed-off-by: Rusty Russell <rusty at rustcorp.com.au>
Reviewed-by: Jeremy Allison <jra at samba.org>
-----------------------------------------------------------------------
Summary of changes:
docs-xml/manpages/vfs_crossrename.8.xml | 20 ++--
lib/ntdb/man/ntdb.3.xml | 132 ++++++++++++++++++++
.../tdbbackup.8.xml => ntdb/man/ntdbbackup.8.xml} | 55 +++++----
.../man/tdbdump.8.xml => ntdb/man/ntdbdump.8.xml} | 37 +++---
.../man/ntdbrestore.8.xml} | 38 ++++---
.../man/tdbtool.8.xml => ntdb/man/ntdbtool.8.xml} | 46 ++++---
lib/ntdb/wscript | 13 ++-
7 files changed, 252 insertions(+), 89 deletions(-)
create mode 100644 lib/ntdb/man/ntdb.3.xml
copy lib/{tdb/man/tdbbackup.8.xml => ntdb/man/ntdbbackup.8.xml} (64%)
copy lib/{tdb/man/tdbdump.8.xml => ntdb/man/ntdbdump.8.xml} (67%)
copy lib/{tdb/man/tdbrestore.8.xml => ntdb/man/ntdbrestore.8.xml} (50%)
copy lib/{tdb/man/tdbtool.8.xml => ntdb/man/ntdbtool.8.xml} (83%)
Changeset truncated at 500 lines:
diff --git a/docs-xml/manpages/vfs_crossrename.8.xml b/docs-xml/manpages/vfs_crossrename.8.xml
index 409a34f..b8f7faa 100644
--- a/docs-xml/manpages/vfs_crossrename.8.xml
+++ b/docs-xml/manpages/vfs_crossrename.8.xml
@@ -37,28 +37,30 @@
NT_STATUS_NOT_SAME_DEVICE and the client has to move the file by
manual copy and delete operations. If the rename by copy is done by the
server this can be much more efficient. vfs_crossrename tries to do
- this server-side cross-device rename operation. There are however
- limitations that this module currently does not solve:
+ this server-side cross-device rename operation.
+ </para>
+
+ <para>There are however limitations that this module currently does not
+ solve:</para>
<variablelist>
<varlistentry>
- the ACLs of files are not preserved
+ <para>The ACLs of files are not preserved,</para>
</varlistentry>
<varlistentry>
- meta data in EAs are not preserved
+ <para>meta data in EAs are not preserved,</para>
</varlistentry>
<varlistentry>
- renames of whole subdirectories cannot be done recursively,
+ <para>renames of whole subdirectories cannot be done recursively,
in that case we still return STATUS_NOT_SAME_DEVICE and
- let the client decide what to do
+ let the client decide what to do,</para>
</varlistentry>
<varlistentry>
- rename operations of huge files can cause hangs on the
+ <para>rename operations of huge files can cause hangs on the
client because clients expect a rename operation to
- return fast
+ return fast.</para>
</varlistentry>
</variablelist>
- </para>
<para>This module is stackable.</para>
diff --git a/lib/ntdb/man/ntdb.3.xml b/lib/ntdb/man/ntdb.3.xml
new file mode 100644
index 0000000..79f8937
--- /dev/null
+++ b/lib/ntdb/man/ntdb.3.xml
@@ -0,0 +1,132 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<refentry>
+ <refmeta>
+ <refentrytitle>ntdb</refentrytitle>
+ <manvolnum>3</manvolnum>
+ <refmiscinfo class="source">Samba</refmiscinfo>
+ <refmiscinfo class="manual">System Administration tools</refmiscinfo>
+ <refmiscinfo class="version">4.0</refmiscinfo>
+ </refmeta>
+ <refnamediv>
+ <refname>ntdb</refname>
+<refpurpose>A not-so trivial keyword/data database system</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+<synopsis>#include <ntdb.h></synopsis>
+ </refsynopsisdiv>
+ <refsect1><title>DESCRIPTION</title>
+ <para>
+ If you have previously used the tdb library from Samba, much of
+ this will seem familiar, but there are some API changes which a
+ compiler will warn you about if you simply replace 'tdb' with
+ 'ntdb' in your code! The on-disk format for ntdb is
+ incompatible with tdb.
+ </para>
+ <para>
+ tdb's API was based on gdbm, and ntdb continues this tradition,
+ with enhancements. A differences guide is available in the text
+ file <filename>lib/ntdb/doc/TDB_porting.txt</filename> in the
+ SAMBA source tree.
+ </para>
+ </refsect1>
+ <refsect1><title>NTDB API OVERVIEW</title>
+ <para>
+ The complete API is documented in the ntdb.h header, which is
+ kept up-to-date and recommended reading.
+ </para>
+ <para>
+ Normal usage is to call ntdb_open() to create or open an ntdb
+ file. ntdb_store() is used to add records, ntdb_fetch() is used
+ to fetch them. Traversals are supported via callback
+ (ntdb_traverse()) or iteration (ntdb_firstkey() and
+ ntdb_nextkey()). Transactions are supported for batching
+ updates or reads atomically, using ntdb_transaction_start() and
+ ntdb_transaction_commit().
+ </para>
+ <refsect2><title>Use With Talloc</title>
+ <para>
+ ntdb_open() takes an optional linked list of attributes:
+ in particular you can specify an alternate allocator (such as
+ talloc):
+ </para>
+ <programlisting>
+#include <talloc.h>
+#include <ntdb.h>
+
+static void *my_alloc(const void *owner, size_t len, void *priv)
+{
+ return talloc_size(owner, len);
+}
+
+static void *my_expand(void *old, size_t newlen, void *priv)
+{
+ return talloc_realloc_size(NULL, old, newlen);
+}
+
+static void my_free(void *old, void *priv)
+{
+ talloc_free(old);
+}
+
+/* This opens an ntdb file as a talloc object with given parent. */
+struct ntdb_context *ntdb_open_talloc(const void *parent,
+ const char *filename)
+{
+ struct ntdb_context *ntdb;
+ union ntdb_attribute alloc;
+
+ alloc.base.attr = NTDB_ATTRIBUTE_ALLOCATOR;
+ alloc.base.next = NULL;
+ alloc.alloc.alloc = my_alloc;
+ alloc.alloc.expand = my_expand;
+ alloc.alloc.free = my_free;
+
+ ntdb = ntdb_open(filename, NTDB_DEFAULT, O_RDWR|O_CREAT, 0600,
+ &alloc);
+ if (ntdb) {
+ talloc_steal(parent, ntdb);
+ talloc_set_name(ntdb, "%s", filename);
+ }
+ return ntdb;
+}
+</programlisting>
+ </refsect2>
+ </refsect1>
+ <refsect1><title>SEE ALSO</title>
+ <para>
+ <ulink url="http://tdb.samba.org/"/>
+ </para>
+ </refsect1>
+
+ <refsect1><title>AUTHOR</title>
+ <para> The original tdb software was created by Andrew Tridgell, and
+ is now developed by the
+ Samba Team as an Open Source project similar to the way the
+ Linux kernel is developed. ntdb was derived from tdb, but mostly
+ rewritten by Rusty Russell.
+ </para>
+ </refsect1>
+
+ <refsect1><title>COPYRIGHT/LICENSE</title>
+ <para>
+ Copyright (C) Rusty Russell 2013, IBM Corporation
+ </para>
+ <para>
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as
+ published by the Free Software Foundation; either version 3 of the
+ License, or (at your option) any later version.
+ </para>
+ <para>
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+ </para>
+ <para>
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, see http://www.gnu.org/licenses/.
+ </para>
+ </refsect1>
+</refentry>
diff --git a/lib/tdb/man/tdbbackup.8.xml b/lib/ntdb/man/ntdbbackup.8.xml
similarity index 64%
copy from lib/tdb/man/tdbbackup.8.xml
copy to lib/ntdb/man/ntdbbackup.8.xml
index f24202e..977c0f7 100644
--- a/lib/tdb/man/tdbbackup.8.xml
+++ b/lib/ntdb/man/ntdbbackup.8.xml
@@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-<refentry id="tdbbackup.8">
+<refentry id="ntdbbackup.8">
<refmeta>
- <refentrytitle>tdbbackup</refentrytitle>
+ <refentrytitle>ntdbbackup</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="source">Samba</refmiscinfo>
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
- <refmiscinfo class="version">3.6</refmiscinfo>
+ <refmiscinfo class="version">4.0</refmiscinfo>
</refmeta>
<refnamediv>
- <refname>tdbbackup</refname>
- <refpurpose>tool for backing up and for validating the integrity of samba .tdb files</refpurpose>
+ <refname>ntdbbackup</refname>
+ <refpurpose>tool for backing up and for validating the integrity of samba .ntdb files</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>tdbbackup</command>
+ <command>ntdbbackup</command>
<arg choice="opt">-s suffix</arg>
<arg choice="opt">-v</arg>
<arg choice="opt">-h</arg>
@@ -31,8 +31,8 @@
<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> suite.</para>
- <para><command>tdbbackup</command> is a tool that may be used to backup samba .tdb
- files. This tool may also be used to verify the integrity of the .tdb files prior
+ <para><command>ntdbbackup</command> is a tool that may be used to backup samba .ntdb
+ files. This tool may also be used to verify the integrity of the .ntdb files prior
to samba startup or during normal operation. If it finds file damage and it finds
a prior backup the backup file will be restored.
</para>
@@ -55,7 +55,7 @@
<term>-s suffix</term>
<listitem><para>
The <command>-s</command> option allows the administrator to specify a file
- backup extension. This way it is possible to keep a history of tdb backup
+ backup extension. This way it is possible to keep a history of ntdb backup
files by using a new suffix for each backup.
</para> </listitem>
</varlistentry>
@@ -78,42 +78,42 @@
<para><emphasis>GENERAL INFORMATION</emphasis></para>
<para>
- The <command>tdbbackup</command> utility can safely be run at any time. It was designed so
- that it can be used at any time to validate the integrity of tdb files, even during Samba
+ The <command>ntdbbackup</command> utility can safely be run at any time. It was designed so
+ that it can be used at any time to validate the integrity of ntdb files, even during Samba
operation. Typical usage for the command will be:
</para>
- <para>tdbbackup [-s suffix] *.tdb</para>
+ <para>ntdbbackup [-s suffix] *.ntdb</para>
<para>
- Before restarting samba the following command may be run to validate .tdb files:
+ Before restarting samba the following command may be run to validate .ntdb files:
</para>
- <para>tdbbackup -v [-s suffix] *.tdb</para>
+ <para>ntdbbackup -v [-s suffix] *.ntdb</para>
<para>
- Note that Samba 4 can use .ntdb files instead, so you should
- use <command>ntdbbackup</command> on those files.
+ Note that Samba 4 can use .tdb files instead, so you should
+ use <command>tdbbackup</command> on those files.
</para>
<para>
- Samba .tdb files are stored in various locations, be sure to run backup all
- .tdb file on the system. Important files includes:
+ Samba .tdb and .ntdb files are stored in various locations, be sure to run backup all
+ .(n)tdb files on the system. Important files includes:
</para>
<itemizedlist>
<listitem><para>
- <command>secrets.tdb</command> - usual location is in the /usr/local/samba/private
+ <command>secrets.(n)tdb</command> - usual location is in the /usr/local/samba/private
directory, or on some systems in /etc/samba.
</para></listitem>
<listitem><para>
- <command>passdb.tdb</command> - usual location is in the /usr/local/samba/private
+ <command>passdb.(n)tdb</command> - usual location is in the /usr/local/samba/private
directory, or on some systems in /etc/samba.
</para></listitem>
<listitem><para>
- <command>*.tdb</command> located in the /usr/local/samba/var directory or on some
+ <command>*.tdb</command> and <command>*.ntdb</command> located in the /usr/local/samba/var directory or on some
systems in the /var/cache or /var/lib/samba directories.
</para></listitem>
</itemizedlist>
@@ -123,7 +123,15 @@
<refsect1>
<title>VERSION</title>
- <para>This man page is correct for version 3 of the Samba suite.</para>
+ <para>This man page is correct for version 4 of the Samba suite.</para>
+</refsect1>
+
+<refsect1>
+ <title>SEE ALSO</title>
+
+ <para>
+ tdbbackup(8), ntdbrestore(8)
+ </para>
</refsect1>
<refsect1>
@@ -135,7 +143,8 @@
the Linux kernel is developed.
</para>
- <para>The tdbbackup man page was written by John H Terpstra.</para>
+ <para>The ntdbbackup man page was written by Rusty Russell,
+ based on the tdbbackup man page by John H Terpstra.</para>
</refsect1>
</refentry>
diff --git a/lib/tdb/man/tdbdump.8.xml b/lib/ntdb/man/ntdbdump.8.xml
similarity index 67%
copy from lib/tdb/man/tdbdump.8.xml
copy to lib/ntdb/man/ntdbdump.8.xml
index 25fd432..ee1711a 100644
--- a/lib/tdb/man/tdbdump.8.xml
+++ b/lib/ntdb/man/ntdbdump.8.xml
@@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-<refentry id="tdbdump.8">
+<refentry id="ntdbdump.8">
<refmeta>
- <refentrytitle>tdbdump</refentrytitle>
+ <refentrytitle>ntdbdump</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="source">Samba</refmiscinfo>
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
- <refmiscinfo class="version">3.6</refmiscinfo>
+ <refmiscinfo class="version">4.0</refmiscinfo>
</refmeta>
<refnamediv>
- <refname>tdbdump</refname>
- <refpurpose>tool for printing the contents of a TDB file</refpurpose>
+ <refname>ntdbdump</refname>
+ <refpurpose>tool for printing the contents of an NTDB file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>tdbdump</command>
+ <command>ntdbdump</command>
<arg choice="opt">-k <replaceable>keyname</replaceable></arg>
<arg choice="opt">-e</arg>
<arg choice="opt">-h</arg>
@@ -32,12 +32,12 @@
<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> suite.</para>
- <para><command>tdbdump</command> is a very simple utility that 'dumps' the
- contents of a TDB (Trivial DataBase) file to standard output in a
+ <para><command>ntdbdump</command> is a very simple utility that 'dumps' the
+ contents of a NTDB (New Trivial DataBase) file to standard output in a
human-readable format.
</para>
- <para>This tool can be used when debugging problems with TDB files. It is
+ <para>This tool can be used when debugging problems with NTDB files. It is
intended for those who are somewhat familiar with Samba internals.
</para>
</refsect1>
@@ -61,20 +61,21 @@
</para> </listitem>
</varlistentry>
- <varlistentry>
- <term>-e</term>
- <listitem><para>
- The <command>-e</command> tries to dump out from a corrupt database. Naturally, such a dump is unreliable, at best.
- </para></listitem>
- </varlistentry>
-
</variablelist>
</refsect1>
<refsect1>
+ <title>SEE ALSO</title>
+
+ <para>
+ tdbdump(8), ntdbtool(8)
+ </para>
+</refsect1>
+
+<refsect1>
<title>VERSION</title>
- <para>This man page is correct for version 3 of the Samba suite.</para>
+ <para>This man page is correct for version 4 of the Samba suite.</para>
</refsect1>
<refsect1>
@@ -86,7 +87,7 @@
the Linux kernel is developed.
</para>
- <para>The tdbdump man page was written by Jelmer Vernooij.</para>
+ <para>The ntdbdump man page was written by Rusty Russell, base on the tdbdump man page by Jelmer Vernooij.</para>
</refsect1>
</refentry>
diff --git a/lib/tdb/man/tdbrestore.8.xml b/lib/ntdb/man/ntdbrestore.8.xml
similarity index 50%
copy from lib/tdb/man/tdbrestore.8.xml
copy to lib/ntdb/man/ntdbrestore.8.xml
index 64c0ba2..a1f0421 100644
--- a/lib/tdb/man/tdbrestore.8.xml
+++ b/lib/ntdb/man/ntdbrestore.8.xml
@@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-<refentry id="tdbrestore.8">
+<refentry id="ntdbrestore.8">
<refmeta>
- <refentrytitle>tdbrestore</refentrytitle>
+ <refentrytitle>ntdbrestore</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="source">Samba</refmiscinfo>
<refmiscinfo class="manual">System Administration tools</refmiscinfo>
- <refmiscinfo class="version">3.6</refmiscinfo>
+ <refmiscinfo class="version">4.0</refmiscinfo>
</refmeta>
<refnamediv>
- <refname>tdbrestore</refname>
- <refpurpose>tool for creating a TDB file out of a tdbdump output</refpurpose>
+ <refname>ntdbrestore</refname>
+ <refpurpose>tool for creating a NTDB file out of a ntdbdump output</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>tdbrestore</command>
- <arg choice="req">tdbfilename</arg>
+ <command>ntdbrestore</command>
+ <arg choice="req">ntdbfilename</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -29,15 +29,15 @@
<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> suite.</para>
- <para><command>tdbrestore</command> is a very simple utility that 'restores' the
- contents of dump file into TDB (Trivial DataBase) file. The dump file is obtained from the tdbdump
- command.
+ <para><command>ntdbrestore</command> is a very simple utility that 'restores' the
+ contents of dump file into NTDB (New Trivial DataBase) file. The dump file is obtained from the ntdbdump or tdbdump
+ commands.
</para>
- <para>This tool wait on the standard input for the content of the dump and will write the tdb in the tdbfilename
+ <para>This tool wait on the standard input for the content of the dump and will write the ntdb in the ntdbfilename
parameter.
</para>
- <para>This tool can be used for unpacking the content of tdb as backup mean.
+ <para>This tool can be used to translate between ntdb and tdb files by dumping and restoring.
</para>
</refsect1>
@@ -45,7 +45,15 @@
<refsect1>
<title>VERSION</title>
- <para>This man page is correct for version 3 of the Samba suite.</para>
+ <para>This man page is correct for version 4 of the Samba suite.</para>
+</refsect1>
+
+<refsect1>
+ <title>SEE ALSO</title>
+
+ <para>
+ ntdbdump(8), tdbrestore(8)
+ </para>
</refsect1>
<refsect1>
@@ -56,11 +64,11 @@
Samba is now developed by the Samba Team as an Open Source project similar to the way
the Linux kernel is developed.
- This tool was initially written by Volker Lendecke based on an
+ ntdbrestore was written by Rusty Russell based on tdbrestore, which was initially written by Volker Lendecke based on an
idea by Simon McVittie.
--
Samba Shared Repository
More information about the samba-cvs
mailing list