Apache Accumulo Source Code & Developers Guide
Accumulo's web site is maintained with Apache Subversion here using Apache's Content Management System. Committers may edit the site by following these instructions. Non-committers should follow this FAQ entry.
- Instamo Archetype (browse|checkout)
- Wikisearch Application (browse|checkout)
- Apache Pig Support (browse|checkout)
- BSP via Apache Hama (browse|checkout)
If you activate the 'thrift' Maven profile, the build of some modules will attempt to run the Apache Thrift command line to regenerate stubs. If you activate this profile and don't have Apache Thrift installed and in your path, you will see a warning and your build will fail. For Accumulo 1.5.0 and greater, install Thrift 0.9 and make sure that the 'thrift' command is in your path. Watch out for THRIFT-1367; you may need to configure Thrift with --without-ruby. Most developers do not need to install or modify the Thrift definitions as a part of developing against Apache Accumulo.
Checking out from Git
To check out the code:
git clone http://git-wip-us.apache.org/repos/asf/accumulo.git
To build the code:
mvn package -P assemble
This will create a file accumulo-*-SNAPSHOT-dist.tar.gz in the assemble/target directory.
For older branches, "mvn package && mvn assembly:single" may be required instead, and the tar will be built in the target directory.
Accumulo uses Jenkins for automatic builds.
Changes should be merged from earlier branches of Accumulo to later branches. Ask the dev list for instructions.
Refer to the README in the release you are using to see what packages are in the public API.
Changes to non-private members of those classes are subject to additional scrutiny to minimize compatibility problems across Accumulo versions.
- License Header: Always add the current ASF license header as described in ASF Source Header.
- Trailing Whitespaces: Remove all trailing whitespaces. Eclipse users can use Source->Cleanup option to accomplish this.
- Indentation: Use 2 space indents and never use tabs!
- Line Wrapping: Use 160-column line width for Java code and Javadoc.
- Control Structure New Lines: Use a new line with single statement if/else blocks.
- Author Tags: Do not use Author Tags. The code is developed and owned by the community.
Eclipse Configuration Tips
- Download Eclipse formatting and style guides for Accumulo.
- Import Formatter: Preferences > Java > Code Style > Formatter and import the Eclipse-Accumulo-Codestyle.xml downloaded in the previous step.
- Import Template: Preferences > Java > Code Style > Code Templates and import the Eclipse-Accumulo-Template.xml. Make sure to check the "Automatically add comments" box. This template adds the ASF header and so on for new code.
Intellij Configuration Tips
- Formatter plugin that uses eclipse code style xml.
Instructions for configuring git are here.
Accumulo's release guide can be found here.