[jboss-svn-commits] JBL Code SVN: r13914 - in labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src: site and 1 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Tue Jul 31 12:38:41 EDT 2007
Author: pgier
Date: 2007-07-31 12:38:41 -0400 (Tue, 31 Jul 2007)
New Revision: 13914
Added:
labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/
labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/apt/
labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/apt/index.apt
labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/apt/usage.apt
labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/site.xml
Log:
Adding a basic site configuration.
Added: labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/apt/index.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/apt/index.apt (rev 0)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/apt/index.apt 2007-07-31 16:38:41 UTC (rev 13914)
@@ -0,0 +1,55 @@
+ ------
+ Introduction
+ ------
+ Paul Gier
+ ------
+ 31 July 2007
+ ------
+
+~~ Copyright © 2007 Red Hat Middleware, LLC. All rights reserved.
+~~
+~~ This copyrighted material is made available to anyone wishing to use, modify,
+~~ copy, or redistribute it subject to the terms and conditions of the GNU
+~~ Lesser General Public License, v. 2.1. This program is distributed in the
+~~ hope that it will be useful, but WITHOUT A WARRANTY; without even the implied
+~~ warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+~~ Lesser General Public License for more details. You should have received a
+~~ copy of the GNU Lesser General Public License, v.2.1 along with this
+~~ distribution; if not, write to the Free Software Foundation, Inc.,
+~~ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+~~
+~~ Red Hat Author(s): Paul Gier
+
+jBoss-retro Plugin
+
+ JBoss-retro is a tool for transforming compiled byte code from one format to
+ another. For example, classes can be renamed, method calls can be redirected
+ and data types can be changed. One usage of this is to allow translation
+ of jdk1.5 byte code to an equivalent that can be used in a jdk1.4 jvm.
+ Potentially it could be used to make other byte code transformations as well.
+
+* Goals Overview
+
+ The <JBoss-Retro Plugin> allows a maven based build to use the JBoss Retro
+ software. The available goals currently include goals for transforming
+ main or test classes, and for verifying jdk1.5 to 1.4 translated byte code.
+
+ [weave] binds the {{{weave-mojo.html}jboss-retro:weave}}
+ goal which uses a weaver class to weave the byte code in the main
+ classes directory (target/classes). By default it runs during
+ the process-classes phase of the build, but can be configured to run at
+ a different phase, and/or weave classes in another directory.
+
+ [weave-tests] binds the {{{weave-tests-mojo.html}jboss-retro:weave-tests}} goal.
+ This is a subclass of the weave mojo, and provides the same functionality
+ but it defaults to binding to the process-test-classes phase and weaving
+ the test classes in target/test-classes.
+
+ [retro-check] binds the {{{retro-check-mojo.html}jboss-retro:retro-check}} goal.
+ This goal is only meant to be used when using the jdk1.5 to jdk1.4 byte
+ code weaver. It provides an additional check to make sure that the weave
+ was successful.
+
+* Usage
+
+ Detailed usage instructions for the <JBoss-Retro Plugin> can be found {{{usage.html}here}}.
Added: labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/apt/usage.apt
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/apt/usage.apt (rev 0)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/apt/usage.apt 2007-07-31 16:38:41 UTC (rev 13914)
@@ -0,0 +1,111 @@
+ ------
+ Usage
+ ------
+ Paul Gier
+ ------
+ 31 July 2007
+ ------
+
+~~ Copyright © 2007 Red Hat Middleware, LLC. All rights reserved.
+~~
+~~ This copyrighted material is made available to anyone wishing to use, modify,
+~~ copy, or redistribute it subject to the terms and conditions of the GNU
+~~ Lesser General Public License, v. 2.1. This program is distributed in the
+~~ hope that it will be useful, but WITHOUT A WARRANTY; without even the implied
+~~ warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+~~ Lesser General Public License for more details. You should have received a
+~~ copy of the GNU Lesser General Public License, v.2.1 along with this
+~~ distribution; if not, write to the Free Software Foundation, Inc.,
+~~ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+~~
+~~ Red Hat Author(s): Paul Gier
+
+Usage
+
+ The <JBoss-Retro Plugin> transforms compiled byte code using javassist.
+ By default no transformation will take place, so a basic configuration
+ normally includes a weaverClass. This weaver class is a subclass
+ of org.jboss.weaver.Weaver from the jboss-retro project.
+
+ For example, a jdk1.5 to jdk1.4 translator is included in jboss-retro, and
+ can be used with the following configuration.
+
+* Minimal configuration
+
++----+
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jboss-retro-plugin</artifactId>
+ <configuration>
+ <weaverClass>org.jboss.weaver.retro.WeaverRetroJdk14</weaverClass>
+ </configuration>
+ <executions>
+ <execution>
+ <id>weave-classes</id>
+ <goals>
+ <goal>weave</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
++----+
+
+ This will output the transformed classes into the directory target/classes-weaved
+
+ The <jboss-retro Plugin> also includes goals for weaving the test classes, and for
+ performing a validation check on the weaved code. Note: the [retro-check] goal
+ is only useful when using the jdk1.5 to jdk1.4 transformation.
+
+* More complex configuration
+
++----+
+ <plugin>
+ <groupId>org.jboss.maven.plugins</groupId>
+ <artifactId>maven-jboss-retro-plugin</artifactId>
+ <configuration>
+ <weaveClassifier>jdk14</weaveClassifier>
+ <weaverClass>org.jboss.weaver.retro.WeaverRetroJdk14</weaverClass>
+ </configuration>
+ <executions>
+ <execution>
+ <id>weave-classes</id>
+ <goals>
+ <goal>weave</goal>
+ </goals>
+ </execution>
+ <execution>
+ <id>weave-test-classes</id>
+ <goals>
+ <goal>weave-tests</goal>
+ </goals>
+ </execution>
+ <execution>
+ <id>check-weave</id>
+ <goals>
+ <goal>retro-check</goal>
+ </goals>
+ <configuration>
+ <checkDirectory>classes-jdk14</checkDirectory>
+ <jvm>${java14_home}/bin/${javaExecutable}</jvm>
+ </configuration>
+ </execution>
+ <execution>
+ <id>check-weave-tests</id>
+ <goals>
+ <goal>retro-check</goal>
+ </goals>
+ <configuration>
+ <checkDirectory>test-classes-jdk14</checkDirectory>
+ <jvm>${java14_home}/bin/${javaExecutable}</jvm>
+ </configuration>
+ </execution>
+ </executions>
+ <dependencies>
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>3.8.1</version>
+ </dependency>
+ </dependencies>
+ </plugin>
++----+
\ No newline at end of file
Added: labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/site.xml
===================================================================
--- labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/site.xml (rev 0)
+++ labs/jbossbuild/maven-plugins/trunk/maven-jboss-retro-plugin/src/site/site.xml 2007-07-31 16:38:41 UTC (rev 13914)
@@ -0,0 +1,27 @@
+<project name="JBoss Retro">
+ <bannerLeft>
+ <name>JBoss Retro</name>
+ <href>http://www.jboss.org/jbossretro</href>
+ </bannerLeft>
+ <bannerRight>
+ <name>JBoss.org</name>
+ <src>http://www.jboss.org/junk</src>
+ </bannerRight>
+ <skin>
+ <groupId>org.jboss.maven.skins</groupId>
+ <artifactId>maven-body-only-skin</artifactId>
+ </skin>
+ <publishDate format="dd MMM yyyy" />
+ <body>
+ <links>
+ <item name="JBoss" href="http://www.jboss.org/"/>
+ </links>
+ <head>
+ <meta name="faq" content="proficio"/>
+ </head>
+ <menu name="Quick Links">
+ <item name="Features" href="/maven-features.html"/>
+ </menu>
+ ${reports}
+ </body>
+</project>
More information about the jboss-svn-commits
mailing list