12:43 p.m.
Author: rhauch
Date: 2009-09-12 13:43:41 -0400 (Sat, 12 Sep 2009)
New Revision: 1217
Modified:
trunk/build/assembly/dist.xml
trunk/build/assembly/javadoc.xml
trunk/docs/reference/src/main/docbook/en-US/content/developers/tools.xml
trunk/extensions/dna-connector-infinispan/pom.xml
trunk/pom.xml
Log:
Updated the Maven components that build the JavaDoc, and also revised the documentation
describing the Maven command to perform a full build/assembly so that the
'javadoc:javadoc' goal is no longer needed as it is added by the
'assembly' profile.
Modified: trunk/build/assembly/dist.xml
===================================================================
--- trunk/build/assembly/dist.xml 2009-09-12 01:32:07 UTC (rev 1216)
+++ trunk/build/assembly/dist.xml 2009-09-12 17:43:41 UTC (rev 1217)
@@ -25,8 +25,8 @@
<!--
Gather into the distribution the JavaDoc for all projects
-->
- <directory>target/site/apidocs</directory>
- <outputDirectory>apidocs</outputDirectory>
+ <directory>target/site/api</directory>
+ <outputDirectory>api</outputDirectory>
</fileSet>
<fileSet>
<!--
Modified: trunk/build/assembly/javadoc.xml
===================================================================
--- trunk/build/assembly/javadoc.xml 2009-09-12 01:32:07 UTC (rev 1216)
+++ trunk/build/assembly/javadoc.xml 2009-09-12 17:43:41 UTC (rev 1217)
@@ -26,8 +26,8 @@
<!--
Gather into the distribution the JavaDoc for all projects
-->
- <directory>target/site/apidocs</directory>
- <outputDirectory>apidocs</outputDirectory>
+ <directory>target/api</directory>
+ <outputDirectory>api</outputDirectory>
</fileSet>
</fileSets>
</assembly>
Modified: trunk/docs/reference/src/main/docbook/en-US/content/developers/tools.xml
===================================================================
--- trunk/docs/reference/src/main/docbook/en-US/content/developers/tools.xml 2009-09-12
01:32:07 UTC (rev 1216)
+++ trunk/docs/reference/src/main/docbook/en-US/content/developers/tools.xml 2009-09-12
17:43:41 UTC (rev 1217)
@@ -402,18 +402,17 @@
<note>
<para>
Before running Maven commands to build the releases, increase the memory available
to Maven with this command:
- <code>$ export MAVEN_OPTS=-Xmx256m</code>
+ <code>$ export MAVEN_OPTS=-Xmx512m</code>
</para>
</note>
<para>
- To perform this complete build, issue the following command while in the
<code>target/</code> directory:
+ To perform this complete build, issue the following command while in the
<code>trunk/</code> directory:
</para>
- <programlisting>$ mvn -P assembly clean javadoc:javadoc
install</programlisting>
+ <programlisting>$ mvn -P assembly clean install</programlisting>
<para>
- This command runs the "clean", "javadoc:javadoc", and
"install" goals using the "assembly" profile,
+ This command runs the "clean" and "install" goals using the
"assembly" profile,
which adds the production of JavaDocs, the Getting Started document, the Reference
Guide document,
- the Getting Started examples, and several ZIP archives. The order of the goals is
important,
- since the "install" goal attempts to include the JavaDoc in the archives.
+ the Getting Started examples, integration tests, and several ZIP archives. The order
of the goals is important.
</para>
<para>
After this build has completed, verify that the assemblies under
<code>target/</code> have actually been created and that
@@ -435,7 +434,7 @@
The next step is to ensure that all information in the POM is correct and contains
all the information required for
the release process. This is called a <emphasis>dry run</emphasis>, and
is done with the Maven "release" plugin:
</para>
- <programlisting>$ mvn -Passembly release:prepare
-DdryRun=true</programlisting>
+ <programlisting>$ mvn -P assembly release:prepare
-DdryRun=true</programlisting>
<para>
This may download a lot of Maven plugins if they already haven't been downloaded,
but it will eventually prompt you for
the release version of each of the Maven projects, the tag name for the release, and
the next development versions
@@ -445,14 +444,14 @@
<para>
After the dry run completes you should clean up the files that the release plugin
created in the dry run:
</para>
- <programlisting>$ mvn -Passembly release:clean</programlisting>
+ <programlisting>$ mvn -P assembly release:clean</programlisting>
</sect2>
<sect2 id="prepare-release">
<title>Prepare for the release</title>
<para>
Run the prepare step (without the <code>dryRun</code> option):
</para>
- <programlisting>$ mvn -Passembly release:prepare</programlisting>
+ <programlisting>$ mvn -P assembly release:prepare</programlisting>
<para>
You will again be prompted for the release versions and tag name. These should be the
same as what was used during the dry run.
This will run the same steps as the dry run, with the additional step of tagging the
release in SVN.
Modified: trunk/extensions/dna-connector-infinispan/pom.xml
===================================================================
--- trunk/extensions/dna-connector-infinispan/pom.xml 2009-09-12 01:32:07 UTC (rev 1216)
+++ trunk/extensions/dna-connector-infinispan/pom.xml 2009-09-12 17:43:41 UTC (rev 1217)
@@ -50,7 +50,7 @@
<dependency>
<groupId>org.infinispan</groupId>
<artifactId>infinispan-core</artifactId>
- <version>4.0.0.ALPHA5</version>
+ <version>4.0.0.BETA1</version>
</dependency>
<!--
Testing (note the scope)
Modified: trunk/pom.xml
===================================================================
--- trunk/pom.xml 2009-09-12 01:32:07 UTC (rev 1216)
+++ trunk/pom.xml 2009-09-12 17:43:41 UTC (rev 1217)
@@ -264,34 +264,6 @@
<artifactId>maven-jar-plugin</artifactId>
<version>2.2</version>
</plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>2.2</version>
- <configuration>
- <aggregate>true</aggregate>
- <doclet>net.gleamynode.apiviz.APIviz</doclet>
- <docletArtifact>
- <groupId>net.gleamynode.apiviz</groupId>
- <artifactId>apiviz</artifactId>
- <version>1.1.1</version>
- </docletArtifact>
- <additionalparam>
- -charset UTF-8
- -docencoding UTF-8
- -version
- -author
- -breakiterator
- -linksource
- -sourcetab 4
- -windowtitle "${project.name} ${project.version} API Reference"
- -doctitle "${project.name} ${project.version} API Reference"
- -bottom "Copyright © ${project.inceptionYear}-Present JBoss a division
of Red Hat. All Rights Reserved."
- -link http://java.sun.com/javase/6/docs/api/
- </additionalparam>
- <encoding>UTF-8</encoding>
- </configuration>
- </plugin>
</plugins>
</pluginManagement>
<plugins>
@@ -373,6 +345,64 @@
</archive>
</configuration>
</plugin>
+ <plugin>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.5</version>
+ <executions>
+ <execution>
+ <id>generate-javadoc</id>
+ <phase>package</phase>
+ <goals>
+ <goal>javadoc</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <doclet>org.jboss.apiviz.APIviz</doclet>
+ <docletArtifact>
+ <groupId>org.jboss.apiviz</groupId>
+ <artifactId>apiviz</artifactId>
+ <version>1.3.0.GA</version>
+ </docletArtifact>
+ <attach>false</attach>
+
<!--stylesheetfile>${basedir}/src/javadoc/stylesheet.css</stylesheetfile-->
+ <useStandardDocletOptions>true</useStandardDocletOptions>
+ <outputDirectory>${project.build.directory}/api</outputDirectory>
+
<reportOutputDirectory>${project.build.directory}/api</reportOutputDirectory>
+ <destDir>api</destDir>
+ <charset>UTF-8</charset>
+ <docencoding>UTF-8</docencoding>
+ <breakiterator>true</breakiterator>
+ <version>true</version>
+ <author>true</author>
+ <keywords>true</keywords>
+ <overview>${basedir}/src/javadoc/overview.html</overview>
+ <doctitle>${project.name} API Reference
(${project.version})</doctitle>
+ <windowtitle>${project.name} API Reference
(${project.version})</windowtitle>
+ <maxmemory>1024m</maxmemory>
+ <additionalparam>
+ -link http://java.sun.com/javase/6/docs/api/
+ -link http://java.sun.com/products/servlet/2.5/docs/servlet-2_5-mr2/
+ -link http://www.slf4j.org/apidocs/
+ -link http://logging.apache.org/log4j/1.2/apidocs/
+
+ -group "JCR implementation"
${project.groupId}.jcr*:${project.groupId}.cnd*
+ -group "Repository engine" ${project.groupId}.repository*
+ -group "Graph API"
${project.groupId}.graph:${project.groupId}.graph.io*:${project.groupId}.graph.property*:${project.groupId}.graph.request*:${project.groupId}.graph.session*:${project.groupId}.graph.xml*
+ -group "Connectors"
${project.groupId}.graph.cache*:${project.groupId}.graph.connector*:${project.groupId}.connector*
+ -group "Observation" ${project.groupId}.graph.observation*
+ -group "Sequencers"
${project.groupId}.graph.sequencer*:${project.groupId}.sequencer*
+ -group "MIME type detectors"
${project.groupId}.graph.mimetype*:${project.groupId}.mimetype*
+ -group "Web services" ${project.groupId}.web*
+ -group "Common utilities" ${project.groupId}.common*
+
+ -nopackagediagram
+ </additionalparam>
+ <encoding>UTF-8</encoding>
+ <locale>en_US</locale>
+
<excludePackageNames>${project.groupId}.test*:org.jboss.example.dna*</excludePackageNames>
+ </configuration>
+ </plugin>
</plugins>
</build>
<!--
@@ -490,26 +520,6 @@
<artifactId>joda-time</artifactId>
<version>1.4</version>
</dependency>
- <!--
- Rules
- -->
- <dependency>
- <groupId>jsr94</groupId>
- <artifactId>jsr94</artifactId>
- <version>1.1</version>
- </dependency>
- <dependency>
- <groupId>org.drools</groupId>
- <artifactId>drools-jsr94</artifactId>
- <version>4.0.7</version>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>org.drools</groupId>
- <artifactId>drools-compiler</artifactId>
- <version>4.0.7</version>
- <scope>test</scope>
- </dependency>
<!-- Testing (note the scope) -->
<dependency>
<groupId>junit</groupId>
@@ -584,8 +594,6 @@
<version>10.2.1.6</version>
<scope>test</scope>
</dependency>
-
-
</dependencies>
</dependencyManagement>
<reporting>
@@ -598,19 +606,6 @@
</reporting>
<repositories>
- <repository>
- <id>apiviz.release</id>
- <name>APIviz releases</name>
- <url>http://apiviz.googlecode.com/svn/site/repo/mvn/release</url>
- <releases>
- <enabled>true</enabled>
- </releases>
- <snapshots>
- <enabled>false</enabled>
- </snapshots>
- </repository>
-
-
<repository>
<id>jboss</id>
<url>http://repository.jboss.com/maven2</url>