Added support for generating an upgrade guide.
This commit is contained in:
Ulrik Sandberg
@@ -154,4 +154,97 @@ to see a list of all relevant targets.
|
||||
|
||||
<target name="doc-all" depends="doc-html,doc-htmlsingle,doc-pdf" description="Generate reference documentation in all formats" />
|
||||
|
||||
</project>
|
||||
<target name="upgrade-clean" description="Delete temporary directories for upgrade docs">
|
||||
<delete quiet="true" dir="${docs.upgrade.target.dir}" />
|
||||
</target>
|
||||
|
||||
<target name="upgrade-prepare">
|
||||
<fail message="Supporting libraries needed to generate documentation not found in: ${docs.ref.lib.dir}, please see docs/upgrade/readme.txt for instructions.">
|
||||
<condition>
|
||||
<not>
|
||||
<available file="${docs.ref.lib.dir}" />
|
||||
</not>
|
||||
</condition>
|
||||
</fail>
|
||||
<copy todir="${docs.upgrade.target.dir}/images">
|
||||
<fileset dir="${docs.ref.dir}/images">
|
||||
<include name="*.gif" />
|
||||
<include name="*.png" />
|
||||
<include name="*.svg" />
|
||||
<include name="*.jpg" />
|
||||
</fileset>
|
||||
<fileset dir="${docs.ref.dir}/images">
|
||||
<include name="**/*.gif" />
|
||||
<include name="**/*.png" />
|
||||
<include name="**/*.svg" />
|
||||
<include name="**/*.jpg" />
|
||||
</fileset>
|
||||
</copy>
|
||||
</target>
|
||||
|
||||
<target name="upgrade-pdf" depends="upgrade-prepare" description="Generate PDF upgrade documentation">
|
||||
<mkdir dir="${docs.upgrade.target.dir}/pdf/images" />
|
||||
<copy todir="${docs.upgrade.target.dir}/pdf/images">
|
||||
<fileset dir="${docs.ref.src.dir}/images">
|
||||
<include name="*.gif" />
|
||||
<include name="*.png" />
|
||||
<include name="*.svg" />
|
||||
<include name="*.jpg" />
|
||||
</fileset>
|
||||
</copy>
|
||||
|
||||
<java classname="com.icl.saxon.StyleSheet" fork="true" dir="${docs.upgrade.dir}">
|
||||
<classpath>
|
||||
<fileset dir="${docs.ref.lib.dir}">
|
||||
<include name="**/*.jar" />
|
||||
</fileset>
|
||||
</classpath>
|
||||
<arg value="-o" />
|
||||
<arg value="${docs.upgrade.target.dir}/pdf/docbook_fop.tmp" />
|
||||
<arg value="${docs.upgrade.src.dir}/upgrade.xml" />
|
||||
<arg value="${docs.ref.dir}/styles/fopdf.xsl" />
|
||||
</java>
|
||||
|
||||
<java classname="org.apache.fop.apps.Fop" fork="true" maxmemory="256m" dir="${docs.upgrade.dir}">
|
||||
<classpath>
|
||||
<fileset dir="${docs.ref.lib.dir}">
|
||||
<include name="**/*.jar" />
|
||||
</fileset>
|
||||
</classpath>
|
||||
<arg value="-d"/>
|
||||
<arg value="${docs.upgrade.target.dir}/pdf/docbook_fop.tmp" />
|
||||
<arg value="${docs.upgrade.target.dir}/pdf/${ant.project.name}-upgrade.pdf" />
|
||||
</java>
|
||||
<delete file="${docs.upgrade.target.dir}/pdf/docbook_fop.tmp" />
|
||||
</target>
|
||||
|
||||
<target name="upgrade-html" depends="upgrade-prepare" description="Generate HTML upgrade documentation">
|
||||
<mkdir dir="${docs.upgrade.target.dir}/html_single/images" />
|
||||
<mkdir dir="${docs.upgrade.target.dir}/html_single/styles" />
|
||||
<copy todir="${docs.upgrade.target.dir}/html_single/images">
|
||||
<fileset dir="${docs.ref.src.dir}/images">
|
||||
<include name="*.gif" />
|
||||
<include name="*.png" />
|
||||
<include name="*.svg" />
|
||||
<include name="*.jpg" />
|
||||
</fileset>
|
||||
</copy>
|
||||
<copy todir="${docs.upgrade.target.dir}/html_single/styles" file="${docs.ref.dir}/styles/html.css"/>
|
||||
|
||||
<java classname="com.icl.saxon.StyleSheet" fork="true" dir="${docs.upgrade.target.dir}/html_single">
|
||||
<classpath>
|
||||
<fileset dir="${docs.ref.lib.dir}">
|
||||
<include name="**/*.jar" />
|
||||
</fileset>
|
||||
</classpath>
|
||||
<arg value="-o" />
|
||||
<arg value="${docs.upgrade.target.dir}/html_single/index.html" />
|
||||
<arg value="${docs.upgrade.src.dir}/upgrade.xml" />
|
||||
<arg value="${docs.ref.dir}/styles/html.xsl" />
|
||||
</java>
|
||||
<delete file="${docs.upgrade.target.dir}/htmlsingle/docbook_fop.tmp" />
|
||||
</target>
|
||||
|
||||
<target name="upgrade-all" depends="upgrade-html,upgrade-pdf" description="Generate upgrade documentation in all formats" />
|
||||
|
||||
</project>
|
||||
|
||||
@@ -104,6 +104,15 @@ docs.ref.lib.dir=${docs.dir}/reference/lib
|
||||
# where the project reference documentation is built
|
||||
docs.ref.target.dir=${docs.dir}/reference/target
|
||||
|
||||
# where all project upgrade documentation resides
|
||||
docs.upgrade.dir=${docs.dir}/upgrade
|
||||
|
||||
# where all project upgrade documentation sources reside
|
||||
docs.upgrade.src.dir=${docs.dir}/upgrade/src
|
||||
|
||||
# where the project upgrade documentation is built
|
||||
docs.upgrade.target.dir=${docs.dir}/upgrade/target
|
||||
|
||||
# where the dist target is saved
|
||||
dist.dir=${target.dir}/dist
|
||||
|
||||
@@ -132,4 +141,4 @@ ivy.srcivypattern=${ivy.distrib.dir}/ivys/[organisation]/[module]/ivy-[revision]
|
||||
|
||||
# Location where temporary data goes. Only used for Oracle-specific create-user script
|
||||
# needs to be customized for the user if location is not appropriate, or always for unix
|
||||
data.dir=c:\\temp
|
||||
data.dir=c:\\temp
|
||||
|
||||
19
spring-ldap/docs/upgrade/src/readme.txt
Normal file
19
spring-ldap/docs/upgrade/src/readme.txt
Normal file
@@ -0,0 +1,19 @@
|
||||
This project uses the 'DocBook XSL distribution' for HTML and PDF
|
||||
generation of project upgrade documentation.
|
||||
|
||||
This project's build.xml file contains targets to generate the
|
||||
project upgrade documentation.
|
||||
|
||||
To generate project documentation, execute one of the following
|
||||
build targets:
|
||||
|
||||
* upgrade-all - generate documentation in all supported formats
|
||||
* upgrade-pdf - generate the PDF documentation
|
||||
* upgrade-html - generate the HTML documentation
|
||||
* upgrade-clean - clean any output directories for docs
|
||||
|
||||
For generation to complete successfully, you must have first extracted
|
||||
the .jar libraries contained in this archive:
|
||||
- http://static.springframework.org/spring/files/docbook-reference-libs.zip
|
||||
... to ${basedir}/docs/reference. If you have not yet done so, download this file
|
||||
and unzip the contents of the archive into ${basedir}/docs/reference.
|
||||
382
spring-ldap/docs/upgrade/src/upgrade.xml
Normal file
382
spring-ldap/docs/upgrade/src/upgrade.xml
Normal file
@@ -0,0 +1,382 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
|
||||
<article>
|
||||
<title>Upgrade Guide</title>
|
||||
|
||||
<section>
|
||||
<title>Upgrading from 1.1.x to 1.2</title>
|
||||
|
||||
<para><emphasis role="bold">Moved the core classes into the package
|
||||
ldap.core</emphasis></para>
|
||||
|
||||
<informaltable>
|
||||
<tgroup cols="3">
|
||||
<colspec align="left" />
|
||||
|
||||
<thead>
|
||||
<row>
|
||||
<entry align="center">Class</entry>
|
||||
|
||||
<entry align="center">Before</entry>
|
||||
|
||||
<entry align="center">After</entry>
|
||||
</row>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>AttributesMapper</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>AuthenticationSource</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>CollectingNameClassPair CallbackHandler</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>ContextAssembler</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>ContextExecutor</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>ContextMapper</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>ContextSource</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>DefaultNameClassPairMapper</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>DirContextProcessor</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>LdapOperations</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>LdapTemplate</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>NameClassPairCallbackHandler</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>NameClassPairMapper</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>SearchExecutor</entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
|
||||
<para><emphasis role="bold">Moved subpackages of ldap.support to top
|
||||
level</emphasis></para>
|
||||
|
||||
<informaltable>
|
||||
<tgroup cols="3">
|
||||
<colspec align="center" />
|
||||
|
||||
<thead>
|
||||
<row>
|
||||
<entry align="center">Class</entry>
|
||||
|
||||
<entry align="center">Before</entry>
|
||||
|
||||
<entry align="center">After</entry>
|
||||
</row>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>*</entry>
|
||||
|
||||
<entry>ldap.support.authentication</entry>
|
||||
|
||||
<entry>ldap.authentication</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>*</entry>
|
||||
|
||||
<entry>ldap.support.control</entry>
|
||||
|
||||
<entry>ldap.control</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>*</entry>
|
||||
|
||||
<entry>ldap.support.filter</entry>
|
||||
|
||||
<entry>ldap.filter</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
|
||||
<para><emphasis role="bold">Moved most classes in ldap.support to
|
||||
ldap.core or ldap.core.support</emphasis></para>
|
||||
|
||||
<informaltable>
|
||||
<tgroup cols="3">
|
||||
<colspec align="left" />
|
||||
|
||||
<thead>
|
||||
<row>
|
||||
<entry align="center">Class</entry>
|
||||
|
||||
<entry align="center">Before</entry>
|
||||
|
||||
<entry align="center">After</entry>
|
||||
</row>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>AbstractContextSource</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core.support</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>AggregateDirContextProcessor</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core.support</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>AttributeModificationsAware</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>CountNameClassPair CallbackHandler</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core.support</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>DefaultDirObjectFactory</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>DefaultDnParserFactory</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>DirContextAdapter</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>DirContextOperations</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>DirContextSource</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core.support</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>DistinguishedName</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>DnParser</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>LdapContextSource</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core.support</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>LdapEncoder</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>LdapRdn</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>LdapRdnComponent</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
|
||||
<entry>ldap.core</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
|
||||
<para><emphasis role="bold">Moved classes in ldap and ldap.util to
|
||||
ldap.support and removed ldap.util</emphasis></para>
|
||||
|
||||
<informaltable>
|
||||
<tgroup cols="3">
|
||||
<colspec align="left" />
|
||||
|
||||
<thead>
|
||||
<row>
|
||||
<entry align="center">Class</entry>
|
||||
|
||||
<entry align="center">Before</entry>
|
||||
|
||||
<entry align="center">After</entry>
|
||||
</row>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
<row>
|
||||
<entry><emphasis><emphasis>DefaultNamingExceptionTranslator</emphasis></emphasis></entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>LdapUtils</entry>
|
||||
|
||||
<entry>-</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>ListComparator</entry>
|
||||
|
||||
<entry>ldap.utils</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><emphasis><emphasis>NamingExceptionTranslator</emphasis></emphasis></entry>
|
||||
|
||||
<entry>ldap</entry>
|
||||
|
||||
<entry>ldap.support</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</section>
|
||||
</article>
|
||||
Reference in New Issue
Block a user