Author: veithen
Date: Sat May 15 17:19:44 2010
New Revision: 944684
URL: http://svn.apache.org/viewvc?rev=944684&view=rev
Log:
Added some notes about pre-release checks.
Added:
webservices/commons/trunk/modules/axiom/src/docbkx/images/sonarj-939984.png
(with props)
webservices/commons/trunk/modules/axiom/src/docbkx/images/sonarj-944680.png
(with props)
Modified:
webservices/commons/trunk/modules/axiom/src/docbkx/devguide.xml
Modified: webservices/commons/trunk/modules/axiom/src/docbkx/devguide.xml
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/src/docbkx/devguide.xml?rev=944684&r1=944683&r2=944684&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/src/docbkx/devguide.xml (original)
+++ webservices/commons/trunk/modules/axiom/src/docbkx/devguide.xml Sat May 15
17:19:44 2010
@@ -168,6 +168,37 @@ javax.xml.stream.XMLOutputFactory=com.be
and if necessary, change the parent of the Axiom root
POM.
</para>
</listitem>
+ <listitem>
+ <para>
+ Check the dependencies between Java packages in the
<filename>axiom-api</filename> module.
+ The <package>org.apache.axiom.util</package> package
(including its subpackages) is specified
+ to contain utility classes that don't depend on higher
level APIs. More precisely,
+ <package>org.apache.axiom.util</package> should only
have dependencies on
+ <package>org.apache.axiom.ext</package>, but not e.g.
on <package>org.apache.axiom.om</package>.
+ <ulink
url="http://www.hello2morrow.com/products/sonarj";>SonarJ</ulink> can be used
+ to check these dependencies. The following figure
shows the expected structure:
+ </para>
+ <figure>
+ <title>Package dependencies for r944680</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="sonarj-944680.png"
format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ In contrast, the following figure shows an earlier
trunk version of <filename>axiom-api</filename>
+ with incorrect layering and cyclic dependencies
involving <package>org.apache.axiom.util</package>:
+ </para>
+ <figure>
+ <title>Package dependencies for r939984</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="sonarj-939984.png"
format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
</itemizedlist>
</section>
</chapter>
@@ -443,4 +474,4 @@ writer.writeNamespace("p", "urn:ns1");</
</procedure>
</section>
</appendix>
-</book>
\ No newline at end of file
+</book>
Added:
webservices/commons/trunk/modules/axiom/src/docbkx/images/sonarj-939984.png
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/src/docbkx/images/sonarj-939984.png?rev=944684&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
webservices/commons/trunk/modules/axiom/src/docbkx/images/sonarj-939984.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added:
webservices/commons/trunk/modules/axiom/src/docbkx/images/sonarj-944680.png
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/src/docbkx/images/sonarj-944680.png?rev=944684&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
webservices/commons/trunk/modules/axiom/src/docbkx/images/sonarj-944680.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
