Menu
▾
▴
[Jboss-svn-commits] JBL Code SVN: r4270 - in labs/jbossrules/trunk/documentation: manual/en/Chapter-Install training/developers-course
|
From: <jbo...@li...> - 2006-05-17 04:38:27
|
Author: mic...@jb...
Date: 2006-05-17 00:38:15 -0400 (Wed, 17 May 2006)
New Revision: 4270
Modified:
labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Eclipse.xml
labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml
labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Setup.xml
labs/jbossrules/trunk/documentation/training/developers-course/course_outline.odt
Log:
doco for ANT
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Eclipse.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Eclipse.xml 2006-05-17 03:50:06 UTC (rev 4269)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Eclipse.xml 2006-05-17 04:38:15 UTC (rev 4270)
@@ -5,6 +5,11 @@
<section>
<title>Generating Eclipse Projects</title>
+ <para>
+ The drools project has eclipse projects checked in for convenience. However, these are originally generated by maven 2.
+ If you have maven 2 installed, you can also regenerate the eclipse projects automatically, or even generate it for IntelliJ etc, see the instructions below for this (most people can ignore this section)
+ </para>
+
<para><indexterm>
<primary>maven</primary>
</indexterm>Maven is able to generate standard <indexterm>
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml 2006-05-17 03:50:06 UTC (rev 4269)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Maven_build.xml 2006-05-17 04:38:15 UTC (rev 4270)
@@ -7,61 +7,100 @@
<para>Now that we have the source the next step is to build and install
the source. We do this with <indexterm>
- <primary>maven</primary>
- </indexterm>Maven 2, which will also handle the downloading of required
- dependencies.</para>
+ <primary>Ant</primary>
+ </indexterm>Ant, which uses maven 2 under the covers to get the needed
+ dependencies (you don't need to have maven 2 installed to build). Note
+ that the plug in is build seperatly, but the build process will update the
+ plug ins dependencies (refer to the section on building the plug in if you
+ need to build a new version of the plug in).</para>
- <para>Type <literal>'mvn install' </literal>to start the build process.
- Maven will then build and each Drools module - <indexterm>
- <primary>drools-core</primary>
- </indexterm>drools-core, <indexterm>
- <primary>drools-compiler</primary>
- </indexterm>drools-compiler, <indexterm>
- <primary>drools-jsr94</primary>
- </indexterm>drools-jsr94. During this process it will run the <indexterm>
- <primary>unit test</primary>
- </indexterm>Unit Tests for each module. Maven is not yet able to build
- <indexterm>
- <primary>eclipse</primary>
- </indexterm>Eclipse plugins, so this module is not included, instead the
- project for the <indexterm>
- <primary>drools-ide</primary>
- </indexterm>drools-ide module is already added to subversion.</para>
+ <para>Type <literal>'ant' </literal>to get a listing of what capabilities
+ the build script has (from the root of the project). You should then see a
+ listing which contains further instructions: <programlisting>
+<literal>C:\Projects\jboss-rules-new>ant
+Buildfile: build.xml
- <screenshot>
- <screeninfo>Start Maven Install</screeninfo>
+help:
+ [echo] Drools Build Help
+ [echo] -----------------
+ [echo]
+ [echo] The build process is for the following four modules:
+ [echo] drools-core
+ [echo] drools-compiler
+ [echo] drools-decisiontables
+ [echo] drools-jsr94
+ [echo]
+ [echo] Further to this there are two Eclipse project:
+ [echo] drools-examples - To use open eclipse and import.
+ [echo] Requires the Drools eclipse plugin.
+ [echo] Either build the plugin from drools-ide
+ [echo] or install from the Eclipse update site
+ [echo] http://anonsvn.labs.jboss.com/labs/jbossrules/upda
+tes
+ [echo] drools-ide - To use open Eclipse and import.
+ [echo] Select export and plugin fragements to
+ [echo] generate the Drools Eclipse plugin
+ [echo] Depends on all the depencies being copied
+ [echo] to its lib directory at the end of build-all,
+ [echo] which calls copy-deps.
+ [echo]
+ [echo] Targets
+ [echo] -----
+ [echo]
+ [echo] clean-all - cleans all directories
+ [echo]
+ [echo] build-all - builds all modules
+ [echo]
+ [echo] javadocs - generates the javadoc at target/docs
+ [echo]
+ [echo] manual - generates the docbook documentation in
+ [echo] html and single_html format at target/docs
+ [echo]
+ [echo] dist-all - generates the distribution builds for
+ [echo] src, bin, bin-withdeps and examples
+ [echo]
+ [echo] Each module can individually be executed with clean, compile,
+ [echo] test and build. To use simply use the following commands,
+ [echo] replace ${module} with one of the module names:
+ [echo] clean-${module}
+ [echo] compile-${module}
+ [echo] test-${module}
+ [echo] build-${module}
+ [echo]
+ [echo] Generates specific distribution builds:
+ [echo] dist-src
+ [echo] dist-bin
+ [echo] dist-bin-withdeps
+ [echo] dist-examples
+ [echo]
+ [echo] You may also pass the following system properties:
+ [echo] -Dtest.skip=true
+ [echo] -Djavadocs.skip=true
+ [echo] -Dmanual.skip=true
+ [echo]
+ [echo] Targets may be combined:
+ [echo] ant -Dtest.skip clean-all build-all
+ [echo]
+ [echo] For more help use the build system to generate the manual
+ [echo] or you can find the manual online at:
+ [echo] http://labs.jboss.com/portal/jbossrules/docs/index.html
- <mediaobject>
- <imageobject>
- <imagedata fileref="mvn_install1.jpg" />
- </imageobject>
- </mediaobject>
- </screenshot>
+BUILD SUCCESSFUL
- <screenshot>
- <screeninfo>Maven Module Unit Testing</screeninfo>
+</literal>
+</programlisting></para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="mvn_install2.jpg" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ <para>The most common pair of tasks to run is 'ant clean-all build-all'
+ which will clear old artifacts, and then test and built the source, and
+ report on any errors.</para>
- <screenshot>
- <screeninfo>Finished Maven Install</screeninfo>
+ <para>The resulting jars are put in the /target directory from the top
+ level of the project.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="mvn_install3.jpg" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ <para>As Ant builds each module it will install the resulting jars in the
+ local Maven 2 repository automatically. Where it can be easily used from
+ other project <literal>pom.xml</literal> or copied else where.</para>
- <para>As Maven builds each module it will install the resulting jars in
- the local Maven 2 repository. Where it can be easily used from other
- project <literal>pom.xml</literal> or copied else where.</para>
-
<screenshot>
<screeninfo>Installed Drools Jars</screeninfo>
Modified: labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Setup.xml
===================================================================
--- labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Setup.xml 2006-05-17 03:50:06 UTC (rev 4269)
+++ labs/jbossrules/trunk/documentation/manual/en/Chapter-Install/Section-Setup.xml 2006-05-17 04:38:15 UTC (rev 4270)
@@ -15,7 +15,7 @@
<listitem>
<para><indexterm>
<primary>eclipse</primary>
- </indexterm>Eclipse 3.2 RC1</para>
+ </indexterm>Eclipse 3.2 </para>
<para>http://www.eclipse.org/</para>
</listitem>
@@ -41,28 +41,23 @@
<para>http://ant.apache.org</para>
</listitem>
- <listitem>
- <para><indexterm>
- <primary>Maven</primary>
- </indexterm>Maven 2.0.4</para>
-
- <para>http://maven.apache.org</para>
- </listitem>
</itemizedlist>
- <para>Ensure the executeables for ant, maven and java are in your <indexterm>
+ <para>Ensure the executeables for ant and java are in your <indexterm>
<primary>path</primary>
</indexterm>path. The examples given illustrative and are for a win32
system:</para>
- <literallayout>Path=D:\java\j2sdk1.4.2_10\bin;C:\bin;D:\java\maven-2.0.4\bin;D:\java\apache-ant-1.6.5\bin;</literallayout>
+ <literallayout>Path=D:\java\j2sdk1.4.2_10\bin;D:\java\apache-ant-1.6.5\bin;</literallayout>
<para>Following environment variables will also need to be set. The examples
given illustrative and are for a win32 system::</para>
<literallayout>JAVA_HOME=D:\java\j2sdk1.4.2_10
-M2_HOME=D:\java\maven-2.0.4
-M2_REPO=<your home directory>\.m2\repository
ANT_HOME=D:\java\apache-ant-1.6.5
+
</literallayout>
+ <para>
+ Past releases used to use maven 2 as the build mechanism, but now ant is used as the primary mechanism. Maven is used underneath the covers as the mechanism for managing project dependencies etc. (You can of course still have maven 2 installed and use it if needed - there is a pom.xml structure for each module - this is what is used for dependency management).
+ </para>
</section>
\ No newline at end of file
Modified: labs/jbossrules/trunk/documentation/training/developers-course/course_outline.odt
===================================================================
(Binary files differ)
|
