Attachment 8252 Details for Bug 9443 – Proposed patch

[patch] Proposed patch

docs-lib.patch (text/plain), 10.62 KB, created by Karolin Seeger on 2012-12-03 09:42:28 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Karolin Seeger

Created: 2012-12-03 09:42:28 UTC

Size: 10.62 KB

patch

obsolete

>From 4633ceccafbba8f91993bee2d4b4948d6851e521 Mon Sep 17 00:00:00 2001
>From: Karolin Seeger <kseeger@samba.org>
>Date: Fri, 30 Nov 2012 09:39:22 +0100
>Subject: [PATCH 1/2] lib/tdb: Rename manpages/ to man/.
>
>Trying to be more consistent.
>
>Karolin
>---
> lib/tdb/{manpages => man}/tdbbackup.8.xml  |    6 +++---
> lib/tdb/{manpages => man}/tdbdump.8.xml    |    8 ++++----
> lib/tdb/{manpages => man}/tdbrestore.8.xml |    0
> lib/tdb/{manpages => man}/tdbtool.8.xml    |    2 +-
> lib/tdb/wscript                            |    8 ++++----
> 5 files changed, 12 insertions(+), 12 deletions(-)
> rename lib/tdb/{manpages => man}/tdbbackup.8.xml (97%)
> rename lib/tdb/{manpages => man}/tdbdump.8.xml (98%)
> rename lib/tdb/{manpages => man}/tdbrestore.8.xml (100%)
> rename lib/tdb/{manpages => man}/tdbtool.8.xml (99%)
>
>diff --git a/lib/tdb/manpages/tdbbackup.8.xml b/lib/tdb/man/tdbbackup.8.xml
>similarity index 97%
>rename from lib/tdb/manpages/tdbbackup.8.xml
>rename to lib/tdb/man/tdbbackup.8.xml
>index 78fe32e..02936cf 100644
>--- a/lib/tdb/manpages/tdbbackup.8.xml
>+++ b/lib/tdb/man/tdbbackup.8.xml
>@@ -33,8 +33,8 @@
> 
> 	<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
>-	to samba startup or during normal operation. If it finds file damage and it finds 
>-	a prior backup the backup file will be restored. 
>+	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>
> </refsect1>
> 
>@@ -128,7 +128,7 @@
> 	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> 
>+	</para>
> 
> 	<para>The tdbbackup man page was written by John H Terpstra.</para>
> </refsect1>
>diff --git a/lib/tdb/manpages/tdbdump.8.xml b/lib/tdb/man/tdbdump.8.xml
>similarity index 98%
>rename from lib/tdb/manpages/tdbdump.8.xml
>rename to lib/tdb/man/tdbdump.8.xml
>index 3420193..25fd432 100644
>--- a/lib/tdb/manpages/tdbdump.8.xml
>+++ b/lib/tdb/man/tdbdump.8.xml
>@@ -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>tdbdump</command> is a very simple utility that 'dumps' the
>+		contents of a TDB (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 TDB files. It is
> 		intended for those who are somewhat familiar with Samba internals.
> 	</para>
> </refsect1>
>@@ -84,7 +84,7 @@
> 	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> 
>+	</para>
> 
> 	<para>The tdbdump man page was written by Jelmer Vernooij.</para>
> </refsect1>
>diff --git a/lib/tdb/manpages/tdbrestore.8.xml b/lib/tdb/man/tdbrestore.8.xml
>similarity index 100%
>rename from lib/tdb/manpages/tdbrestore.8.xml
>rename to lib/tdb/man/tdbrestore.8.xml
>diff --git a/lib/tdb/manpages/tdbtool.8.xml b/lib/tdb/man/tdbtool.8.xml
>similarity index 99%
>rename from lib/tdb/manpages/tdbtool.8.xml
>rename to lib/tdb/man/tdbtool.8.xml
>index c143b5c..bc5c001 100644
>--- a/lib/tdb/manpages/tdbtool.8.xml
>+++ b/lib/tdb/man/tdbtool.8.xml
>@@ -122,7 +122,7 @@
> 		<replaceable>KEY</replaceable>
> 		<replaceable>TDBFILE</replaceable>
> 		</term>
>-		<listitem><para>Move a record from the 
>+		<listitem><para>Move a record from the
> 		current database into <replaceable>TDBFILE</replaceable>.
> 		</para></listitem>
> 		</varlistentry>
>diff --git a/lib/tdb/wscript b/lib/tdb/wscript
>index 9d309a0..7a3d0fa 100644
>--- a/lib/tdb/wscript
>+++ b/lib/tdb/wscript
>@@ -94,20 +94,20 @@ def build(bld):
> 
>         bld.SAMBA_BINARY('tdbrestore',
>                          'tools/tdbrestore.c',
>-                         'tdb', manpages='manpages/tdbrestore.8')
>+                         'tdb', manpages='man/tdbrestore.8')
> 
>         bld.SAMBA_BINARY('tdbdump',
>                          'tools/tdbdump.c',
>-                         'tdb', manpages='manpages/tdbdump.8')
>+                         'tdb', manpages='man/tdbdump.8')
> 
>         bld.SAMBA_BINARY('tdbbackup',
>                          'tools/tdbbackup.c',
>                          'tdb',
>-                         manpages='manpages/tdbbackup.8')
>+                         manpages='man/tdbbackup.8')
> 
>         bld.SAMBA_BINARY('tdbtool',
>                          'tools/tdbtool.c',
>-                         'tdb', manpages='manpages/tdbtool.8')
>+                         'tdb', manpages='man/tdbtool.8')
> 
>         # FIXME: This hardcoded list is stupid, stupid, stupid.
>         bld.SAMBA_SUBSYSTEM('tdb-test-helpers',
>-- 
>1.7.7
>
>
>From 11566b096ea75cd4d82ac8b9937ac15e23e462f5 Mon Sep 17 00:00:00 2001
>From: Karolin Seeger <kseeger@samba.org>
>Date: Fri, 30 Nov 2012 09:43:33 +0100
>Subject: [PATCH 2/2] lib/talloc: Move manpage to man/.
>
>Trying to be more consistent.
>
>Karolin
>---
> lib/talloc/{ => man}/talloc.3.xml |   24 ++++++++++++------------
> lib/talloc/wscript                |    2 +-
> 2 files changed, 13 insertions(+), 13 deletions(-)
> rename lib/talloc/{ => man}/talloc.3.xml (99%)
>
>diff --git a/lib/talloc/talloc.3.xml b/lib/talloc/man/talloc.3.xml
>similarity index 99%
>rename from lib/talloc/talloc.3.xml
>rename to lib/talloc/man/talloc.3.xml
>index 85cd6c4..553eaec 100644
>--- a/lib/talloc/talloc.3.xml
>+++ b/lib/talloc/man/talloc.3.xml
>@@ -28,7 +28,7 @@
>     <para>
>       Perhaps the biggest change from Samba3 is that there is no
>       distinction between a "talloc context" and a "talloc pointer".  Any
>-      pointer returned from talloc() is itself a valid talloc context. 
>+      pointer returned from talloc() is itself a valid talloc context.
>       This means you can do this:
>     </para>
>     <programlisting>
>@@ -153,8 +153,8 @@
> 	<para>
> 	  <screen format="linespecific">
> 	    ERROR: talloc_free with references at some_dir/source/foo.c:123
>-  	  	reference at some_dir/source/other.c:325
>-  	  	reference at some_dir/source/third.c:121
>+		reference at some_dir/source/other.c:325
>+		reference at some_dir/source/third.c:121
> 	  </screen>
> 	</para>
> 	<para>
>@@ -188,7 +188,7 @@
>         <itemizedlist>
>           <listitem>
>             <para>
>-	      you can talloc_free() any parent of the original pointer. 
>+	      you can talloc_free() any parent of the original pointer.
> 	      That will reduce the number of parents of this pointer by 1,
> 	      and will cause this pointer to be freed if it runs out of
> 	      parents.
>@@ -218,7 +218,7 @@
>         </para>
>         <para>
> 	  Note that if the parent has already been removed using
>-	  talloc_free() then this function will fail and will return -1. 
>+	  talloc_free() then this function will fail and will return -1.
> 	  Likewise, if <emphasis role="italic">ptr</emphasis> is NULL, then
> 	  the function will make no modifications and return -1.
>         </para>
>@@ -373,7 +373,7 @@ talloc_set_name_const(ptr, name);</programlisting>
>     </refsect2>
>     <refsect2><title>(<emphasis role="italic">type</emphasis> *)talloc_realloc(const void *<emphasis role="italic">ctx</emphasis>, void *<emphasis role="italic">ptr</emphasis>, <emphasis role="italic">type</emphasis>, <emphasis role="italic">count</emphasis>);</title>
>         <para>
>-	  The talloc_realloc() macro changes the size of a talloc pointer. 
>+	  The talloc_realloc() macro changes the size of a talloc pointer.
> 	  It has the following equivalences:
>         </para>
>         <programlisting>talloc_realloc(ctx, NULL, type, 1) ==> talloc(ctx, type);
>@@ -384,7 +384,7 @@ talloc_realloc(ctx, ptr, type, 0)  ==> talloc_free(ptr);</programlisting>
> 	  it is ignored.
>         </para>
>         <para>
>-	  talloc_realloc() returns the new pointer, or NULL on failure. 
>+	  talloc_realloc() returns the new pointer, or NULL on failure.
> 	  The call will fail either due to a lack of memory, or because the
> 	  pointer has more than one parent (see <link
> 	  linkend="talloc_reference"><quote>talloc_reference()</quote></link>).
>@@ -423,8 +423,8 @@ talloc_realloc(ctx, ptr, type, 0)  ==> talloc_free(ptr);</programlisting>
>         <para>
> 	  <screen format="linespecific">
> 	  WARNING: talloc_steal with references at some_dir/source/foo.c:123
>-  	  	reference at some_dir/source/other.c:325
>-  	  	reference at some_dir/source/third.c:121
>+		reference at some_dir/source/other.c:325
>+		reference at some_dir/source/third.c:121
> 	  </screen>
>         </para>
>         <para>
>@@ -432,7 +432,7 @@ talloc_realloc(ctx, ptr, type, 0)  ==> talloc_free(ptr);</programlisting>
> 	  the
> 	  function <link linkend="talloc_reference"><quote>talloc_reparent()</quote></link>. See
> 	  the talloc_set_log_fn() documentation for more information
>-	  on talloc logging.  
>+	  on talloc logging.
> 	</para>
>     </refsect2>
>     <refsect2><title>TYPE *talloc_reparent(const void *<emphasis role="italic">old_parent</emphasis>, const void *<emphasis role="italic">new_parent</emphasis>, const TYPE *<emphasis role="italic">ptr</emphasis>);</title>
>@@ -776,7 +776,7 @@ if (ptr) memcpy(ptr, p, strlen(p)+1);</programlisting>
>   </refsect1>
>   <refsect1><title>SEE ALSO</title>
>     <para>
>-      malloc(3), strndup(3), vasprintf(3), asprintf(3), 
>+      malloc(3), strndup(3), vasprintf(3), asprintf(3),
>       <ulink url="http://talloc.samba.org/"/>
>     </para>
>   </refsect1>
>@@ -795,7 +795,7 @@ if (ptr) memcpy(ptr, p, strlen(p)+1);</programlisting>
>     </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 
>+      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>
>diff --git a/lib/talloc/wscript b/lib/talloc/wscript
>index 8d3246b..bd7708e 100644
>--- a/lib/talloc/wscript
>+++ b/lib/talloc/wscript
>@@ -108,7 +108,7 @@ def build(bld):
>                           pc_files='talloc.pc',
>                           public_headers_install=not private_library,
>                           private_library=private_library,
>-                          manpages='talloc.3')
>+                          manpages='man/talloc.3')
> 
>     if not bld.CONFIG_SET('USING_SYSTEM_PYTALLOC_UTIL') and not bld.env.disable_python:
>         bld.SAMBA_LIBRARY('pytalloc-util',
>-- 
>1.7.7
>

Flags:

asn: review+

Actions: View

Attachments on bug 9443: 8252