You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openjpa.apache.org by mp...@apache.org on 2006/09/16 20:17:49 UTC
svn commit: r446907 - in /incubator/openjpa/trunk: ./ openjpa-project/
openjpa-project/src/doc/manual/css/ openjpa-project/src/doc/manual/img/
openjpa-project/src/site/resources/css/
openjpa-project/src/site/resources/manual/img/
Author: mprudhom
Date: Sat Sep 16 11:17:47 2006
New Revision: 446907
URL: http://svn.apache.org/viewvc?view=rev&rev=446907
Log:
Reorganized documentation do that it will be inlcuded in the openjpa-*.zip bundle when running 'mvn package -Pjavadoc-profile,docbook-profile'
Added:
incubator/openjpa/trunk/openjpa-project/src/doc/manual/css/
- copied from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/css/
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/
- copied from r446894, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/appid-hierarchy.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/appid-hierarchy.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/basic-coll.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/basic-coll.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/embedded-coll.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/embedded-coll.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/enhancement.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/enhancement.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/entitymanager.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/entitymanager.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/entitymanagerfactory.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/entitymanagerfactory.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/inher-superclass-table.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/inher-superclass-table.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/inher-tpc.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/inher-tpc.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/inv-key-coll.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/inv-key-coll.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/joins-constant.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/joins-constant.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-arch.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-arch.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-assoc-table.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-assoc-table.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-basic-field.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-basic-field.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-data-model.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-data-model.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-direct-relation.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-direct-relation.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-discrim-all.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-discrim-all.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-embedded.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-embedded.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-exceptions.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-exceptions.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-inher-all.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-inher-all.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-inher-joined.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-inher-joined.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-map.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-map.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-mapping-identity.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-mapping-identity.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-meta-model.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-meta-model.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-query.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-query.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-state-transitions.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-state-transitions.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/jpa-transaction.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/jpa-transaction.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/persistence.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/persistence.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/secondary-table.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/secondary-table.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/sqlquery-model.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/sqlquery-model.png
incubator/openjpa/trunk/openjpa-project/src/doc/manual/img/string-rel-map.png
- copied unchanged from r446905, incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/string-rel-map.png
Removed:
incubator/openjpa/trunk/openjpa-project/src/site/resources/css/
incubator/openjpa/trunk/openjpa-project/src/site/resources/manual/img/
Modified:
incubator/openjpa/trunk/openjpa-project/assembly.xml
incubator/openjpa/trunk/openjpa-project/pom.xml
incubator/openjpa/trunk/pom.xml
Modified: incubator/openjpa/trunk/openjpa-project/assembly.xml
URL: http://svn.apache.org/viewvc/incubator/openjpa/trunk/openjpa-project/assembly.xml?view=diff&rev=446907&r1=446906&r2=446907
==============================================================================
--- incubator/openjpa/trunk/openjpa-project/assembly.xml (original)
+++ incubator/openjpa/trunk/openjpa-project/assembly.xml Sat Sep 16 11:17:47 2006
@@ -21,18 +21,26 @@
</includes>
</fileSet>
<fileSet>
- <directory>target/manual/OpenJPA</directory>
- <outputDirectory>/manual</outputDirectory>
+ <directory>target/examples</directory>
+ <outputDirectory>/examples</outputDirectory>
</fileSet>
+ -->
<fileSet>
- <directory>../target/site/apidocs</directory>
- <outputDirectory>/javadoc</outputDirectory>
+ <directory>target/manual</directory>
+ <outputDirectory>docs/manual</outputDirectory>
</fileSet>
<fileSet>
- <directory>target/examples</directory>
- <outputDirectory>/examples</outputDirectory>
+ <directory>src/doc/manual/img</directory>
+ <outputDirectory>docs/manual/img</outputDirectory>
+ </fileSet>
+ <fileSet>
+ <directory>src/doc/manual/css</directory>
+ <outputDirectory>docs/manual/css</outputDirectory>
+ </fileSet>
+ <fileSet>
+ <directory>../target/site/apidocs</directory>
+ <outputDirectory>docs/javadoc</outputDirectory>
</fileSet>
- -->
</fileSets>
<dependencySets>
<dependencySet>
Modified: incubator/openjpa/trunk/openjpa-project/pom.xml
URL: http://svn.apache.org/viewvc/incubator/openjpa/trunk/openjpa-project/pom.xml?view=diff&rev=446907&r1=446906&r2=446907
==============================================================================
--- incubator/openjpa/trunk/openjpa-project/pom.xml (original)
+++ incubator/openjpa/trunk/openjpa-project/pom.xml Sat Sep 16 11:17:47 2006
@@ -32,57 +32,6 @@
</resources>
<plugins>
- <!-- build the docs when creating the site from docbook source -->
- <plugin>
- <artifactId>maven-antrun-plugin</artifactId>
- <executions>
- <execution>
- <phase>site</phase>
- <configuration>
- <!-- destdir="${project.build.directory}/site/manual" -->
- <tasks>
- <echo>Building docbook manual</echo>
-
- <!-- download stylesheets -->
- <property name="stylesheet" value="1.69.1.tar.bz2"/>
- <property name="stylesheet.dir" value="${project.basedir}/target/stylesheets"/>
-
- <mkdir dir="${stylesheet.dir}"/>
- <get src="http://docbook.sourceforge.net/release/xsl/${stylesheet}" usetimestamp="true" dest="${stylesheet.dir}/${stylesheet}"/>
- <untar src="${stylesheet.dir}/${stylesheet}" dest="${stylesheet.dir}" compression="bzip2" overwrite="false"/>
-
-
- <style includes="**/manual.xml"
- force="true"
- basedir="${project.basedir}/src/doc/manual"
- destdir="${project.basedir}/target/filtered-site/resources/manual"
- style="manual-xhtml.xsl"
- classpathref="maven.runtime.classpath">
- <factory name="org.apache.xalan.processor.TransformerFactoryImpl">
- <attribute name="http://xml.apache.org/xalan/features/optimize" value="true"/>
- </factory>
- </style>
-
- <!--
- <style includes="**/manual.xml"
- force="true"
- basedir="${project.basedir}/src/doc/manual"
- destdir="${project.basedir}/target/filtered-site/resources/manual"
- style="manual-xhtml-chunk.xsl"
- classpathref="maven.runtime.classpath">
- <factory name="org.apache.xalan.processor.TransformerFactoryImpl">
- <attribute name="http://xml.apache.org/xalan/features/optimize" value="true"/>
- </factory>
- </style>
- -->
- </tasks>
- </configuration>
- <goals>
- <goal>run</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<executions>
@@ -143,6 +92,77 @@
</plugin>
</plugins>
</build>
+
+ <profiles>
+ <!--
+ Docbook profile. Docs can be built by running:
+ mvn package -Dtest=false -Pjavadoc-profile,docbook-profile
+ -->
+ <profile>
+ <id>docbook-profile</id>
+ <build>
+ <plugins>
+ <!-- build the docs when creating the site from docbook source -->
+ <plugin>
+ <artifactId>maven-antrun-plugin</artifactId>
+ <executions>
+ <execution>
+ <phase>package</phase>
+ <configuration>
+ <!-- destdir="${project.build.directory}/site/manual" -->
+ <tasks>
+ <echo>Building docbook manual</echo>
+
+ <!-- download stylesheets -->
+ <property name="stylesheet" value="1.69.1.tar.bz2"/>
+ <property name="stylesheet.dir" value="${project.basedir}/target/stylesheets"/>
+
+ <mkdir dir="${stylesheet.dir}"/>
+ <get src="http://docbook.sourceforge.net/release/xsl/${stylesheet}" usetimestamp="true" dest="${stylesheet.dir}/${stylesheet}"/>
+ <untar src="${stylesheet.dir}/${stylesheet}" dest="${stylesheet.dir}" compression="bzip2" overwrite="false"/>
+
+
+ <style includes="**/manual.xml"
+ force="true"
+ basedir="${project.basedir}/src/doc/manual"
+ destdir="${project.basedir}/target/manual"
+ style="manual-xhtml.xsl"
+ classpathref="maven.runtime.classpath">
+ <factory name="org.apache.xalan.processor.TransformerFactoryImpl">
+ <attribute name="http://xml.apache.org/xalan/features/optimize" value="true"/>
+ </factory>
+ </style>
+
+ <!--
+ <style includes="**/manual.xml"
+ force="true"
+ basedir="${project.basedir}/src/doc/manual"
+ destdir="${project.basedir}/target/manual"
+ style="manual-xhtml-chunk.xsl"
+ classpathref="maven.runtime.classpath">
+ <factory name="org.apache.xalan.processor.TransformerFactoryImpl">
+ <attribute name="http://xml.apache.org/xalan/features/optimize" value="true"/>
+ </factory>
+ </style>
+ -->
+ </tasks>
+ </configuration>
+ <goals>
+ <goal>run</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ <activation>
+ <property>
+ <name>builddocs</name>
+ <value>true</value>
+ </property>
+ </activation>
+ </profile>
+ </profiles>
<!-- need to explicitly list dependencies for assembly to work -->
<dependencies>
Modified: incubator/openjpa/trunk/pom.xml
URL: http://svn.apache.org/viewvc/incubator/openjpa/trunk/pom.xml?view=diff&rev=446907&r1=446906&r2=446907
==============================================================================
--- incubator/openjpa/trunk/pom.xml (original)
+++ incubator/openjpa/trunk/pom.xml Sat Sep 16 11:17:47 2006
@@ -123,7 +123,46 @@
<module>openjpa-project</module>
</modules>
</profile>
+ <profile>
+ <!--
+ Javadoc profile. Docs can be built by running:
+ mvn package -Dtest=false -Pjavadoc-profile,docbook-profile
+ -->
+ <id>javadoc-profile</id>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <executions>
+ <execution>
+ <phase>package</phase>
+ <goals><goal>javadoc</goal></goals>
+ <configuration>
+ <aggregate>true</aggregate>
+ <!-- <linksource>true</linksource> -->
+ <maxmemory>512m</maxmemory>
+ <links>
+ <link>http://java.sun.com/j2se/1.5.0/docs/api</link>
+ <link>http://java.sun.com/javaee/5/docs/api</link>
+ <link>http://jakarta.apache.org/commons/collections/api-release</link>
+ </links>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ <activation>
+ <property>
+ <name>builddocs</name>
+ <value>true</value>
+ </property>
+ </activation>
+ </profile>
+
</profiles>
+
<repositories>
<repository>
<id>central</id>
@@ -184,24 +223,10 @@
<groupId>org.codehaus.mojo</groupId>
<artifactId>taglist-maven-plugin</artifactId>
</plugin>
- <!--
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <aggregate>true</aggregate>
- <linksource>true</linksource>
- <maxmemory>512m</maxmemory>
- <links>
- <link>http://java.sun.com/j2se/1.5.0/docs/api</link>
- <link>http://java.sun.com/javaee/5/docs/api</link>
- <link>http://jakarta.apache.org/commons/collections/api-release</link>
- </links>
- </configuration>
- </plugin>
- -->
</plugins>
</reporting>
+
+
<distributionManagement>
<repository>
<id>people.apache.org</id>