From c8dfb376c87a1fd433e23d260b1438638e22c9c2 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Tue, 23 Jul 2013 09:46:43 +0000
Subject: [PATCH] Partial fix for DOCS-94: Version numbers on draft docs are confusing
---
opendj3/src/main/docbkx/dev-guide/man-ldifsearch.xml | 6 +-
opendj3/src/main/docbkx/dev-guide/man-ldifmodify.xml | 6 +-
opendj3/src/main/docbkx/dev-guide/man-ldapmodify.xml | 6 +-
opendj3/src/main/docbkx/dev-guide/man-ldapcompare.xml | 6 +-
opendj3/pom.xml | 2
opendj3/src/main/docbkx/dev-guide/man-ldapsearch.xml | 4 +-
opendj3/src/main/docbkx/dev-guide/man-ldappasswordmodify.xml | 6 +-
opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml | 26 ++++++------
opendj3/src/main/docbkx/dev-guide/man-ldifdiff.xml | 4 +-
opends/pom.xml | 2
opendj3/src/main/docbkx/dev-guide/man-searchrate.xml | 6 +-
opendj3/src/main/docbkx/dev-guide/man-authrate.xml | 6 +-
opendj3/src/main/docbkx/dev-guide/man-modrate.xml | 6 +-
13 files changed, 43 insertions(+), 43 deletions(-)
diff --git a/opendj3/pom.xml b/opendj3/pom.xml
index b6afb1a..3819718 100644
--- a/opendj3/pom.xml
+++ b/opendj3/pom.xml
@@ -100,7 +100,7 @@
<currentSDKversion>${project.version}</currentSDKversion>
<stableSDKversion>version.not.defined</stableSDKversion>
<currentServerVersion>2.5.0-SNAPSHOT</currentServerVersion>
- <docTargetVersion>2.8.0</docTargetVersion>
+ <docTargetVersion>${project.version}</docTargetVersion><!-- Reset before final publication -->
<docPreviousVersion>2.6.0</docPreviousVersion>
<sdkDocTargetVersion>${docTargetVersion}</sdkDocTargetVersion>
<siteDistributionURL>scp://forgerock.org/var/www/vhosts/opendj.forgerock.org/httpdocs</siteDistributionURL>
diff --git a/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml b/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
index c8ac398..f963483 100644
--- a/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
+++ b/opendj3/src/main/docbkx/dev-guide/chap-get-sdk.xml
@@ -124,7 +124,7 @@
<dependency>
<groupId>org.forgerock.opendj</groupId>
<artifactId>opendj-ldap-sdk</artifactId>
- <version><?eval ${sdkDocTargetVersion}?></version>
+ <version><?eval ${docTargetVersion}?></version>
</dependency>
</dependencies></programlisting>
</step>
@@ -144,30 +144,30 @@
</step>
<step>
<para>Unzip the bundle,
- <filename>opendj-ldap-toolkit-<?eval ${sdkDocTargetVersion}?>.zip</filename>,
+ <filename>opendj-ldap-toolkit-<?eval ${docTargetVersion}?>.zip</filename>,
where you want to install the SDK.</para>
- <screen>$ unzip opendj-ldap-toolkit-<?eval ${sdkDocTargetVersion}?>.zip</screen>
+ <screen>$ unzip opendj-ldap-toolkit-<?eval ${docTargetVersion}?>.zip</screen>
</step>
<step>
<para>Add the tools to your PATH.</para>
<screen>(UNIX)
-$ export PATH=/path/to/opendj-ldap-toolkit-<?eval ${sdkDocTargetVersion}?>/bin:$PATH</screen>
+$ export PATH=/path/to/opendj-ldap-toolkit-<?eval ${docTargetVersion}?>/bin:$PATH</screen>
<screen>(Windows)
-C:\>set PATH=\\path\to\opendj-ldap-toolkit-<?eval ${sdkDocTargetVersion}?>\bat:%PATH%</screen>
+C:\>set PATH=\\path\to\opendj-ldap-toolkit-<?eval ${docTargetVersion}?>\bat:%PATH%</screen>
</step>
<step>
<para> Add the OpenDJ LDAP SDK for the APIs, the I18N core library,
and Grizzly I/O framework for the transport to your CLASSPATH, typically found under
- <filename>opendj-ldap-toolkit-<?eval ${sdkDocTargetVersion}?>/lib/</filename>.</para>
+ <filename>opendj-ldap-toolkit-<?eval ${docTargetVersion}?>/lib/</filename>.</para>
<screen>(UNIX)
$ export CLASSPATH=/path/to/lib/grizzly-framework-<?eval ${grizzlyFrameworkVersion}?>.jar:$CLASSPATH
$ export CLASSPATH=/path/to/lib/i18n-core-<?eval ${i18nFrameworkVersion}?>.jar:$CLASSPATH
-$ export CLASSPATH=/path/to/lib/opendj-ldap-sdk-<?eval ${sdkDocTargetVersion}?>.jar:$CLASSPATH
+$ export CLASSPATH=/path/to/lib/opendj-ldap-sdk-<?eval ${docTargetVersion}?>.jar:$CLASSPATH
</screen>
<screen>(Windows)
C:\>set CLASSPATH=\\path\to\lib\grizzly-framework-<?eval ${grizzlyFrameworkVersion}?>.jar:%CLASSPATH%
C:\>set CLASSPATH=\\path\to\lib\i18n-core-<?eval ${i18nFrameworkVersion}?>.jar:%CLASSPATH%
-C:\>set CLASSPATH=\\path\to\lib\opendj-ldap-sdk-<?eval ${sdkDocTargetVersion}?>.jar:%CLASSPATH%</screen>
+C:\>set CLASSPATH=\\path\to\lib\opendj-ldap-sdk-<?eval ${docTargetVersion}?>.jar:%CLASSPATH%</screen>
</step>
</procedure>
@@ -215,22 +215,22 @@
</step>
<step>
<para>Unzip the tools and libraries included in the file,
- <filename>opendj3/opendj-ldap-toolkit/target/opendj-ldap-toolkit-<?eval ${sdkDocTargetVersion}?>.zip</filename>.</para>
+ <filename>opendj3/opendj-ldap-toolkit/target/opendj-ldap-toolkit-<?eval ${docTargetVersion}?>.zip</filename>.</para>
</step>
<step>
- <para>Add the <filename>opendj-ldap-toolkit-<?eval ${sdkDocTargetVersion}?>/bin</filename>
- (UNIX) or <filename>opendj-ldap-toolkit-<?eval ${sdkDocTargetVersion}?>\bat</filename>
+ <para>Add the <filename>opendj-ldap-toolkit-<?eval ${docTargetVersion}?>/bin</filename>
+ (UNIX) or <filename>opendj-ldap-toolkit-<?eval ${docTargetVersion}?>\bat</filename>
(Windows) directory to your PATH.</para>
</step>
<step>
<para>Set your CLASSPATH to include the OpenDJ LDAP SDK library,
- <filename>opendj-ldap-sdk-<?eval ${sdkDocTargetVersion}?>.jar</filename>,
+ <filename>opendj-ldap-sdk-<?eval ${docTargetVersion}?>.jar</filename>,
the I18N core library,
<filename>i18n-core-<?eval ${i18nFrameworkVersion}?>.jar</filename>, and the
Grizzly framework,
<filename>grizzly-framework-<?eval ${grizzlyFrameworkVersion}?>.jar</filename>
under
- <filename>opendj-ldap-toolkit-<?eval ${sdkDocTargetVersion}?>/lib/</filename>.</para>
+ <filename>opendj-ldap-toolkit-<?eval ${docTargetVersion}?>/lib/</filename>.</para>
</step>
</procedure>
diff --git a/opendj3/src/main/docbkx/dev-guide/man-authrate.xml b/opendj3/src/main/docbkx/dev-guide/man-authrate.xml
index 392dd61..a908a1f 100644
--- a/opendj3/src/main/docbkx/dev-guide/man-authrate.xml
+++ b/opendj3/src/main/docbkx/dev-guide/man-authrate.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011 ForgeRock AS
+ ! Copyright 2011-2013 ForgeRock AS
!
-->
<refentry xml:id='authrate-1'
@@ -30,11 +30,11 @@
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
- <info><copyright><year>2011</year><holder>ForgeRock AS</holder></copyright></info>
+ <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info>
<refmeta>
<refentrytitle>authrate</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
+ <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
</refmeta>
<refnamediv>
<refname>authrate</refname>
diff --git a/opendj3/src/main/docbkx/dev-guide/man-ldapcompare.xml b/opendj3/src/main/docbkx/dev-guide/man-ldapcompare.xml
index c3680bc..61c7e17 100644
--- a/opendj3/src/main/docbkx/dev-guide/man-ldapcompare.xml
+++ b/opendj3/src/main/docbkx/dev-guide/man-ldapcompare.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2012 ForgeRock AS
+ ! Copyright 2011-2013 ForgeRock AS
!
-->
<refentry xml:id='ldapcompare-1'
@@ -30,11 +30,11 @@
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
- <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
+ <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info>
<refmeta>
<refentrytitle>ldapcompare</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
+ <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
</refmeta>
<refnamediv>
<refname>ldapcompare</refname>
diff --git a/opendj3/src/main/docbkx/dev-guide/man-ldapmodify.xml b/opendj3/src/main/docbkx/dev-guide/man-ldapmodify.xml
index 47de6ff..7777c8c 100644
--- a/opendj3/src/main/docbkx/dev-guide/man-ldapmodify.xml
+++ b/opendj3/src/main/docbkx/dev-guide/man-ldapmodify.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2012 ForgeRock AS
+ ! Copyright 2011-2013 ForgeRock AS
!
-->
<refentry xml:id='ldapmodify-1'
@@ -30,11 +30,11 @@
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
- <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
+ <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info>
<refmeta>
<refentrytitle>ldapmodify</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
+ <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
</refmeta>
<refnamediv>
<refname>ldapmodify</refname>
diff --git a/opendj3/src/main/docbkx/dev-guide/man-ldappasswordmodify.xml b/opendj3/src/main/docbkx/dev-guide/man-ldappasswordmodify.xml
index 3420fc4..a4fb42d 100644
--- a/opendj3/src/main/docbkx/dev-guide/man-ldappasswordmodify.xml
+++ b/opendj3/src/main/docbkx/dev-guide/man-ldappasswordmodify.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2012 ForgeRock AS
+ ! Copyright 2011-2013 ForgeRock AS
!
-->
<refentry xml:id='ldappasswordmodify-1'
@@ -30,11 +30,11 @@
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
- <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
+ <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info>
<refmeta>
<refentrytitle>ldappasswordmodify</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
+ <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
</refmeta>
<refnamediv>
<refname>ldappasswordmodify</refname>
diff --git a/opendj3/src/main/docbkx/dev-guide/man-ldapsearch.xml b/opendj3/src/main/docbkx/dev-guide/man-ldapsearch.xml
index 28616a0..0c97b2a 100644
--- a/opendj3/src/main/docbkx/dev-guide/man-ldapsearch.xml
+++ b/opendj3/src/main/docbkx/dev-guide/man-ldapsearch.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2012 ForgeRock AS
+ ! Copyright 2011-2013 ForgeRock AS
!
-->
<refentry xml:id='ldapsearch-1'
@@ -34,7 +34,7 @@
<refmeta>
<refentrytitle>ldapsearch</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
+ <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
</refmeta>
<refnamediv>
<refname>ldapsearch</refname>
diff --git a/opendj3/src/main/docbkx/dev-guide/man-ldifdiff.xml b/opendj3/src/main/docbkx/dev-guide/man-ldifdiff.xml
index 473c445..cfe0014 100644
--- a/opendj3/src/main/docbkx/dev-guide/man-ldifdiff.xml
+++ b/opendj3/src/main/docbkx/dev-guide/man-ldifdiff.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2012 ForgeRock AS
+ ! Copyright 2011-2013 ForgeRock AS
!
-->
<refentry xml:id='ldifdiff-1'
@@ -30,7 +30,7 @@
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
- <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
+ <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info>
<refmeta>
<refentrytitle>ldifdiff</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
diff --git a/opendj3/src/main/docbkx/dev-guide/man-ldifmodify.xml b/opendj3/src/main/docbkx/dev-guide/man-ldifmodify.xml
index 8c4ec2d..959db1e 100644
--- a/opendj3/src/main/docbkx/dev-guide/man-ldifmodify.xml
+++ b/opendj3/src/main/docbkx/dev-guide/man-ldifmodify.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2012 ForgeRock AS
+ ! Copyright 2011-2013 ForgeRock AS
!
-->
<refentry xml:id='ldifmodify-1'
@@ -30,11 +30,11 @@
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
- <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
+ <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info>
<refmeta>
<refentrytitle>ldifmodify</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
+ <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
</refmeta>
<refnamediv>
<refname>ldifmodify</refname>
diff --git a/opendj3/src/main/docbkx/dev-guide/man-ldifsearch.xml b/opendj3/src/main/docbkx/dev-guide/man-ldifsearch.xml
index 07c9218..c3a56b3 100644
--- a/opendj3/src/main/docbkx/dev-guide/man-ldifsearch.xml
+++ b/opendj3/src/main/docbkx/dev-guide/man-ldifsearch.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2012 ForgeRock AS
+ ! Copyright 2011-2013 ForgeRock AS
!
-->
<refentry xml:id='ldifsearch-1'
@@ -30,11 +30,11 @@
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
- <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
+ <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info>
<refmeta>
<refentrytitle>ldifsearch</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
+ <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
</refmeta>
<refnamediv>
<refname>ldifsearch</refname>
diff --git a/opendj3/src/main/docbkx/dev-guide/man-modrate.xml b/opendj3/src/main/docbkx/dev-guide/man-modrate.xml
index 2b2f251..87672e2 100644
--- a/opendj3/src/main/docbkx/dev-guide/man-modrate.xml
+++ b/opendj3/src/main/docbkx/dev-guide/man-modrate.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2012 ForgeRock AS
+ ! Copyright 2011-2013 ForgeRock AS
!
-->
<refentry xml:id='modrate-1'
@@ -30,11 +30,11 @@
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
- <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
+ <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info>
<refmeta>
<refentrytitle>modrate</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
+ <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
</refmeta>
<refnamediv>
<refname>modrate</refname>
diff --git a/opendj3/src/main/docbkx/dev-guide/man-searchrate.xml b/opendj3/src/main/docbkx/dev-guide/man-searchrate.xml
index 69fbcdd..69617bd 100644
--- a/opendj3/src/main/docbkx/dev-guide/man-searchrate.xml
+++ b/opendj3/src/main/docbkx/dev-guide/man-searchrate.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2012 ForgeRock AS
+ ! Copyright 2011-2013 ForgeRock AS
!
-->
<refentry xml:id='searchrate-1'
@@ -30,11 +30,11 @@
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
- <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
+ <info><copyright><year>2011-2013</year><holder>ForgeRock AS</holder></copyright></info>
<refmeta>
<refentrytitle>searchrate</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
+ <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
</refmeta>
<refnamediv>
<refname>searchrate</refname>
diff --git a/opends/pom.xml b/opends/pom.xml
index a4b79f0..9df3bd4 100644
--- a/opends/pom.xml
+++ b/opends/pom.xml
@@ -94,7 +94,7 @@
<!-- START Documentation properties -->
- <docTargetVersion>2.8.0</docTargetVersion>
+ <docTargetVersion>${project.version}</docTargetVersion><!-- Reset before final publication -->
<docPreviousVersion>2.6.0</docPreviousVersion>
<sdkDocTargetVersion>${docTargetVersion}</sdkDocTargetVersion>
<gaId>UA-23412190-8</gaId>
--
Gitblit v1.10.0