directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From plusplusjia...@apache.org
Subject svn commit: r1694611 - in /directory/site/trunk/content/kerby: developer-guide.mdtext user-guide/1-how-to-begin.mdtext
Date Fri, 07 Aug 2015 05:18:34 GMT
Author: plusplusjiajia
Date: Fri Aug  7 05:18:34 2015
New Revision: 1694611

URL: http://svn.apache.org/r1694611
Log:
Refine the Kerby's 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=1694611&r1=1694610&r2=1694611&view=diff
==============================================================================
--- directory/site/trunk/content/kerby/developer-guide.mdtext (original)
+++ directory/site/trunk/content/kerby/developer-guide.mdtext Fri Aug  7 05:18:34 2015
@@ -35,7 +35,6 @@ The git repository is mirrored to Github
 
 * 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?
@@ -44,21 +43,36 @@ It should be run at the top directory of
 
 ##Maven build goals:
 
-* Clean         : mvn clean [-Preleasedocs]
-* Compile       : mvn compile [-Pnative]
-* Run tests     : mvn test [-Pnative] [-Pshelltest]
+* Clean         : mvn clean
+* Compile       : mvn compile
+* Run tests     : mvn test
 * 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]
+* Build distribution        : mvn package [-Pdist]
 * Run findbugs   : mvn compile findbugs:findbugs
+* Run benchmarks : mvn integration-test -Pbenchmark
 
 ##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
+* 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=1694611&r1=1694610&r2=1694611&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 Fri Aug  7 05:18:34
2015
@@ -40,18 +40,19 @@ The distribution of Kerby.
 
     The admin principal will be exported into [keytab], it will be used by kadmin tool for
the authentication. 
 
-* Run kadmin to add principals:
+* Start kerby-kdc-server:
 
     $ cd kerby-dist/kdc-dist
-    $ sh bin/kadmin.sh [server-conf-dir] [-k keytab]
-
-  In kadmin, you can type "?" for help.
+    $ sh bin/start-kdc.sh [server-conf-dir] [work-dir]
 
-* Start kerby-kdc-server:
+* Run kadmin to add principals:
 
     $ cd kerby-dist/kdc-dist
-    $ sh bin/start-kdc.sh [server-conf-dir] [work-dir]
+    $ sh bin/kadmin.sh [server-conf-dir] [-k keytab]
 
+  The keytab file is created by the kdcinit.
+  In kadmin, you can type "?" for help.
+	
 * Run kinit:
 
     $ cd kerby-dist/tool-dist
@@ -75,7 +76,7 @@ An example of kdc.conf:
 An example of json backend backend.conf:
 
     kdc_identity_backend = org.apache.kerby.kerberos.kdc.identitybackend.JsonIdentityBackend
-    backend.json.file = /tmp/kerby/jsonbackend
+    backend.json.dir = /tmp/kerby/jsonbackend
 
 An example of zookeeper backend backend.conf:
 



Mime
View raw message