You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ace.apache.org by bu...@apache.org on 2012/08/15 13:40:55 UTC
svn commit: r829003 - in /websites/staging/ace/trunk/content: ./
dev-doc/getting-started.html
Author: buildbot
Date: Wed Aug 15 11:40:54 2012
New Revision: 829003
Log:
Staging update by buildbot for ace
Modified:
websites/staging/ace/trunk/content/ (props changed)
websites/staging/ace/trunk/content/dev-doc/getting-started.html
Propchange: websites/staging/ace/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Aug 15 11:40:54 2012
@@ -1 +1 @@
-1373330
+1373348
Modified: websites/staging/ace/trunk/content/dev-doc/getting-started.html
==============================================================================
--- websites/staging/ace/trunk/content/dev-doc/getting-started.html (original)
+++ websites/staging/ace/trunk/content/dev-doc/getting-started.html Wed Aug 15 11:40:54 2012
@@ -171,12 +171,12 @@
<h3 id="download-the-sources">Download the sources</h3>
<p>Point your browser to: http://ace.apache.org/download.html</p>
<p>On that page you will find, amongst others, a link to the latest released sources. The page will automatically select a download mirror close to you. Download the archive and then type:</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">unzip</span> <span class="n">apache</span><span class="o">-</span><span class="n">ace</span><span class="o">-</span><span class="n">src</span><span class="o">-</span><span class="mf">1.0.0</span><span class="o">.</span><span class="n">zip</span>
+<div class="codehilite"><pre><span class="nv">$ </span>unzip apache-ace-src-1.0.0.zip
</pre></div>
<h3 id="checkout-from-subversion">Checkout from subversion</h3>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">svn</span> <span class="n">co</span> <span class="n">http:</span><span class="sr">//s</span><span class="n">vn</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="sr">/repos/</span><span class="n">asf</span><span class="sr">/ace/</span><span class="n">trunk</span> <span class="n">apache</span><span class="o">-</span><span class="n">ace</span>
+<div class="codehilite"><pre><span class="nv">$ </span>svn co http://svn.apache.org/repos/asf/ace/trunk apache-ace
</pre></div>
@@ -222,7 +222,7 @@
<p>The integration tests of ACE are placed in separate projects that are -by convention- named with a '<tt>.itest</tt>' suffix. These integration tests use BndTools to get an OSGi framework up and running. To run one or all integration tests, use "Run As -> OSGi JUnit Test" or "Debug As -> OSGi JUnit Test".</p>
<h3 id="command-line-build">Command line build</h3>
<h4 id="prerequisites_1">Prerequisites</h4>
-<p>For developing ACE using Eclipse, you need:</p>
+<p>For developing ACE using Ant, you need:</p>
<ul>
<li>A recent Java JDK, at least <a href="http://www.oracle.com/technetwork/indexes/downloads/index.html">Java 6</a>;</li>
<li><a href="http://ant.apache.org/">Apache ANT</a> version 1.8+.</li>
@@ -231,54 +231,54 @@
<p>The command line build for Apache ACE is based on Ant, and generated automatically when using the Bndtools plugin in Eclipse.</p>
<p>The build is structured as a flat hierarchy of projects, and you can go into any of these projects to build just that project and its dependencies. There are two special projects:</p>
<ol>
-<li>cnf -- Which is collection of repositories that contain all the required dependencies for building and running Apache ACE.</li>
-<li>build -- A project that depends on all other projects and is used to build everything.</li>
+<li><code>cnf</code> -- Which is collection of repositories that contain all the required dependencies for building and running Apache ACE.</li>
+<li><code>build</code> -- A project that depends on all other projects and is used to build everything.</li>
</ol>
-<p>So, to build Apache ACE, we type the following commands:</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">cd</span> <span class="n">build</span>
-<span class="nv">$</span> <span class="nv">ant</span>
+<p>So, to build Apache ACE, we issue the following commands:</p>
+<div class="codehilite"><pre><span class="nv">$ </span><span class="nb">cd </span>build
+<span class="nv">$ </span>ant
</pre></div>
-<p>This leaves us with a set of bundles.</p>
+<p>In the end, this leaves us with a set of bundles (in the <tt>generated</tt> folder of each project).</p>
<p>The following targets are available:</p>
<ul>
-<li>clean -- Cleans up any files in the current project that were generated during a build.</li>
-<li>build -- Build the current project.</li>
-<li>test -- Run the integration tests in the current project.</li>
-<li>testng -- Run the unit tests in the current project.</li>
-<li>deepclean -- Cleans up any files in the current project and all its dependencies.</li>
-<li>deeptestng -- Runs the unit tests in the current project and all its dependencies.</li>
-<li>deeptest -- Runs the integration tests in the current project and all its dependencies.</li>
+<li><tt>clean</tt> -- Cleans up any files in the current project that were generated during a build;</li>
+<li><tt>build</tt> -- Build the current project;</li>
+<li><tt>test</tt> -- Run the integration tests in the <em>current</em> project;</li>
+<li><tt>testng</tt> -- Run the unit tests in the <em>current</em> project;</li>
+<li><tt>deepclean</tt> -- Cleans up any files in the current project and all its dependencies;</li>
+<li><tt>deeptestng</tt> -- Runs the unit tests in the current project and all its dependencies;</li>
+<li><tt>deeptest</tt> -- Runs the integration tests in the current project and all its dependencies.</li>
</ul>
<p>There actually are a few more, but these are the most important ones.</p>
<h2 id="how-to">How to...</h2>
<h3 id="create-a-distributable-archive">...create a distributable archive</h3>
<p>The next step is to create an archive for the server, so we end up with something we can actually run:</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">ant</span> <span class="o">-</span><span class="n">f</span> <span class="n">bin</span><span class="o">-</span><span class="n">build</span><span class="o">.</span><span class="n">xml</span> <span class="nb">package</span>
+<div class="codehilite"><pre><span class="nv">$ </span>ant -f bin-build.xml package
</pre></div>
<p>Now, in the generated folder, two archives will have been created, and there are also subfolders with the same names as the archives that you can go into and run. You can start the server like this:</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">cd</span> <span class="n">generated</span><span class="o">/</span><span class="n">ace</span><span class="o">-</span><span class="n">devserver</span>
-<span class="nv">$</span> <span class="nv">sh</span> <span class="n">run</span><span class="o">.</span><span class="n">sh</span>
+<div class="codehilite"><pre><span class="nv">$ </span><span class="nb">cd </span>generated/ace-devserver
+<span class="nv">$ </span>sh run.sh
</pre></div>
<h3 id="add-an-osgi-bundle">...add an OSGi bundle</h3>
<p>The easiest way to add an OSGi bundle, is to drag it onto the "Local Repository" entry in the "Repositories" view, or to use the "Add files to repository" toolbar icon. Bndtools will analyze the files you try to add and show their metadata if they're indeed valid bundles.</p>
-<p>The bundles will end up in the local repository inside the <code>cnf</code> project.</p>
+<p>The bundles will end up in the local repository inside the <tt>cnf</tt> project.</p>
<h3 id="add-a-java-library">...add a Java library</h3>
<p>If you want to add a library that does not contain any OSGi metadata, you can follow the steps below to add it to the "Library Repository" so it can be used in all other projects within Apache ACE. If your library does have sensible OSGi metadata, please follow the "...add an OSGi bundle" instructions above.</p>
<ol>
<li>Copy the library to the right location.
- The jar file for the library should be copied to the following location: <code>cnf/lib/foo/foo-1.0.0.jar</code></li>
+ The jar file for the library should be copied to the following location: <tt>cnf/lib/foo/foo-1.0.0.jar</tt>. Note that the directory name should be equal to the basename of the added JAR file, that is, everything <em>before</em> the version-string of the JAR.</li>
<li>
-<p>Update the repository.xml.
- After making changes to anything in cnf/lib/ you need to update the index file that describes the contents of the repository. To do this enter the following commands:</p>
-<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">cd</span> <span class="n">cnf</span>
-<span class="nv">$</span> <span class="nv">ant</span>
-<span class="nv">$</span> <span class="nv">java</span> <span class="o">-</span><span class="n">cp</span> <span class="n">bin</span> <span class="n">org</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">ace</span><span class="o">.</span><span class="n">bnd</span><span class="o">.</span><span class="n">LibraryIndexer</span>
+<p>Update the <code>repository.xml</code>.
+ After making changes to anything in <tt>cnf/lib/</tt> you need to update the index file that describes the contents of the repository. To do this enter the following commands:</p>
+<div class="codehilite"><pre><span class="nv">$ </span><span class="nb">cd </span>cnf
+<span class="nv">$ </span>ant
+<span class="nv">$ </span>java -cp bin org.apache.ace.bnd.LibraryIndexer
</pre></div>