You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by do...@apache.org on 2002/03/21 09:36:13 UTC
cvs commit: jakarta-avalon-phoenix BUILDING.txt ant.properties.sample
donaldp 02/03/21 00:36:13
Modified: . BUILDING.txt ant.properties.sample
Log:
Updated build documentation to indicate checkstyle integration
Revision Changes Path
1.7 +14 -3 jakarta-avalon-phoenix/BUILDING.txt
Index: BUILDING.txt
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/BUILDING.txt,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- BUILDING.txt 15 Dec 2001 07:15:34 -0000 1.6
+++ BUILDING.txt 21 Mar 2002 08:36:13 -0000 1.7
@@ -75,7 +75,18 @@
* Unpack the product into a convenient location so that it resides in
its own subdirectory.
-(4) Customize Build Properties For This Subproject
+(4) Download and Install Checkstyle, 2.1 or later (OPTIONAL)
+
+NOTE: This is only required if you wish to generate reports regarding code style.
+
+* Download the Checkstyle package (version 2.1 or later) from:
+
+ http://checkstyle.sourceforge.net/
+
+* Unpack the package into a convenient location so that it resides in its
+ own subdirectory.
+
+(5) Customize Build Properties For This Subproject
Most Jakarta subprojects allow you to customize Ant properties (with default
values defined in the "build.xml" file. This is done by creating a text file
@@ -90,7 +101,7 @@
file (in the top-level Phoenix source directory) to ".ant.properties", and
then edit it to suit your environment. On Unix, this would be done as:
- cd ${phoenix.source}
+ cd @dist.name@
cp ant.properties.sample .ant.properties
emacs .ant.properties
@@ -98,7 +109,7 @@
repository. This file is local to your own development environment, and
each developer will have their own version.
-(5) Build A Binary Distribution
+(6) Build A Binary Distribution
Open a command line shell, and issue the following commands:
1.7 +7 -2 jakarta-avalon-phoenix/ant.properties.sample
Index: ant.properties.sample
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/ant.properties.sample,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ant.properties.sample 15 Dec 2001 16:07:33 -0000 1.6
+++ ant.properties.sample 21 Mar 2002 08:36:13 -0000 1.7
@@ -6,7 +6,7 @@
# modules that Phoenix depends on. Copy this file to ".ant.properties"
# in the top-level source directory, and customize it as needed.
#
-# $Id: ant.properties.sample,v 1.6 2001/12/15 16:07:33 donaldp Exp $
+# $Id: ant.properties.sample,v 1.7 2002/03/21 08:36:13 donaldp Exp $
# -----------------------------------------------------------------------------
# ----- Compile Environment Flags -----
@@ -18,7 +18,7 @@
build.optimize=on
# ----- Default Base Path for Dependent Packages -----
-base.path=/usr/local
+base.path=/opt
# ----- Xerces XML Parser, version 1.4.3 or later -----
#xerces.home=${base.path}/xerces-1_4_3
@@ -42,6 +42,11 @@
jmx.lib=${jmx.home}/lib
jmxri.jar=${jmx.lib}/jmxri.jar
jmxtools.jar=${jmx.lib}/jmxtools.jar
+
+# ----- Checkstyle, version 2.1 or later -----
+checkstyle.home=${base.path}/checkstyle-2.1
+checkstyle.lib=${checkstyle.home}
+checkstyle.jar=${checkstyle.lib}/checkstyle-all-2.1.jar
# ----- Javac tools.jar -----
# The path to tools.jar, required for building the docs. Most people won't need
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>