Permalink
Browse files

Updated hacking and install docs.

  • Loading branch information...
1 parent c1ebd3b commit 90c37e587b206d76f79439a9078ac660601cc77b @hamilton hamilton committed Sep 1, 2011
Showing with 28 additions and 5 deletions.
  1. +26 −4 docs/hacking.rst
  2. +2 −1 docs/install
View
@@ -12,12 +12,19 @@ First, make sure that you satisfy the requirements for running grouperfish
(:ref:`installation`).
Maven
- We are using Maven 3 for build and dependency management of several
+ We are using Maven 3.0 for build and dependency management of several
Grouperfish components.
JDK 6
Java 6 Standard Edition should work fine.
+Sphinx
+ For documentation. Best installed by running
+
+::
+
+ easy_install Sphinx
+
The Source
To obtain the (latest) source using **git**:
@@ -36,6 +43,8 @@ Building it:
> ./install # Creates a build under ./build
> ./install --package # Creates grouperfish-$VERSION.tar.gz
+When building, you might get Maven warnings due to expressions in the
+``'version'`` field, which can be ignored.
Coding Style
------------
@@ -48,9 +57,22 @@ else (especially Java) at 120.
Java
This project follows the default Eclipse code format, except that 4 spaces
- are used for indention rather than ``TAB``.
- For Java projects (transforms, filters), Maven is encouraged as the
- build-tool (but not required).
+ are used for indention rather than ``TAB``. Also, put
+ ``else``/``catch``/``finally`` on a new line (much nicer diffs). Crank
+ up the warnings for unused identifiers and dead code, they often point to
+ real bugs.
+ Help *readers* to reason about scope and side-effects:
+
+ * Keep declarations and initializations together
+
+ * Keep all declarations as local as possible.
+
+ * Use ``final`` generously, especially for fields.
+
+ * No ``static`` fields without ``final``.
+
+ For Java projects (service, transforms, filters), *Maven* is encouraged as
+ the build-tool (but not required).
Python
Follow `PEP 8`_
View
@@ -15,7 +15,8 @@ case "${cmd}" in
;;
--clean)
make clean
- rm -rf ../build/docs
+ rm -r ../build/docs
+ rm -r _build
;;
--help)
"Usage: ${0} [--build|--clean]"

0 comments on commit 90c37e5

Please sign in to comment.