You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by bu...@apache.org on 2013/10/01 12:04:20 UTC
svn commit: r880640 - in /websites/staging/sling/trunk/content: ./
documentation/development/getting-and-building-sling.html
Author: buildbot
Date: Tue Oct 1 10:04:20 2013
New Revision: 880640
Log:
Staging update by buildbot for sling
Modified:
websites/staging/sling/trunk/content/ (props changed)
websites/staging/sling/trunk/content/documentation/development/getting-and-building-sling.html
Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Oct 1 10:04:20 2013
@@ -1 +1 @@
-1527565
+1528027
Modified: websites/staging/sling/trunk/content/documentation/development/getting-and-building-sling.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/development/getting-and-building-sling.html (original)
+++ websites/staging/sling/trunk/content/documentation/development/getting-and-building-sling.html Tue Oct 1 10:04:20 2013
@@ -98,6 +98,20 @@
</ul>
<p>Note that you don't <em>have</em> to build Sling yourself, if you don't need the bleeding-edge stuff you can get prebuilt binaries from the <a href="/downloads.cgi">Downloads</a> page.</p>
<p>A full build of Sling takes 5-10 minutes on a recent computer once your local Maven repository is up to date. The first build may take much longer than that if you start with an empty local Maven repository, as Maven will then download its plugins and all the required dependencies.</p>
+<h2 id="tldr-short-form-build-run-instructions">tl:dr - Short form build + run instructions</h2>
+<p>If you already have the required svn (or Git, see below) client, JDK and Maven installed, here's the short form recipe:</p>
+<div class="codehilite"><pre>$ <span class="n">svn</span> <span class="n">co</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">svn</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">org</span><span class="o">/</span><span class="n">repos</span><span class="o">/</span><span class="n">asf</span><span class="o">/</span><span class="n">sling</span><span class="o">/</span><span class="n">trunk</span> <span class="n">sling</span>
+$ <span class="n">cd</span> <span class="n">sling</span>
+$ <span class="n">export</span> <span class="n">MAVEN_OPTS</span><span class="p">=</span> <span class="p">(</span><span class="n">see</span> <span class="n">below</span><span class="p">)</span>
+$ <span class="n">mvn</span> <span class="n">clean</span> <span class="n">install</span> <span class="p">(</span><span class="n">maybe</span> <span class="n">with</span> <span class="o">-</span><span class="n">DskipTests</span> <span class="k">if</span> <span class="n">you</span> <span class="n">know</span> <span class="n">what</span> <span class="n">you</span><span class="o">'</span><span class="n">re</span> <span class="n">doing</span><span class="p">)</span>
+$ <span class="n">cd</span> <span class="n">launchpad</span><span class="o">/</span><span class="n">builder</span>
+$ <span class="n">rm</span> <span class="o">-</span><span class="n">rf</span> <span class="p">.</span><span class="o">./</span><span class="n">builder</span><span class="o">/</span><span class="n">sling</span> <span class="p">(</span><span class="k">if</span> <span class="n">needed</span><span class="p">,</span> <span class="n">to</span> <span class="n">cleanup</span> <span class="n">previous</span> <span class="n">state</span><span class="p">)</span>
+$ <span class="n">export</span> <span class="n">DBG</span><span class="p">=</span>"<span class="o">-</span><span class="n">Xmx384M</span> <span class="o">-</span><span class="n">agentlib</span><span class="p">:</span><span class="n">jdwp</span><span class="p">...</span>" <span class="p">(</span><span class="n">see</span> <span class="n">below</span><span class="p">)</span>
+$ <span class="n">java</span> $<span class="n">DBG</span> <span class="o">-</span><span class="n">jar</span> <span class="n">target</span><span class="o">/</span><span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">sling</span><span class="p">.</span><span class="n">launchpad</span><span class="p">...</span> <span class="p">(</span><span class="n">see</span> <span class="n">below</span><span class="p">)</span>
+</pre></div>
+
+
+<p>And Sling should be running at http://localhost:8080 with remote debugging active as per the $DBG variable. </p>
<h2 id="prerequisites">Prerequisites</h2>
<p>Before you begin, you need to have the following tools installed on your system:</p>
<ul>
@@ -145,13 +159,26 @@
<h2 id="configuring-maven">Configuring Maven</h2>
<p>See <a href="/documentation/development/maventipsandtricks.html">MavenTipsAndTricks</a>.</p>
<h2 id="getting-the-sling-source">Getting the Sling Source</h2>
-<h3 id="with-svn">With SVN</h3>
+<h3 id="from-the-apache-sling-subversion-repository">From the Apache Sling Subversion repository</h3>
<ol>
<li>
-<p>Checkout Sling from the Repository.</p>
+<p>Install an svn client if needed.</p>
+</li>
+<li>
+<p>Checkout Sling from the Subversion repository</p>
<p>$ svn checkout http://svn.apache.org/repos/asf/sling/trunk sling</p>
</li>
</ol>
+<h3 id="from-the-sling-github-mirror">From the Sling GitHub mirror</h3>
+<ol>
+<li>
+<p>Install a Git client if needed</p>
+</li>
+<li>
+<p>Checkout Sling from the GitHub mirror</p>
+<p>$ git clone https://github.com/apache/sling.git</p>
+</li>
+</ol>
<h3 id="with-eclipse-subversive-or-subclipse">With Eclipse Subversive or Subclipse</h3>
<p>First note how simple the above SVN instructions are...but if you <em>really</em> want to do this, read on.</p>
<p>If you use the Subversive plugin make sure you have installed the "Subversive Integration for M2Eclipse Project" which can be found under the following Eclipse update site: <a href="http://community.polarion.com/projects/subversive/download/integrations/update-site/">http://community.polarion.com/projects/subversive/download/integrations/update-site/</a>.</p>
@@ -279,7 +306,7 @@ For more information on this see the <a
</ul>
<p>If adding dependencies to the poms, run mvn eclipse:eclipse again and refresh the project in Eclipse. Debugging works as described above.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1499238 by fmeschbe on Wed, 3 Jul 2013 07:39:54 +0000
+ Rev. 1528027 by bdelacretaz on Tue, 1 Oct 2013 10:04:10 +0000
</div>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project