svn commit: r427836 - /webservices/muse/trunk/modules/build-instructions.txt

[da...@apache.org]

Author: danj
Date: Tue Aug  1 18:24:12 2006
New Revision: 427836

URL: http://svn.apache.org/viewvc?rev=427836&view=rev
Log:
Updated build instructions for Muse 2.x, with some tips on getting Maven2 up and running.

Added:
    webservices/muse/trunk/modules/build-instructions.txt

Added: webservices/muse/trunk/modules/build-instructions.txt
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/build-instructions.txt?rev=427836&view=auto
==============================================================================
--- webservices/muse/trunk/modules/build-instructions.txt (added)
+++ webservices/muse/trunk/modules/build-instructions.txt Tue Aug  1 18:24:12 2006
@@ -0,0 +1,67 @@
+Building Apache Muse - Instructions and Hints
+---------------------------------------------
+
+1. Install Maven 2.x. You can get the latest version here:
+
+	http://maven.apache.org
+	
+You may notice that it is a very small download and that the instructions 
+for 'installation' are very simple. Do not be misled. There is more to 
+Maven than meets the eye.
+
+2. Read Maven's "Getting Started" tutorial. Seriously. It'll get you up to 
+speed fairly quickly. Ignore the stuff about plugins (for now - we're trying 
+to move things along here). The tutorial is here:
+
+	http://maven.apache.org/guides/getting-started
+
+3. Change the location of your local Maven repository from the default to 
+something more meaningful. You can do this by modifying the /conf/settings.xml 
+file in your Maven install directory. Just change the <localRespository/> 
+element to something like this:
+
+	<localRepository>
+		/Documents and Settings/dan/My Documents/Apache Muse/apache-muse-repository
+	</localRepository>
+
+This is especially important on Windows machines, where the repository is hidden 
+in the C:\Documents and Settings\%user%\.m2 directory (when is the last time 
+you looked in your personal home directory?).
+
+3. You are now ready to build the Muse source tree... in theory. However, the 
+first time you run Maven, you will encounter one more obstacle - remember how 
+the install was unbelievably small? How it didn't seem to include any binary 
+code at all? That's because Maven uses its own technology to download its 
+dependencies the first time it's used for a build.
+
+Unfortunately, the default Maven repository (hosted by ibiblio.org) is under 
+consistently heavy traffic, and so the first one or five times you try to run 
+the build, it may "fail" simply because it times out waiting for a JAR file that 
+is referenced by the build. This is normal. Take solace in the fact that once 
+you get all of the Maven dependencies, you probably won't have to deal with 
+this problem again for quite a while.
+
+If your Maven build keeps breaking because a JAR file cannot be successfully 
+downloaded, the only real solutions are to keep re-running the build or to 
+copy the repository entries manually. I recommend the former. I was able to 
+get Maven fully installed in four tries - not too shabby.
+
+4. In order to run the Muse build, run the /trunk/modules/build-all.bat script. 
+This script is essentially a Maven command followed by DOS commands to clean 
+up the temporary build directories created by Maven prior to it copying files 
+to your local repository. If you look in build-all.bat, you will see that the 
+only Maven-related command is:
+
+	mvn -e -ff install
+	
+The -e tells Maven to show the stack trace if there's an error. The -ff tells 
+it to "fail fast" - to stop compilation of the modules if an error is found in 
+one of them. The "install" tells Maven to copy the JAR files it creates into 
+your local repository.
+
+5. Once Maven has built all of the modules, you can access the JAR files in 
+your local repository. The /muse directory contains most of the modules, 
+including the core, WS-*, and tooling modules. The /muse-axis2, /muse-jaxws, 
+and /muse-osgi directories hold the module(s) for deployment with the given 
+platforms or frameworks.
+



---------------------------------------------------------------------
To unsubscribe, e-mail: muse-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: muse-commits-help@ws.apache.org