Scarab commit: svn commit: r11177 - branches/20120417_mavenPort/www/book
[email protected] Tue, 17 Apr 2012 04:05:39 -0700 (PDT)
| Newsgroups | gmane.comp.java.scarab.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: mcoss
Date: 2012-04-17 04:05:39-0700
New Revision: 11177
Removed:
branches/20120417_mavenPort/www/book/ant-en.xml
Modified:
branches/20120417_mavenPort/www/book/eclipse-en.xml
branches/20120417_mavenPort/www/book/install-en.xml
branches/20120417_mavenPort/www/book/maven-en.xml
branches/20120417_mavenPort/www/book/scarab-dev-en.xml
Log:
ENH - Updated docbook files for new maven 3 based build system.
Removed: branches/20120417_mavenPort/www/book/ant-en.xml
Url: http://scarab.tigris.org/source/browse/scarab/branches/20120417_mavenPort/www/book/ant-en.xml?view=markup&pathrev=11176
Modified: branches/20120417_mavenPort/www/book/eclipse-en.xml
Url: http://scarab.tigris.org/source/browse/scarab/branches/20120417_mavenPort/www/book/eclipse-en.xml?view=diff&pathrev=11177&r1=11176&r2=11177
==============================================================================
--- branches/20120417_mavenPort/www/book/eclipse-en.xml (original)
+++ branches/20120417_mavenPort/www/book/eclipse-en.xml 2012-04-17 04:05:39-0700
@@ -62,6 +62,9 @@
<simpara>The Sysdeo Tomcat plugin allows you to start and stop Tomcat from Eclipse and makes debugging the application under development easier.</simpara>
<simpara>Download the 3.1 beta version from this URL: <ulink url="http://www.sysdeo.com/eclipse/tomcatplugin">http://www.sysdeo.com/eclipse/tomcatplugin</ulink>.</simpara>
<simpara>To install this plugin, all you need is to uncompress the ZIP archive in the <computeroutput>plugins</computeroutput> directory of your Eclipse installation.</simpara>
+ <note>
+ <simpara>Please note, that maven 1.x was removed and another, incompatible Maven version, 2 or higer, is used for building Scarab now. Current doumentation files are therefore outdated.</simpara>
+ </note>
</sect2>
<sect2>
<title>Generating the required files with Maven</title>
Modified: branches/20120417_mavenPort/www/book/install-en.xml
Url: http://scarab.tigris.org/source/browse/scarab/branches/20120417_mavenPort/www/book/install-en.xml?view=diff&pathrev=11177&r1=11176&r2=11177
==============================================================================
--- branches/20120417_mavenPort/www/book/install-en.xml (original)
+++ branches/20120417_mavenPort/www/book/install-en.xml 2012-04-17 04:05:39-0700
@@ -98,7 +98,7 @@
</sect2>
<sect2>
<title>Gathering the other elements required for the Scarab installation</title>
- <para>To perform the Scarab installation, you will need three more things: a Java SDK, Ant and -- of course -- Scarab itself.</para>
+ <para>To perform the Scarab installation, you will need three more things: a Java SDK, Maven and -- of course -- Scarab itself.</para>
<sect3>
<title>Download and install a Java SDK</title>
<para>If you don't have a Java SDK handy (pre-installed on some systems such as MacOS X or certain Linux distributions), you need to download and install one. Be careful: you need a Java 2 SDK and not only a JRE (Java Runtime Environment) because you will need to compile Scarab.</para>
@@ -107,27 +107,15 @@
<para>Make sure the JAVA_HOME environment variable correctly points to the directory in which your SDK is installed.</para>
</sect3>
<sect3>
- <title>Download and install Ant</title>
- <para>To build Scarab, you will need the Ant build system.</para>
- <para>You can download Ant from <ulink url="http://ant.apache.org">http://ant.apache.org</ulink>.</para>
- <para>The Ant version should be 1.5.1 or greater.</para>
- <para>Make sure the ANT_HOME environment variable correctly points to the directory in which Ant is installed</para>
- <caution>
- <simpara>The version of ant that is supplied by RedHat with RHEL3 (latest update is ant-1.5.2-23) throws an exception when running the create-db target.</simpara>
- <simpara>The exception is:</simpara>
- <simpara>
- <computeroutput>BUILD FAILED file:/export/home/admin/scarab/target/scarab/WEB-INF/conf/runtime-torque.xml:72: taskdef class org.apache.torque.task.TorqueDocumentationTask cannot be found</computeroutput>
- </simpara>
- <simpara>Work Around: use the version of ant that comes bundled with SCARAB:</simpara>
- <itemizedlist>
- <listitem><simpara>Copy it from <computeroutput>$SCARAB_ROOT/www/repository/ant/jars/ant-1.5.3-1.jar</computeroutput> to <computeroutput>$SCARAB_ROOT}/build</computeroutput></simpara></listitem>
- <listitem><simpara>From $SCARAB_ROOT/build run <computeroutput>java âjar ant-1.5.3-1.jar create-db</computeroutput></simpara></listitem>
- </itemizedlist>
- </caution>
+ <title>Download and install Maven</title>
+ <para>To build Scarab, you will need the Maven build system.</para>
+ <para>You can download Maven from <ulink url="http://maven.apache.org">http://maven.apache.org</ulink>.</para>
+ <para>The Maven version should be 3.0.3 or greater.</para>
+ <para>Make sure the MAVEN_HOME environment variable correctly points to the directory in which Maven is installed</para>
</sect3>
<sect3>
<title>Download Scarab</title>
- <para>You need of course to download Scarab itself. You will find the latest version (1.0-b21) at the following URL: <ulink url="http://scarab.tigris.org/servlets/ProjectDocumentList">http://scarab.tigris.org/servlets/ProjectDocumentList</ulink>.</para>
+ <para>You need of course to download Scarab itself. You will find the latest version (1.0.23) at the following URL: <ulink url="http://scarab.tigris.org/servlets/ProjectDocumentList">http://scarab.tigris.org/servlets/ProjectDocumentList</ulink>.</para>
</sect3>
</sect2>
</sect1>
@@ -412,31 +400,24 @@
<simpara>Go to the build directory and launch ant</simpara>
<informalexample>
<programlisting>
- ant
+ mvn clean compile
</programlisting>
</informalexample>
<simpara>This command simply compiles the source code. Run the following command to get a WAR file for Scarab:</simpara>
<informalexample>
<programlisting>
- ant war
+ mvn clean package
</programlisting>
</informalexample>
<simpara>The compiled and archived output should be found in <computeroutput>/target</computeroutput> directory of Scarab.</simpara>
</sect2>
<sect2>
<title>Rebuild Scarab after failure</title>
- <simpara>The whole property settings have been copied from the build environment, thus the configuration may be invalid. In order to fix this you must regenerate the configuration (not the class files!). You can use ant for this:</simpara>
- <informalexample>
- <programlisting>
- cd build
- ant create-custom-property-file
- </programlisting>
- </informalexample>
+ <simpara>The whole property settings have been copied from the build environment, thus the configuration may be invalid. In order to fix this you must regenerate the configuration (not the class files!).</simpara>
<simpara>But definitely the safest way to proceed is simply rebuilding everything:</simpara>
<informalexample>
<programlisting>
- ant clean
- ant
+ mvn clean package
</programlisting>
</informalexample>
</sect2>
@@ -450,44 +431,42 @@
<simpara>Run the following command to build Scarab's deafult database including all default and sample data:</simpara>
<informalexample>
<programlisting>
- ant create-db
+ mvn initialize scarab:create-db
</programlisting>
</informalexample>
</sect3>
<sect3>
<title>JIRA templates</title>
<simpara>
- By default, a module is created with issue-types that match the
- structure of JIRA, enabling transfer of issues from JIRA to Scarab.
- If you don't want this extra module in your issue tracker, then you
- can pass the option "-Dskip.jira.templates.data=true" to ant, e.g.:
+ To import some issue-types that match the
+ structure of JIRA, build the Scarab database and run the following command.
</simpara>
<informalexample>
<programlisting>
- ant create-db -Dskip.jira.templates.data=true
+ mvn initialize scarab:import-jira-templates
</programlisting>
</informalexample>
<note>
- <simpara>This option is independent of 'skip.sample.data' or 'skip.default.data' (see next chapter), so they can be specified together.</simpara>
+ <simpara>This option is not independent of 'scarab.database.build.mode'. You have to install the default data as well.</simpara>
</note>
</sect3>
<sect3>
<title>Sample data</title>
<simpara>
- By default, some sample data are put into Scarab's database. There are
- some modules and already entered issues. To avoid this,
- you can pass the option "-Dskip.sample.data=true" to ant. To skip all
+ By default, only basic data are put into Scarab's database. There are no
+ modules and no already entered issues. You may want to avoid this e.g. for presentation or tests. If so
+ you can pass the option "scarab.database.build.mode" to Maven. To import all
default global data, too, as there are some attributes, issue-types and so on,
- you can additionally pass the option "-Dskip.default.data=true" to ant:
+ pass the option like this:
</simpara>
<informalexample>
<programlisting>
- ant create-db -Dskip.sample.data=true -Dskip.default.data=true
+ mvn initialize scarab:create-db -Dscarab.database.build.mode=default
</programlisting>
</informalexample>
- <note>
- <simpara>This options are independent of 'skip.jira.templates.data', so they can be specified together.</simpara>
- </note>
+ <simpara>
+ or use "sample" as value for "scarab.database.build.mode" to import some sample moudles and stuff, too.
+ </simpara>
</sect3>
</sect2>
<sect2>
Modified: branches/20120417_mavenPort/www/book/maven-en.xml
Url: http://scarab.tigris.org/source/browse/scarab/branches/20120417_mavenPort/www/book/maven-en.xml?view=diff&pathrev=11177&r1=11176&r2=11177
==============================================================================
--- branches/20120417_mavenPort/www/book/maven-en.xml (original)
+++ branches/20120417_mavenPort/www/book/maven-en.xml 2012-04-17 04:05:39-0700
@@ -2,13 +2,12 @@
<chapter>
<title>Maven</title>
<abstract>
- <simpara>Though Scarab end-users are more likely to use Ant to build Scarab, as a developer you will need Maven to access all development functionalities, among which documentation generation.</simpara>
+ <simpara>You will need Maven to access all development functionalities, among which documentation generation.</simpara>
</abstract>
<sect1>
- <title>Maven 1</title>
- <simpara>Though Maven 2 is getting momentum and has officially become the mainstream version at the end of 2005, Scarab still uses Maven 1.</simpara>
- <simpara>Maven 1 and Maven 2 are functionnally equivalent but they are not syntactically compatible and use different build files.</simpara>
- <para>So you will need to install Maven 1 and refer to the Maven 1 documentation at this URL: <ulink url="http://maven.apache.org/maven-1.x/">http://maven.apache.org/maven-1.x/</ulink>
+ <title>Maven 3</title>
+ <simpara>You can use Maven 2 instead of Maven 3, too, but the build will not be fully functional.</simpara>
+ <para>So you will need to install Maven 3 (3.0.3 or later) from this URL: <ulink url="http://http://maven.apache.org">http://http://maven.apache.org</ulink>
</para>
</sect1>
<sect1>
@@ -17,14 +16,14 @@
<title>Normal (full) build</title>
<simpara>Go to the <computeroutput>$SCARAB_ROOT</computeroutput> directory.</simpara>
<simpara>Launch Maven:</simpara>
- <simpara>maven war<computeroutput/>
+ <simpara>mvn clean package<computeroutput/>
</simpara>
</sect2>
<sect2>
<title>Quick build</title>
<simpara>Go to the <computeroutput>$SCARAB_ROOT</computeroutput> directory.</simpara>
<simpara>Launch Maven:</simpara>
- <simpara>maven war -Dmaven.test.skip<computeroutput/>
+ <simpara>mvn clean package -Dmaven.test.skip<computeroutput/>
</simpara>
<simpara>
<computeroutput>-Dmaven.test.skip</computeroutput> skips the execution of unit tests.
@@ -35,7 +34,7 @@
<title>Running the tests</title>
<simpara>Just launch:</simpara>
<simpara>
- <computeroutput>maven test</computeroutput>
+ <computeroutput>mvn clean test</computeroutput>
</simpara>
<simpara>The results of the tests will be in <computeroutput>$(SCARAB_HOME)/target/test-results/</computeroutput>
</simpara>
@@ -43,19 +42,16 @@
<orderedlist>
<listitem>
<simpara>
- <computeroutput>maven clean</computeroutput> (you better start from scratch if you gonna test)</simpara>
+ <computeroutput>mvn clean</computeroutput> (you better start from scratch if you gonna test)</simpara>
</listitem>
<listitem>
<simpara>Configure your <computeroutput>build.properties</computeroutput> to contain at least the correct <computeroutput>scarab.database.type</computeroutput> value.</simpara>
</listitem>
<listitem>
- <simpara>maven war</simpara>
+ <simpara>mvn scarab:create-db (make sure you choose the same database than before!!)</simpara>
</listitem>
<listitem>
- <simpara>maven scarab:create-db (make sure you choose the same database than before!!)</simpara>
- </listitem>
- <listitem>
- <simpara>maven test</simpara>
+ <simpara>mvn test</simpara>
</listitem>
</orderedlist>
</sect2>
Modified: branches/20120417_mavenPort/www/book/scarab-dev-en.xml
Url: http://scarab.tigris.org/source/browse/scarab/branches/20120417_mavenPort/www/book/scarab-dev-en.xml?view=diff&pathrev=11177&r1=11176&r2=11177
==============================================================================
--- branches/20120417_mavenPort/www/book/scarab-dev-en.xml (original)
+++ branches/20120417_mavenPort/www/book/scarab-dev-en.xml 2012-04-17 04:05:39-0700
@@ -2,7 +2,6 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY architecture SYSTEM "architecture-en.xml">
- <!ENTITY ant SYSTEM "ant-en.xml">
<!ENTITY maven SYSTEM "maven-en.xml">
<!ENTITY eclipse SYSTEM "eclipse-en.xml">
<!ENTITY netbeans SYSTEM "netbeans-en.xml">
@@ -22,7 +21,6 @@
</editor>
</bookinfo>
&architecture;
- &ant;
&maven;
&eclipse;
&netbeans;
------------------------------------------------------
http://scarab.tigris.org/ds/viewMessage.do?dsForumId=3577&dsMessageId=2949078