HomeDownloadsUser GuideDevelopment

Development: Index

Developer Information

Welcome to the development section of the OpenPermis project. This document serves as an overview document for the development setup and the tools used by project OpenPermis.

If you are interested in how to use OpenPermis then head over to the User Guide for more information.

Quick Start Information

If you are new to the OpenPermis build environment please check out the build setup documentation to get started.

The OpenPermis build environment is Ant based. A description of available targets can be found on the Build System page.

Please note that you should not use your own Ant installation, but the one bundled with the build environment, see the setup page for more information.

Sections

Section Description
Primer that describes how to check out and setup the build system.
A suite of primers dealing describing various aspects of the development of OpenPermis.
Short primer on the layout and the internals of the build system.
Provides information on how to add your own Module.
How to build a binary release.
Describes the build system and targets available.
Lists 3rd party tools and libraries used and provides information on how to add your own 3rd party tool or library.
Tools used to build OpenPermis and its documentation.
Gives an overview of the auditing and unit test libraries tools used by OpenPermis.
Lists the libraries that are shared among all project modules.
Lists the libraries used by each module.
Lists the libraries used by each module.
Lists all auditing reports provided by the build system.
Report for the compilation results of all project modules. Shows the output of the javac tool.
JavaDoc generation report for the various API specifications created. Shows the output of the javadoc tool.
Report for source and documentation files that are using mixed whitespace characters or have overlong lines.
Report showing the test results for all the unit tests in the project.
Checkstyle auditing tool report.
PMD
PMD auditing tool reports.
Findbugs auditing tool reports.
Shows the percentages of the source code covered by the unit tests.
Gives an overview of the integration project.
Log of changes to the project.