[jboss-svn-commits] JBL Code SVN: r37474 - labs/jbosstm/trunk.

[jboss-svn-commits at lists.jboss.org]

Author: tomjenkinson
Date: 2011-09-23 06:00:29 -0400 (Fri, 23 Sep 2011)
New Revision: 37474

Modified:
   labs/jbosstm/trunk/Build.txt
Log:
JBTM-892 included some more documentation about the build approach

Modified: labs/jbosstm/trunk/Build.txt
===================================================================
--- labs/jbosstm/trunk/Build.txt	2011-09-21 18:15:06 UTC (rev 37473)
+++ labs/jbosstm/trunk/Build.txt	2011-09-23 10:00:29 UTC (rev 37474)
@@ -8,8 +8,29 @@
 To build Narayana you should call:
 ./build.[sh|bat] <maven_goals>
 
+To use this wrapper to build an individual module (say arjuna) you would type:
+	[./]build.[sh|bat] clean install -pl :arjuna
 If you are using a different maven installation to the one provided in tools/maven you need to make sure you have the following options:
--Dorson.jar.location=/full/path/to/checkout/location/ext/orson-0.5.0.jar -Demma.jar.location=/full/path/to/checkout/location/ext/emma.jar
+	-Dorson.jar.location=/full/path/to/checkout/location/ext/orson-0.5.0.jar -Demma.jar.location=/full/path/to/checkout/location/ext/emma.jar
+If you have build once using build.sh and then move to a different installation of maven, please ensure your $HOME/.m2/settings.xml point to the Narayana local repo:
+	1. The contents of $HOME/.m2/settings.xml should read (replacing /home/tom with your home directory):
+	<?xml version="1.0" encoding="UTF-8"?> 
+	<settings xmlns="http://maven.apache.org/settings/1.0.0"  
+        	  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
+        	  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd"> 
+		<localRepository>/home/tom/.m2/narayana/repository</localRepository>
+	</settings>
+If you want to be able to cd into a folder to call our shipped maven or a version of maven not shipped with our project (on linux):
+	1. Create a file called $HOME/bin/txmvn (assuming $HOME/bin is in the path)
+	2. Add the following contents to this file:
+	#!/bin/bash
+	M2_HOME=~/projects/narayana/trunk/tools/maven/
+	PATH=$M2_HOME/bin:$PATH
+	EXT_JARS="-Demma.jar.location=\${user.home}/projects/narayana/trunk/ext/emma.jar -Dorson.jar.location=\${user.home}/projects/narayana/trunk/ext/orson-0.5.0.jar"
+	mvn $EXT_JARS $@
+	3. Ensure that $HOME/bin/txmvn is executable
+	4. type something like "txmvn clean install"
+NOTE: This does not set the memory options etc that build.[sh|bat] does so you will need to update this script to reflect our changes in build.[sh|bat]
 ------------------------------------------
 
 Now The Gory Details.