From 4b90f92d9db87e37284cfaf0d84b14ec1509d13f Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 06 Jan 2012 17:41:07 +0000
Subject: [PATCH] ldif-diff -> ldifdiff and changes to the synopsis
---
opendj-sdk/opendj3/src/main/docbkx/dev-guide/OpenDJ-Dev-Guide.xml | 3 +
opendj-sdk/opendj3/src/main/docbkx/admin-guide/OpenDJ-Admin-Guide.xml | 2
opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-import-export.xml | 15 +++----
opendj-sdk/opendj3/src/main/docbkx/shared/man-ldifdiff.xml | 43 +++++----------------
opendj-sdk/opendj3/src/main/docbkx/release-notes/chap-compatibility.xml | 6 ++
opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml | 4 +-
opendj-sdk/opends/resource/man/man1/ldifdiff.1 | 38 ++++--------------
7 files changed, 36 insertions(+), 75 deletions(-)
diff --git a/opendj-sdk/opendj3/src/main/docbkx/admin-guide/OpenDJ-Admin-Guide.xml b/opendj-sdk/opendj3/src/main/docbkx/admin-guide/OpenDJ-Admin-Guide.xml
index 5f79ff9..ed2c5b9 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/admin-guide/OpenDJ-Admin-Guide.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/admin-guide/OpenDJ-Admin-Guide.xml
@@ -104,7 +104,7 @@
<xinclude:include href='../shared/man-ldapmodify.xml' />
<xinclude:include href='../shared/man-ldappasswordmodify.xml' />
<xinclude:include href='../shared/man-ldapsearch.xml' />
- <xinclude:include href='../shared/man-ldif-diff.xml' />
+ <xinclude:include href='../shared/man-ldifdiff.xml' />
<xinclude:include href='../shared/man-ldifmodify.xml' />
<xinclude:include href='../shared/man-ldifsearch.xml' />
<xinclude:include href='../shared/man-list-backends.xml' />
diff --git a/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml b/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml
index b17d5d2..31dd01a 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml
@@ -336,8 +336,8 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#ldif-diff-1"
- xlink:role="http://docbook.org/xlink/role/olink">ldif-diff</link></term>
+ <term><link xlink:href="admin-guide#ldifdiff-1"
+ xlink:role="http://docbook.org/xlink/role/olink">ldifdiff</link></term>
<listitem>
<para>Display differences between two LDIF files, with the resulting output
having LDIF format.</para>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-import-export.xml b/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-import-export.xml
index 81a6692..84412d3 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-import-export.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-import-export.xml
@@ -222,7 +222,7 @@
</indexterm>
<para>This section demonstrates the <command>ldifsearch</command>,
- <command>ldifmodify</command>, and <command>ldif-diff</command> tools.</para>
+ <command>ldifmodify</command>, and <command>ldifdiff</command> tools.</para>
<section xml:id="ldifsearch-example">
<title>Searching in LDIF With <command>ldifsearch</command></title>
@@ -269,13 +269,13 @@
same size as the source LDIF file.</para>
</section>
- <section xml:id="ldif-diff-example">
- <title>Comparing LDIF With <command>ldif-diff</command></title>
+ <section xml:id="ldifdiff-example">
+ <title>Comparing LDIF With <command>ldifdiff</command></title>
- <para>The <command>ldif-diff</command> command reports differences between
+ <para>The <command>ldifdiff</command> command reports differences between
two LDIF files in LDIF format.</para>
- <screen>$ ldif-diff --sourceLDIF old.ldif --targetLDIF new.ldif
+ <screen>$ ldifdiff old.ldif new.ldif
dn: uid=user.0,ou=People,dc=example,dc=org
changetype: modify
add: initials
@@ -292,10 +292,7 @@
</screen>
- <para>The <option>--outputLDIF <replaceable>ldif-file</replaceable></option>
- option can be used to save the output to a file.</para>
-
- <para>As the <command>ldif-diff</command> command reads both files into
+ <para>As the <command>ldifdiff</command> command reads both files into
memory, constructing tree maps to perform the comparison, the command
is designed to work with small files and fragments. The command can quickly
run out of memory when calculating differences between large files.</para>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/dev-guide/OpenDJ-Dev-Guide.xml b/opendj-sdk/opendj3/src/main/docbkx/dev-guide/OpenDJ-Dev-Guide.xml
index e0fc269..4337e4b 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/dev-guide/OpenDJ-Dev-Guide.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/dev-guide/OpenDJ-Dev-Guide.xml
@@ -77,6 +77,9 @@
<xinclude:include href='../shared/man-ldapmodify.xml' />
<xinclude:include href='../shared/man-ldappasswordmodify.xml' />
<xinclude:include href='../shared/man-ldapsearch.xml' />
+ <xinclude:include href='../shared/man-ldifdiff.xml' />
+ <xinclude:include href='../shared/man-ldifmodify.xml' />
+ <xinclude:include href='../shared/man-ldifsearch.xml' />
<xinclude:include href='../shared/man-modrate.xml' />
<xinclude:include href='../shared/man-searchrate.xml' />
</reference>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/release-notes/chap-compatibility.xml b/opendj-sdk/opendj3/src/main/docbkx/release-notes/chap-compatibility.xml
index 0b19b47..661e9be 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/release-notes/chap-compatibility.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/release-notes/chap-compatibility.xml
@@ -37,7 +37,11 @@
<section xml:id="changed-functionality">
<title>Major Changes to Existing Functionality</title>
- <para>None.</para>
+ <para>The <command>ldif-diff</command> command has been renamed
+ <command>ldifdiff</command>, and the <option>--outputLDIF</option>,
+ <option>--overwriteExisting</option>, <option>--sourceLDIF</option>,
+ <option>--targetLDIF</option> options have been dropped in favor of a
+ format closer to that of the <command>diff</command> command.</para>
</section>
<section xml:id="deprecated-functionality">
diff --git a/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldif-diff.xml b/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldifdiff.xml
similarity index 80%
rename from opendj-sdk/opendj3/src/main/docbkx/shared/man-ldif-diff.xml
rename to opendj-sdk/opendj3/src/main/docbkx/shared/man-ldifdiff.xml
index 77f50db..473c445 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldif-diff.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldifdiff.xml
@@ -23,7 +23,7 @@
! Copyright 2011-2012 ForgeRock AS
!
-->
-<refentry xml:id='ldif-diff-1'
+<refentry xml:id='ldifdiff-1'
xmlns='http://docbook.org/ns/docbook'
version='5.0' xml:lang='en'
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
@@ -32,18 +32,20 @@
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
<refmeta>
- <refentrytitle>ldif-diff</refentrytitle><manvolnum>1</manvolnum>
+ <refentrytitle>ldifdiff</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
<refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
</refmeta>
<refnamediv>
- <refname>ldif-diff</refname>
+ <refname>ldifdiff</refname>
<refpurpose>compare small LDIF files</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>ldif-diff</command>
- <arg choice="req">options</arg>
+ <command>ldifdiff</command>
+ <arg choice="opt">options</arg>
+ <arg choice="plain"><replaceable>source</replaceable>.ldif</arg>
+ <arg choice="plain"><replaceable>target</replaceable>.ldif</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
@@ -78,25 +80,6 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-o, --outputLDIF {file}</option></term>
- <listitem>
- <para>File to which the output should be written.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-O, --overwriteExisting</option></term>
- <listitem>
- <para>Any existing output file should be overwritten rather than appending
- to it.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --sourceLDIF {file}</option></term>
- <listitem>
- <para>LDIF file to use as the source data.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><option>-S, --singleValueChanges</option></term>
<listitem>
<para>Each attribute-level change should be written as a separate
@@ -105,12 +88,6 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-t, --targetLDIF {file}</option></term>
- <listitem>
- <para>LDIF file to use as the target data.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><option>-V, --version</option></term>
<listitem>
<para>Display version information.</para>
@@ -145,7 +122,7 @@
<title>Examples</title>
<para>The following example demonstrates use of the command with two
small LDIF files.</para>
- <screen>$ cat /path/to/newuser.ldif
+ <screen>$ cat /path/to/newuser.ldif
dn: uid=newuser,ou=People,dc=example,dc=com
uid: newuser
objectClass: person
@@ -158,7 +135,7 @@
mail: newuser@example.com
userPassword: changeme
-$ cat /path/to/neweruser.ldif
+$ cat /path/to/neweruser.ldif
dn: uid=newuser,ou=People,dc=example,dc=com
uid: newuser
objectClass: person
@@ -172,7 +149,7 @@
userPassword: secret12
description: A new description.
-$ ldif-diff -s /path/to/newuser.ldif -t /path/to/neweruser.ldif
+$ ldifdiff /path/to/newuser.ldif /path/to/neweruser.ldif
dn: uid=newuser,ou=People,dc=example,dc=com
changetype: modify
add: userPassword
diff --git a/opendj-sdk/opends/resource/man/man1/ldif-diff.1 b/opendj-sdk/opends/resource/man/man1/ldifdiff.1
similarity index 80%
rename from opendj-sdk/opends/resource/man/man1/ldif-diff.1
rename to opendj-sdk/opends/resource/man/man1/ldifdiff.1
index a9d783c..a828a13 100644
--- a/opendj-sdk/opends/resource/man/man1/ldif-diff.1
+++ b/opendj-sdk/opends/resource/man/man1/ldifdiff.1
@@ -1,13 +1,13 @@
'\" t
-.\" Title: ldif-diff
+.\" Title: ldifdiff
.\" Author:
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: January\ \&03,\ \&2012
+.\" Date: January\ \&06,\ \&2012
.\" Manual: Tools Reference
.\" Source: OpenDJ 2.5.0
.\" Language: English
.\"
-.TH "LDIF\-DIFF" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
+.TH "LDIFDIFF" "1" "January\ \&06,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -28,10 +28,10 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-ldif-diff \- compare small LDIF files
+ldifdiff \- compare small LDIF files
.SH "SYNOPSIS"
-.HP \w'\fBldif\-diff\fR\ 'u
-\fBldif\-diff\fR {options}
+.HP \w'\fBldifdiff\fR\ 'u
+\fBldifdiff\fR [\fIsource\fR\&.ldif] [\fItarget\fR\&.ldif] [options]
.SH "DESCRIPTION"
.PP
This utility can be used to compare two LDIF files and report the differences in LDIF format\&.
@@ -54,31 +54,11 @@
File containing a list of entries (DN) to ignore when computing the difference\&.
.RE
.PP
-\fB\-o, \-\-outputLDIF {file}\fR
-.RS 4
-File to which the output should be written\&.
-.RE
-.PP
-\fB\-O, \-\-overwriteExisting\fR
-.RS 4
-Any existing output file should be overwritten rather than appending to it\&.
-.RE
-.PP
-\fB\-s, \-\-sourceLDIF {file}\fR
-.RS 4
-LDIF file to use as the source data\&.
-.RE
-.PP
\fB\-S, \-\-singleValueChanges\fR
.RS 4
Each attribute\-level change should be written as a separate modification per attribute value rather than one modification per entry\&.
.RE
.PP
-\fB\-t, \-\-targetLDIF {file}\fR
-.RS 4
-LDIF file to use as the target data\&.
-.RE
-.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information\&.
@@ -107,7 +87,7 @@
.RS 4
.\}
.nf
-$ cat /path/to/newuser\&.ldif
+$ cat /path/to/newuser\&.ldif
dn: uid=newuser,ou=People,dc=example,dc=com
uid: newuser
objectClass: person
@@ -120,7 +100,7 @@
mail: newuser@example\&.com
userPassword: changeme
-$ cat /path/to/neweruser\&.ldif
+$ cat /path/to/neweruser\&.ldif
dn: uid=newuser,ou=People,dc=example,dc=com
uid: newuser
objectClass: person
@@ -134,7 +114,7 @@
userPassword: secret12
description: A new description\&.
-$ ldif\-diff \-s /path/to/newuser\&.ldif \-t /path/to/neweruser\&.ldif
+$ ldifdiff /path/to/newuser\&.ldif /path/to/neweruser\&.ldif
dn: uid=newuser,ou=People,dc=example,dc=com
changetype: modify
add: userPassword
--
Gitblit v1.10.0