directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From plusplusjia...@apache.org
Subject svn commit: r1693999 - in /directory/site/trunk/content/kerby: developer-guide.mdtext user-guide/1-how-to-begin.mdtext
Date Tue, 04 Aug 2015 06:16:31 GMT
Author: plusplusjiajia
Date: Tue Aug  4 06:16:30 2015
New Revision: 1693999

URL: http://svn.apache.org/r1693999
Log:
Update the user&developer guide.

Modified:
    directory/site/trunk/content/kerby/developer-guide.mdtext
    directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext

Modified: directory/site/trunk/content/kerby/developer-guide.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/developer-guide.mdtext?rev=1693999&r1=1693998&r2=1693999&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/developer-guide.mdtext (original)
+++ directory/site/trunk/content/kerby/developer-guide.mdtext Tue Aug  4 06:16:30 2015
@@ -31,20 +31,35 @@ To get the source, you will need to have
 
 The git repository is mirrored to Github: <https://github.com/apache/directory-kerby/>.
 
+## Build
 
-## Package
-
-You can pass the Tests through using -DskipTests.
-
-    mvn clean package
-
-	
-## Install
-
-To install the JARs in your ~/.m2/ directory, use the install target.
-
-    mvn clean install
-
+###Requirements:
+* JDK 1.7+
+* Maven 3.0 or later
+* Findbugs 1.3.9 (if running findbugs)
+* Internet connection for first build (to fetch all Maven and Kerby dependencies)
+
+###Where to run Maven from?
+
+It should be run at the top directory of Kerby.
+
+###Maven build goals:
+
+* Clean         : mvn clean [-Preleasedocs]
+* Compile       : mvn compile [-Pnative]
+* Run tests     : mvn test [-Pnative] [-Pshelltest]
+* Create JAR    : mvn package
+* Install JAR in M2 cache   : mvn install
+* Deploy JAR to Maven repo  : mvn deploy
+* Build distribution        : mvn package [-Pdist][-Pdocs][-Psrc][-Pnative][-Dtar][-Preleasedocs]
+* Run findbugs   : mvn compile findbugs:findbugs
+
+###Build options:
+
+* To run findbugs without running tests : mvn clean package -DskipTests findbugs:findbugs
[site]
+* Building distributions  without running tests : mvn package -Pdist -DskipTests  (tar package
in /kerby/kerby-dist/kdc-dist/target/ & /kerby/kerby-dist/tool-dist/target/)
+* Generate javadoc without running tests: mvn clean package -DskipTests javadoc:javadoc
+* Checkstyle plugin & pmd plugin are run by default. To prevent them from running, add
option [-Pnochecks], such as mvn package -Pnochecks
 	
 ## Setup Intellij
 

Modified: directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext?rev=1693999&r1=1693998&r2=1693999&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext (original)
+++ directory/site/trunk/content/kerby/user-guide/1-how-to-begin.mdtext Tue Aug  4 06:16:30
2015
@@ -45,7 +45,7 @@ The distribution of Kerby.
     $ cd kerby-dist/kdc-dist
     $ sh bin/kadmin.sh [server-conf-dir]
 
-  In kadmin, you can type "?" for help. For now, the kadmin only supports to add principals
to json-backend. (Working in progress).
+  In kadmin, you can type "?" for help.
 
 * Start kerby-kdc-server:
 



Mime
View raw message