You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by ju...@apache.org on 2006/12/10 11:38:16 UTC
svn commit: r485154 - /jackrabbit/trunk/src/site/xdoc/doc/building.xml
Author: jukka
Date: Sun Dec 10 02:38:14 2006
New Revision: 485154
URL: http://svn.apache.org/viewvc?view=rev&rev=485154
Log:
JCR-332: Updated the build instructions.
Modified:
jackrabbit/trunk/src/site/xdoc/doc/building.xml
Modified: jackrabbit/trunk/src/site/xdoc/doc/building.xml
URL: http://svn.apache.org/viewvc/jackrabbit/trunk/src/site/xdoc/doc/building.xml?view=diff&rev=485154&r1=485153&r2=485154
==============================================================================
--- jackrabbit/trunk/src/site/xdoc/doc/building.xml (original)
+++ jackrabbit/trunk/src/site/xdoc/doc/building.xml Sun Dec 10 02:38:14 2006
@@ -26,69 +26,29 @@
<a href="../downloads.cgi">download</a> a binary release, but if you
want to access the latest development version, you need to get the
Jackrabbit sources and build them using the
- <a href="http://maven.apache.org/maven-1.x/">Maven 1.0.2</a> build
- environment.
+ <a href="http://maven.apache.org/">Maven 2</a> build environment.
</p>
<p>
The first step in building Jackrabbit is to check out the Jackrabbit
sources from the <a href="http://subversion.tigris.org/">Subversion</a>
source repository at
<a href="http://svn.apache.org/repos/asf/jackrabbit/">http://svn.apache.org/repos/asf/jackrabbit/</a>.
- The trunk of the source repository is divided in several parts:
+ The source tree is divided in standard parts:
+ <a href="http://svn.apache.org/repos/asf/jackrabbit/trunk/">trunk</a>,
+ <a href="http://svn.apache.org/repos/asf/jackrabbit/branches/">branches</a>, and
+ <a href="http://svn.apache.org/repos/asf/jackrabbit/tags/">tags</a>.
+ The latest development version is found within trunk, while the
+ other parts are used to keep track of the source code of the
+ Jackrabbit releases.
</p>
- <dl>
- <dt><a href="http://svn.apache.org/repos/asf/jackrabbit/trunk/jackrabbit/">trunk/jackrabbit</a></dt>
- <dd>
- This is the main Jackrabbit source tree that contains everything you
- need for a fully functional Jackrabbit installation. This source tree
- is often referred to as "the Jackrabbit core". In addition to the
- main Jackrabbit jar library, this source tree is also used for the
- "jackrabbit-jcr-commons" utility library used also in other JCR tools
- and implementations.
- </dd>
- <dt><a href="http://svn.apache.org/repos/asf/jackrabbit/trunk/contrib/">trunk/contrib</a></dt>
- <dd>
- This is a collection of additional Jackrabbit modules and other
- contributed subprojects. See the individual contrib projects for
- installation and usage instructions.
- </dd>
- <dt><a href="http://svn.apache.org/repos/asf/jackrabbit/trunk/jca/">trunk/jca</a></dt>
- <dd>
- This package includes a JCA resource adapter for Jackrabbit. It's following the JCA 1.0
- specification and can be deployed on a wide range of application servers.
- </dd>
- <dt><a href="http://svn.apache.org/repos/asf/jackrabbit/trunk/jcr-rmi/">trunk/jcr-rmi</a></dt>
- <dd>
- JCR-RMI is a transparent Remote Method Invocation (RMI) layer for
- the Content Repository for Java Technology API (JCR). The layer makes
- it possible to remotely access JCR content repositories. JCR-RMI is
- developed as a part of the Apache Jackrabbit project, but
- the implementation is compatible with all JCR content repositories.
- </dd>
- <dt><a href="http://svn.apache.org/repos/asf/jackrabbit/trunk/jcr-server/">trunk/jcr-server</a></dt>
- <dd>
- This package includes a WebDAV library and WebDAV based JCR client/server
- connection facility.
- </dd>
- <dt><a href="http://svn.apache.org/repos/asf/jackrabbit/trunk/textfilters/">trunk/textfilters</a></dt>
- <dd>
- This project contains TextFilter implementations for the following binary formats:
- <ul>
- <li>Microsoft Excel</li>
- <li>Microsoft PowerPoint</li>
- <li>Microsoft Word</li>
- <li>PDF</li>
- <li>HTML</li>
- <li>OpenOffice Documents</li>
- <li>RTF</li>
- <li>XML</li>
- </ul>
- </dd>
- </dl>
<p>
- The above list may not include the newest Jackrabbit projects. To see
- the most up to date list of projects, look in the
- <a href="http://svn.apache.org/repos/asf/jackrabbit/trunk/">repository</a>.
+ The trunk contains the top-level build environment and a number of
+ component projects within subdirectories. See the
+ <code>README.txt</code> files within each subdirectory for a brief
+ description of the component project. There is also a
+ <a href="http://svn.apache.org/repos/asf/jackrabbit/trunk/contrib/">contrib</a>
+ directory with miscellaneous contributions that are not yet a part
+ of the official Jackrabbit releases.
</p>
<subsection name="Checking out the sources with Subversion">
@@ -100,85 +60,48 @@
client installed you can checkout the main Jackrabbit source tree
with the following command or its equivalent in the client you are using:
</p>
- <source>svn checkout http://svn.apache.org/repos/asf/jackrabbit/trunk/jackrabbit</source>
+ <source>svn checkout http://svn.apache.org/repos/asf/jackrabbit/trunk jackrabbit</source>
<p>
The above checkout will create a subdirectory named
<code>jackrabbit</code> that contains the latest Jackrabbit sources.
- See the <a href="http://svnbook.red-bean.com/">Subversion book</a> or
- the documentation of your Subversion client for more information on
- how to manage your source tree and keep it up to date with latest
+ See the <a href="http://svnbook.red-bean.com/">Subversion book</a>
+ or the documentation of your Subversion client for more information
+ on how to manage your source tree and keep it up to date with latest
development.
</p>
</subsection>
<subsection name="Building the sources with Maven">
<p>
- Jackrabbit uses
- <a href="http://maven.apache.org/maven-1.x/">Maven 1.0.2</a>
- as the build system and the source tree is mostly organized according
- to the Maven
+ Jackrabbit uses <a href="http://maven.apache.org/">Maven 2</a>
+ as the build system and the component sources are mostly organized
+ according to the Maven
<a href="http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html"
>Standard Directory Layout</a>. The standard build environment
- is Maven 1.0.2 with the Java Development Kit (JDK) 1.4, but the
- build is known to work also with Java 5 and 6.
+ is Maven 2 with the Java Development Kit (JDK) 1.4, but the build
+ is known to work also with Java 5 and 6.
</p>
<p>
- See the Maven 1.x
- <a href="http://maven.apache.org/maven-1.x/start/install.html">installation</a>
- and <a href="http://maven.apache.org/maven-1.x/start/quick-start.html">quick-start</a>
- guides for instructions on how to use Maven with Jackrabbit. You
- may also want to check for
- <a href="http://mevenide.codehaus.org/">Maven integration</a>
- with your favourite Integrated Development Environment (IDE).
- Common operations to run within the checked out
- <code>jackrabbit</code> directory are:
+ See the
+ <a href="http://maven.apache.org/run-maven/index.html">Running Maven</a>
+ page and the related documentation on the Maven web site for
+ instructions on how to use Maven. You may also want to check for
+ Maven 2 integration with your favourite Integrated Development
+ Environment (IDE).
</p>
- <dl>
- <dt><code>maven jar</code></dt>
- <dd>
- Compiles the Jackrabbit source files, runs all unit tests and
- packages the Jackrabbit classes into a jar library. This is the
- standard "build all" operation for Jackrabbit. The resulting
- jar package is located in <code>target/jackrabbit-*.jar</code>.
- This operation also generates the <code>jackrabbit-commons</code>
- jar package within the <code>modules/commons</code> subdirectory.
- </dd>
- <dt><code>maven jar:install</code></dt>
- <dd>
- Executes the <code>jar</code> goal and installs the resulting jar
- packages into the local Maven repository. This operation is used
- when you want to make Jackrabbit available as a dependency for
- other local Maven projects. The Maven groupId for Jackrabbit core
- is <code>org.apache.jackrabbit</code> and the artifactId is
- <code>jackrabbit-core</code>.
- </dd>
- <dt><code>maven clean</code></dt>
- <dd>
- Removes the <code>target</code> directory that contains all
- compiled classes and other files generated by the Maven builds.
- This operation is used to clean up the build environment. The
- Maven build system is quite good in keeping all the classes
- and other generated files up to date but every now and then
- you may want to run <code>maven clean jar</code> to do a fresh
- build of the entire project.
- </dd>
- <dt><code>maven copy-deps</code></dt>
- <dd>
- Copies all the Jackrabbit dependencies into the
- <code>target/lib</code> directory. This operation is used as a
- convenient way to get all the Jackrabbit dependencies instead of
- downloading them from the net or looking for them in the local
- Maven repository. Note however that the copied dependencies will
- contain the compile and unit test dependencies in addition to the
- real runtime dependencies of Jackrabbit.
- </dd>
- </dl>
- <p>
- The Jackrabbit test suite is quite extensive, so running
- <code>maven jar</code> may take a while due to the unit tests being
- run. Use <code>maven jar -Dmaven.test.skip=true</code> to skip
- running the unit tests. Note that skipping the unit tests is not
- recommended in general.
+ <p>
+ There are Maven project descriptors (POMs) within both the top
+ level <code>jackrabbit</code> directory you checked out above
+ and all the <code>jackrabbit-<em>something</em></code> component
+ subdirectories. The easiest way to build Jackrabbit is to use
+ the "multimodule" setup within the top level directory:
+ </p>
+ <source>$ cd /path/to/jackrabbit; mvn install</source>
+ <p>
+ This will build and package all the component projects and place
+ the resulting artifacts within your local Maven 2 repository. You
+ can also find the artifacts within the created <code>target</code>
+ subdirectories of the component projects.
</p>
</subsection>
</section>