| Project: | PIMS |
|---|---|
| Internal Release Number: | 0.1 |
| Related Documents: |
LINKS TO OTHER DOCUMENTS
|
| Path | VC | Description |
|---|---|---|
| build.xml | Yes | Build file |
| build.properties | Yes | Build properties file |
| src/ | Yes | Source code |
| src/java/ | Yes | Java source code |
| src/java/[Nested packages]/ | Yes | Java source code of classes in each package |
| src/java/test/[Nested packages]/ | Yes | Java source code of unit tests for classes in each package |
| web/ | Yes | HTML and JSP files |
| web/css/ | Yes | CSS files, if any |
| web/images/ | Yes | Image files, if any |
| web/WEB-INF/web.xml | Yes | Java web application configuration file |
| conf/ | Yes | Configuration files, if any |
| data/ | Yes | Initial data to load into database and/or file system, if any |
| lib/ | Yes | Libraries reused by this project, if any |
| scripts/ | Yes | Command-line utility scripts used by this project, if any |
| project/ | Yes | Project documents (e.g., overview, plan, requirements, and design) |
| build/ | No | Output of build process |
| build/WEB-INF/classes/ | No | Compiled code output by build process |
| dist/docs/api/ | No | API documentation output from build process |
| dist/PIMS-VERSION.war | No | Deployable web archive of classes and config files generated by build process |
| Path | Description |
|---|---|
| trunk/ | The current snapshot. Subject to a daily build and smoke test, and other QA activity. |
| releases/ | A branch for each official release. |
| developers/ | A branch for each developer, for personal use. |
| tags/ | Tagged revisions. |
svn copy http://pims.mole.ac.uk/svn/pims/trunk \
http://pims.mole.ac.uk/svn/pims/developers/[your name] \
-m "Creating a private branch"
svn checkout http://pims.mole.ac.uk/svn/pims/developers/[your name]
(or the equivalent if using a GUI subversion client).
To merge changes from the trunk into your branch,
or publish changes you have made in your branch into the trunk,
see Merging a Whole Branch to Another.
| Target | Description |
|---|---|
| compile = default | Compiles Java source code and creates .class files under the "build" directory. |
| dist | Packages the system for distribution/deployment to servers or end users. Specifically, it creates .war archive of compiled classes and configuration files. |
| install | Places executable code into location where it will actually be executed. Specifically, it copies .war file into Tomcat's webapps directory for use. You must then restart Tomcat or use the "reload" link in the Tomcat Manager. |
| javadoc | Generates Java API documentation under "build/docs/api/". |
| clean | Deletes files generated by previous build commands. Files under version control are not touched. |
| Property | Description |
|---|---|
| app.name | The name of this application. This should be one short word. Used in the name of resulting package files. Specifically, the .war file. And, it will be used to access the application via http://localhost:8080/APP.NAME/ |
| app.version | Version number of this release. Used in the name of resulting package files. Specifically, the .war file. |
| webapps.path | Path to the Tomcat "webapps" directory. Defaults to C:\Program Files\Apache Group\Tomcat 4.1\webapps\ |
These build system properties can be modified by editing the build.properies file.