You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by sc...@apache.org on 2005/07/07 23:32:16 UTC
svn commit: r209650 - in /myfaces/forrest/trunk: ./ build/build.xml
content/xdocs/community/buildhowto.xml content/xdocs/community/versioning.xml
Author: schof
Date: Thu Jul 7 14:32:14 2005
New Revision: 209650
URL: http://svn.apache.org/viewcvs?rev=209650&view=rev
Log:
modified build; added new documentation for svn and build process
Modified:
myfaces/forrest/trunk/ (props changed)
myfaces/forrest/trunk/build/build.xml
myfaces/forrest/trunk/content/xdocs/community/buildhowto.xml
myfaces/forrest/trunk/content/xdocs/community/versioning.xml
Propchange: myfaces/forrest/trunk/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Thu Jul 7 14:32:14 2005
@@ -0,0 +1,3 @@
+bak
+*.jpx
+*.local
Modified: myfaces/forrest/trunk/build/build.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/build/build.xml?rev=209650&r1=209649&r2=209650&view=diff
==============================================================================
--- myfaces/forrest/trunk/build/build.xml (original)
+++ myfaces/forrest/trunk/build/build.xml Thu Jul 7 14:32:14 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<project name="myfaces-release" default="site" >
+<project name="myfaces-release" default="dist" >
<!-- ========== Prerequisite Properties =================================== -->
@@ -23,6 +23,7 @@
<property name="build.dir" location="${basedir}"/>
<property name="temp.dir" location="${build.dir}/temp"/>
<property name="site.build.dir" location="${temp.dir}/site"/>
+ <property name="release.dir" location="${temp.dir}/release"/>
<!-- ========== User Supplied Properties ============================== -->
@@ -35,7 +36,7 @@
<delete dir="${temp.dir}"/>
</target>
- <target name="site">
+ <target name="dist">
<mkdir dir="${site.build.dir}"/>
@@ -52,5 +53,14 @@
</target>
+ <target name="release" depends="dist">
+
+ <mkdir dir="${release.dir}"/>
+
+ <tar destfile="${release.dir}/website.tar.gz" compression="gzip" >
+ <tarfileset dir="${site.build.dir}"/>
+ </tar>
+
+ </target>
</project>
Modified: myfaces/forrest/trunk/content/xdocs/community/buildhowto.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/community/buildhowto.xml?rev=209650&r1=209649&r2=209650&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/community/buildhowto.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/community/buildhowto.xml Thu Jul 7 14:32:14 2005
@@ -4,83 +4,90 @@
<document>
<header>
- <title>Apache MyFaces - Subversion Access</title>
+ <title>Apache MyFaces - Building the Source</title>
</header>
<body>
<section>
-<title>Building the MyFaces Source</title>
+ <title>Overview</title>
<p>
MyFaces uses Ant to build from the source. Click <link href="http://ant.apache.org">here</link> for more information on
Apache Ant. These instructions also assume you have already checked out the source code. If you have not done this, please
- see the SVN instructions <link href="versioning.html">here</here>.
+ see the SVN instructions <link href="versioning.html">here</link>.
</p>
<p>
There are two ways to build MyFaces. The first is from the "top level" build directory which is used to build "all" of the
subprojects in the correct order. The other method is to build one or more subprojects directly.
</p>
+</section>
+<section>
+ <title>"One Build To Rule Them All"</title>
+ <p>
+ MyFaces uses a single build file to build all of the subprojects. This build file is available in all of the subprojects
+ and is shared through the magic of svn:externals. If you are interested in building everything then you want to execute
+ the build from the "top level" build directory. <em>This is the build directory immediately under the directory you check
+ out the <code>current</code> SVN code to.</em>
+ </p>
+ <p>
+ Most of the targets in the build script have an "all" version that can be used to build all of the subprojects:
+ <code>clean-all, javadoc-all, dist-all </code> etc.
+
+ </p>
+ <source>
+ svn co https://svn.apache.org/repos/asf/myfaces/current myfaces-current
+ cd myfaces-current/build
+ ant download-dependencies dist-all
+ </source>
+ <p>
+ You can also build the subprojects individually by using the build file contained in the relevant subproject's build directory.
+ There are some restrictions on this, however, as not all of the subprojects can be built independently. For certain subprojects,
+ the order is important.
+ </p>
+ <p>
+ Example: You want to build myfaces-impl.jar. This requires the API to compile so you would need to build the API subproject first.
+ </p>
+ <source>
+ svn co https://svn.apache.org/repos/asf/myfaces/current myfaces-current
+ cd myfaces-cuurent/api/build
+ ant download-dependencies
+ ant dist
+ cd ../../
+ cd impl
+ ant dist
+ </source>
- <table>
- <tr>
- <th>If you need ...</th>
- <th>Use ...</th>
- </tr>
- <tr>
- <td>
- <strong>The latest source code for all relevant subprojects.</strong> This includes the MyFaces JSF implementation as well as
- the Tomahawk components and other goodies. Also includes the example web applications and sandbox components.
- </td>
- <td>
- <code>svn co https://svn.apache.org/repos/asf/myfaces/current</code>
- </td>
- </tr>
- <tr>
- <td>
- <strong>The source code for the MyFaces implementation only.</strong> Does not include the tomahawk subproject or any of the
- examples.
- </td>
- <td>
- <code>svn co https://svn.apache.org/repos/asf/myfaces/core</code>
- </td>
- </tr>
- <tr>
- <td>
- <strong>The source code for the Tomahawk subproject without any JSF implementation stuff.</strong> Ideal for those who
- use the RI and want to provide a quick patch to an existing tomahawk component. This requires that you
- provide your own JSF implementation. If you are using MyFaces as your JSF implementation it does not make
- much sense to use this option.
- </td>
- <td>
- <code>svn co https://svn.apache.org/repos/asf/myfaces/tomahawk-only</code>
- </td>
- </tr>
- <tr>
- <td>
- <strong>The xdocs used to build the MyFaces website.</strong> This is intended for committers only.
- Contains the forrest xdocs and build script used to build the website.
- </td>
- <td>
- <code>svn co https://svn.apache.org/viewcvs.cgi/myfaces/forrest/trunk</code>
- </td>
- </tr>
- <tr>
- <td>
- <strong>The source code in its original layout before the SVN reorg.</strong> This is meant for troubleshooting purposes only.
- Do not use this to submit patches or check in code.
- </td>
- <td>
- <code>svn co https://svn.apache.org/viewcvs.cgi/myfaces/legacy/tags/before_svn_reorg/</code>
- </td>
- </tr>
- </table>
- <p>
- <br/>
- The source code can also be viewed online <link href="http://svn.apache.org/viewcvs.cgi/myfaces/">here</link>
- using viewcvs.
+</section>
+<section>
+ <title>Dependencies</title>
+ <p>
+ There are several third party JAR files that MyFaces depends on (for a complete list see the comments in the build.xml file.)
+ The simplest way to obtain these jar files is to run <code>ant download-dependencies</code> from the top level build directory.
+ This will create a lib directory that will automatically be used by the Ant script when building. Normally this is a one-time
+ step but you may want to occassionally run this target to make sure the dependencies have not changed (especially if you
+ are unable to build all of a sudden.)
+ </p>
+ <p>
+ It is not required that you use the <code>download-dependencies</code> target. The <code>build.default.properties</code> file
+ contains a list of the jar file dependencies. By default it points to the top level lib directory. So to use your own local
+ JAR files you have three options:
</p>
-
+ <ul>
+ <li>
+ Create a top level lib directory and copy your jars into it (editing the <code>build.default.properties</code> file if
+ necessary.)
+ </li>
+ <li>
+ Create/edit the <code>build.properties</code> file in your home directory so that each entry in <code>
+ build.default.properties</code> file is accounted for and points to the appropriate location on your machine.
+ </li>
+ <li>
+ Create/edit the <code>build.local.properties</code> file in your build directory so that each entry in <code>
+ build.default.properties</code> file is accounted for and points to the appropriate location on your machine.
+ </li>
+ </ul>
</section>
+
</body>
Modified: myfaces/forrest/trunk/content/xdocs/community/versioning.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/community/versioning.xml?rev=209650&r1=209649&r2=209650&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/community/versioning.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/community/versioning.xml Thu Jul 7 14:32:14 2005
@@ -77,9 +77,8 @@
</tr>
</table>
<p>
- <p>
<br/>
- The source code can also be viewed online <link href="http://svn.apache.org/repos/asf/myfaces">here</link>.
+ The source code can also be viewed online <link href="http://svn.apache.org/viewcvs.cgi/myfaces/">here</link>.
</p>
</section>