directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From plusplusjia...@apache.org
Subject [07/26] directory-kerby git commit: DIRKRB-325 Have a BUILDING readme to document the supported build options. Contributed by Yaning.
Date Mon, 10 Aug 2015 05:15:48 GMT
DIRKRB-325 Have a BUILDING readme to document the supported build options. Contributed by Yaning.


Project: http://git-wip-us.apache.org/repos/asf/directory-kerby/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-kerby/commit/d1528e67
Tree: http://git-wip-us.apache.org/repos/asf/directory-kerby/tree/d1528e67
Diff: http://git-wip-us.apache.org/repos/asf/directory-kerby/diff/d1528e67

Branch: refs/heads/pkinit-support
Commit: d1528e6733a93a46c54078dd0c2c5c3787589ed2
Parents: 3c97020
Author: plusplusjiajia <jiajia.li@intel.com>
Authored: Tue Aug 4 10:05:16 2015 +0800
Committer: plusplusjiajia <jiajia.li@intel.com>
Committed: Tue Aug 4 10:05:16 2015 +0800

----------------------------------------------------------------------
 BUILDING.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/d1528e67/BUILDING.md
----------------------------------------------------------------------
diff --git a/BUILDING.md b/BUILDING.md
new file mode 100644
index 0000000..05fe8c2
--- /dev/null
+++ b/BUILDING.md
@@ -0,0 +1,29 @@
+#Build instructions for Kerby
+-------------
+###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
\ No newline at end of file


Mime
View raw message