OpenDS Build Instructions
java -version" prints out a message indicating the version is at least 1.5.0), then this should be fine. Otherwise, it will be necessary to set the
JAVA_HOMEenvironment variable to specify the full path to the root of the Java 5.0 SDK installation. If necessary the Java SDK can be downloaded from java.sun.com
No arguments are required, and after a few seconds everything should be done.
./build.sh on Unixes
./build.bat on Windows
checkstyle -- Performs a number of style checks against the OpenDS source code to ensure that it meets the code guidelines that have been defined for the project. See the Open Source Guide for more informations on the code guidelines.
clean -- Removes any dynamically-generated files that were created as part of an earlier build, including the build subdirectory and the src/server/org/opends/server/util/DynamicConstants.java source file.
compile -- Compiles the main Directory Server source code into the build/classes directory. The compiled classes will not be packaged in any usable form, but this can be a relatively fast way to determine whether the code will compile.
package -- Performs all of the work done by the compile target, but also creates a build/package directory that contains the OpenDS Directory Server in a form that may be used immediately for testing purposes, as well as bundled in a ZIP file that can be easily copied to another system. This is the default that will be used if no target is explicitly specified.
dsml -- Performs all of the work done by the package target, but also builds a Web application that may be used as a DSML to LDAP gateway. The WAR file containing the DSML to LDAP gateway application will be placed in the war subdirectory under the packaged Directory Server.
test -- Performs all of the work done by the compile target, but also compiles and runs all of the unit tests associated with the server. See the Unit Test Instructions for more information about unit tests.
coveragediff -- Generate a HTML based diff report with coverage information if available. See the Unit Test Instructions for more information about code coverage.
javadoc -- Performs all of the work done by the dsml target, but also generates Javadoc documentation from all of the server source code. The generated documentation will be placed in the build/javadoc subdirectory.
precommit -- Performs all of the work done by the checkstyle, javadoc, and test targets. The code must build cleanly (i.e., with no warnings or errors) using this target before it is eligible to be committed to the repository.
daily -- Performs all of the work that will be included as part of an OpenDS daily build. At present, this includes all of the work done by the precommit target, and also generates a code coverage report that details how much of the server code is exercised by the unit tests. In the future, this may include other processing that takes too long to be conveniently included in the precommit target.
weekly -- Performs all of the work that will be included as part of an OpenDS weekly build. At present, this includes all of the work done in the daily target, but in the future may include additional processing that takes too long to be included in the daily build process.
all -- Performs a build that includes virtually all build targets that have been defined.
rebuild -- Performs a specialized version of the package build that does not invoke the clean target in the process. In particular, it rebuilds all of the source classes and creates the corresponding JAR files in the existing build/package directory without destroying any of the other content in that directory. This can be particularly useful for cases in which the OpenDS instance created under the build/package directory is configured and/or populated with data but a problem is found that requires a code change.
To use one of these build targets, simply include the target name on the command line. For example: