From d27581619666930224497aec9263eb28f1a15633 Mon Sep 17 00:00:00 2001 From: Ulrik Sandberg Date: Sun, 8 Apr 2007 23:54:39 +0000 Subject: [PATCH] Added support for generating an upgrade guide. --- common-build/doc-targets.xml | 95 +++++- common-build/project.properties | 11 +- spring-ldap/docs/upgrade/src/readme.txt | 19 ++ spring-ldap/docs/upgrade/src/upgrade.xml | 382 +++++++++++++++++++++++ 4 files changed, 505 insertions(+), 2 deletions(-) create mode 100644 spring-ldap/docs/upgrade/src/readme.txt create mode 100644 spring-ldap/docs/upgrade/src/upgrade.xml diff --git a/common-build/doc-targets.xml b/common-build/doc-targets.xml index 895439fe..139f3e3f 100644 --- a/common-build/doc-targets.xml +++ b/common-build/doc-targets.xml @@ -154,4 +154,97 @@ to see a list of all relevant targets. - \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/common-build/project.properties b/common-build/project.properties index d76f6920..7ffab00c 100644 --- a/common-build/project.properties +++ b/common-build/project.properties @@ -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 \ No newline at end of file +data.dir=c:\\temp diff --git a/spring-ldap/docs/upgrade/src/readme.txt b/spring-ldap/docs/upgrade/src/readme.txt new file mode 100644 index 00000000..fecf1c5c --- /dev/null +++ b/spring-ldap/docs/upgrade/src/readme.txt @@ -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. diff --git a/spring-ldap/docs/upgrade/src/upgrade.xml b/spring-ldap/docs/upgrade/src/upgrade.xml new file mode 100644 index 00000000..061a91ce --- /dev/null +++ b/spring-ldap/docs/upgrade/src/upgrade.xml @@ -0,0 +1,382 @@ + + +
+ Upgrade Guide + +
+ Upgrading from 1.1.x to 1.2 + + Moved the core classes into the package + ldap.core + + + + + + + + Class + + Before + + After + + + + + + AttributesMapper + + ldap + + ldap.core + + + + AuthenticationSource + + ldap + + ldap.core + + + + CollectingNameClassPair CallbackHandler + + ldap + + ldap.core + + + + ContextAssembler + + ldap + + ldap.core + + + + ContextExecutor + + ldap + + ldap.core + + + + ContextMapper + + ldap + + ldap.core + + + + ContextSource + + ldap + + ldap.core + + + + DefaultNameClassPairMapper + + ldap + + ldap.core + + + + DirContextProcessor + + ldap + + ldap.core + + + + LdapOperations + + ldap + + ldap.core + + + + LdapTemplate + + ldap + + ldap.core + + + + NameClassPairCallbackHandler + + ldap + + ldap.core + + + + NameClassPairMapper + + ldap + + ldap.core + + + + SearchExecutor + + ldap + + ldap.core + + + + + + Moved subpackages of ldap.support to top + level + + + + + + + + Class + + Before + + After + + + + + + * + + ldap.support.authentication + + ldap.authentication + + + + * + + ldap.support.control + + ldap.control + + + + * + + ldap.support.filter + + ldap.filter + + + + + + Moved most classes in ldap.support to + ldap.core or ldap.core.support + + + + + + + + Class + + Before + + After + + + + + + AbstractContextSource + + ldap.support + + ldap.core.support + + + + AggregateDirContextProcessor + + ldap.support + + ldap.core.support + + + + AttributeModificationsAware + + ldap.support + + ldap.core + + + + CountNameClassPair CallbackHandler + + ldap.support + + ldap.core.support + + + + DefaultDirObjectFactory + + ldap.support + + ldap.core + + + + DefaultDnParserFactory + + ldap.support + + ldap.core + + + + DirContextAdapter + + ldap.support + + ldap.core + + + + DirContextOperations + + ldap.support + + ldap.core + + + + DirContextSource + + ldap.support + + ldap.core.support + + + + DistinguishedName + + ldap.support + + ldap.core + + + + DnParser + + ldap.support + + ldap.core + + + + LdapContextSource + + ldap.support + + ldap.core.support + + + + LdapEncoder + + ldap.support + + ldap.core + + + + LdapRdn + + ldap.support + + ldap.core + + + + LdapRdnComponent + + ldap.support + + ldap.core + + + + + + Moved classes in ldap and ldap.util to + ldap.support and removed ldap.util + + + + + + + + Class + + Before + + After + + + + + + DefaultNamingExceptionTranslator + + ldap + + ldap.support + + + + LdapUtils + + - + + ldap.support + + + + ListComparator + + ldap.utils + + ldap.support + + + + NamingExceptionTranslator + + ldap + + ldap.support + + + + +
+
\ No newline at end of file