svn commit: r960726 - in /websites/staging/directory/trunk/content: ./ kerby/developer-guide.html kerby/user-guide/1-how-to-begin.html

[bu...@apache.org]

Author: buildbot
Date: Tue Aug  4 06:16:38 2015
New Revision: 960726

Log:
Staging update by buildbot for directory

Modified:
    websites/staging/directory/trunk/content/   (props changed)
    websites/staging/directory/trunk/content/kerby/developer-guide.html
    websites/staging/directory/trunk/content/kerby/user-guide/1-how-to-begin.html

Propchange: websites/staging/directory/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Aug  4 06:16:38 2015
@@ -1 +1 @@
-1693848
+1693999

Modified: websites/staging/directory/trunk/content/kerby/developer-guide.html
==============================================================================
--- websites/staging/directory/trunk/content/kerby/developer-guide.html (original)
+++ websites/staging/directory/trunk/content/kerby/developer-guide.html Tue Aug  4 06:16:38 2015
@@ -169,18 +169,34 @@ h2:hover > .headerlink, h3:hover > .head
 
 <h2 id="git-mirror">Git Mirror<a class="headerlink" href="#git-mirror" title="Permanent link">&para;</a></h2>
 <p>The git repository is mirrored to Github: <a href="https://github.com/apache/directory-kerby/">https://github.com/apache/directory-kerby/</a>.</p>
-<h2 id="package">Package<a class="headerlink" href="#package" title="Permanent link">&para;</a></h2>
-<p>You can pass the Tests through using -DskipTests.</p>
-<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">clean</span> <span class="n">package</span>
-</pre></div>
-
-
-<h2 id="install">Install<a class="headerlink" href="#install" title="Permanent link">&para;</a></h2>
-<p>To install the JARs in your ~/.m2/ directory, use the install target.</p>
-<div class="codehilite"><pre><span class="n">mvn</span> <span class="n">clean</span> <span class="n">install</span>
-</pre></div>
-
-
+<h2 id="build">Build<a class="headerlink" href="#build" title="Permanent link">&para;</a></h2>
+<h3 id="requirements">Requirements:<a class="headerlink" href="#requirements" title="Permanent link">&para;</a></h3>
+<ul>
+<li>JDK 1.7+</li>
+<li>Maven 3.0 or later</li>
+<li>Findbugs 1.3.9 (if running findbugs)</li>
+<li>Internet connection for first build (to fetch all Maven and Kerby dependencies)</li>
+</ul>
+<h3 id="where-to-run-maven-from">Where to run Maven from?<a class="headerlink" href="#where-to-run-maven-from" title="Permanent link">&para;</a></h3>
+<p>It should be run at the top directory of Kerby.</p>
+<h3 id="maven-build-goals">Maven build goals:<a class="headerlink" href="#maven-build-goals" title="Permanent link">&para;</a></h3>
+<ul>
+<li>Clean         : mvn clean [-Preleasedocs]</li>
+<li>Compile       : mvn compile [-Pnative]</li>
+<li>Run tests     : mvn test [-Pnative] [-Pshelltest]</li>
+<li>Create JAR    : mvn package</li>
+<li>Install JAR in M2 cache   : mvn install</li>
+<li>Deploy JAR to Maven repo  : mvn deploy</li>
+<li>Build distribution        : mvn package [-Pdist][-Pdocs][-Psrc][-Pnative][-Dtar][-Preleasedocs]</li>
+<li>Run findbugs   : mvn compile findbugs:findbugs</li>
+</ul>
+<h3 id="build-options">Build options:<a class="headerlink" href="#build-options" title="Permanent link">&para;</a></h3>
+<ul>
+<li>To run findbugs without running tests : mvn clean package -DskipTests findbugs:findbugs [site]</li>
+<li>Building distributions  without running tests : mvn package -Pdist -DskipTests  (tar package in /kerby/kerby-dist/kdc-dist/target/ &amp; /kerby/kerby-dist/tool-dist/target/)</li>
+<li>Generate javadoc without running tests: mvn clean package -DskipTests javadoc:javadoc</li>
+<li>Checkstyle plugin &amp; pmd plugin are run by default. To prevent them from running, add option [-Pnochecks], such as mvn package -Pnochecks</li>
+</ul>
 <h2 id="setup-intellij">Setup Intellij<a class="headerlink" href="#setup-intellij" title="Permanent link">&para;</a></h2>
 <ol>
 <li>File -&gt; Import Project...</li>

Modified: websites/staging/directory/trunk/content/kerby/user-guide/1-how-to-begin.html
==============================================================================
--- websites/staging/directory/trunk/content/kerby/user-guide/1-how-to-begin.html (original)
+++ websites/staging/directory/trunk/content/kerby/user-guide/1-how-to-begin.html Tue Aug  4 06:16:38 2015
@@ -200,7 +200,7 @@ $ sh bin/kdcinit.sh [server-conf-dir] [k
 $ sh bin/kadmin.sh [server-conf-dir]</p>
 </li>
 </ul>
-<p>In kadmin, you can type "?" for help. For now, the kadmin only supports to add principals to json-backend. (Working in progress).</p>
+<p>In kadmin, you can type "?" for help.</p>
 <ul>
 <li>
 <p>Start kerby-kdc-server:</p>