Author: buildbot
Date: Mon Aug 13 11:07:32 2012
New Revision: 828789
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 Mon Aug 13 11:07:32 2012
@@ -1 +1 @@
-1372362
+1372365
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 Mon Aug 13
11:07:32 2012
@@ -171,9 +171,15 @@
<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>
-<p>$ unzip apache-ace-src-1.0.0.zip</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>
+</pre></div>
+
+
<h3 id="checkout-from-subversion">Checkout from subversion</h3>
-<p>$ svn co http://svn.apache.org/repos/asf/ace/trunk apache-ace</p>
+<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>
+</pre></div>
+
+
<p>In both cases you end up with a copy of the source code in the apache-ace
folder.</p>
<h2 id="building-the-sources">Building the sources</h2>
<p>There are two ways to build the sources. You can either run a command line
build or use Eclipse with Bndtools to build everything. If you want to actively
start developing, we strongly recommend you use Eclipse with Bndtools as this
is by far the most convenient way to build and run Apache ACE within a
development environment.</p>
@@ -230,8 +236,11 @@
<li>build -- 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>
-<p><code>$ cd build
-$ ant</code></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>
+</pre></div>
+
+
<p>This leaves us with a set of bundles.</p>
<p>The following targets are available:</p>
<ul>
@@ -247,23 +256,30 @@ $ ant</code></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>
-<p><code>$ ant -f bin-build.xml package</code></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>
+</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>
-<p><code>$ cd generated/ace-devserver
-$ sh run.sh</code></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>
+</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>
<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 "How to add a bundle" instructions
below.</p>
-<p>Step 1: Copy the library to the right location</p>
-<p>The jar file for the library should be copied to the following location:</p>
-<p>cnf/lib/foo/foo-1.0.0.jar</p>
-<p>Step 2: Update the repository.xml</p>
-<p>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>
-<p><code>$ cd cnf
+<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>
+<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>
+<p>$ cd cnf
$ ant
-$ java -cp bin org.apache.ace.bnd.LibraryIndexer</code></p></div>
+$ java -cp bin org.apache.ace.bnd.LibraryIndexer</p>
+</li>
+</ol></div>
<hr>
<footer>
<p>Copyright © 2012 <a href="http://www.apache.org/";>The Apache
Software Foundation</a>, Licensed under the <a
href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version
2.0</a>.<br/>Apache ACE, the Apache ACE logo, Apache and the Apache feather
logo are trademarks of The Apache Software Foundation. All other marks
mentioned may be trademarks or registered trademarks of their respective
owners.</p>
