diff --git a/hbase-site/src/docbkx/developer.xml b/hbase-site/src/docbkx/developer.xml index 9562ca552b9..3b90ca2c33d 100644 --- a/hbase-site/src/docbkx/developer.xml +++ b/hbase-site/src/docbkx/developer.xml @@ -32,6 +32,7 @@
HBase Repositories + There are two different repositories for HBase: Subversion (SVN) and Git. The former is the system of record for committers, but the latter is easier to work with to build and contribute. SVN updates get automatically propagated to the Git repo.
SVN @@ -55,6 +56,7 @@ git clone git://git.apache.org/hbase.git See HBASE-3678 Add Eclipse-based Apache Formatter to HBase Wiki for an Eclipse formatter to help ensure your code conforms to HBase'y coding convention. The issue includes instructions for loading the attached formatter. + In addition to the automatic formatting, make sure you follow the style guidelines explained in Also, no @author tags - that's a rule. Quality Javadoc comments are appreciated. And include the Apache license.
@@ -62,6 +64,10 @@ git clone git://git.apache.org/hbase.git Download and install the Subversive plugin. Set up an SVN Repository target from , then check out the code.
+
+ Git Plugin + If you cloned the project via git, download and install the Git plugin (EGit). Attach to your local git repo (via the Git Repositories window) and you'll be able to see file revision history, generate patches, etc. +
HBase Project Setup To set up your Eclipse environment for HBase, close Eclipse and execute... @@ -69,12 +75,12 @@ git clone git://git.apache.org/hbase.git mvn eclipse:eclipse ... from your local HBase project directory in your workspace to generate some new .project - and .classpathfiles. Then reopen Eclipse. -
+ and .classpathfiles. Then reopen Eclipse, and import the .project file in the HBase directory to a workspace. +
Maven Plugin Download and install the Maven plugin. For example, Help -> Install New Software -> (search for Maven Plugin) -
+
Maven Classpath Variable The M2_REPO classpath variable needs to be set up for the project. This needs to be set to @@ -120,8 +126,19 @@ Access restriction: The method getLong(Object, long) from the type Unsafe is not
Building HBase - This section will be of interest only to those building HBase from source. - +
+ Basic Compile + Thanks to maven, building HBase is easy. You can read about the various maven commands in , but the simplest command to compile HBase from its java source code is: + +mvn compile + + Or, to clean up before compiling: + +mvn clean compile + + With Eclipse set up as explained above in , you can also simply use the build command in Eclipse. To create the full installable HBase package takes a little bit more work, so read on. + +
Building in snappy compression support Pass -Dsnappy to trigger the snappy maven profile for building @@ -132,7 +149,7 @@ Access restriction: The method getLong(Object, long) from the type Unsafe is not Building the HBase tarball Do the following to build the HBase tarball. Passing the -Drelease will generate javadoc and run the RAT plugin to verify licenses on source. - % MAVEN_OPTS="-Xmx2g" mvn clean site install assembly:single -Dmaven.test.skip -Prelease + % MAVEN_OPTS="-Xmx2g" mvn clean site install assembly:single -DskipTests -Prelease
@@ -236,17 +253,27 @@ What is the new development version for "HBase"? (org.apache.hbase:hbase) 0.92.1
-
- Publishing a new version of hbase.apache.org - Set up your apache credentials and the target site location locally in a place and - form that maven can pick it up, in ~/.m2/settings.xml. See for an example. - Next, run the following: - $ mvn -DskipTests -Papache-release site site:deploy - You will be asked for your password. It can take a little time. - Remember that it can take a few hours for your site changes to show up. - +
+ Updating hbase.apache.org +
+ Contributing to hbase.apache.org + The HBase apache web site (including this reference guide) is maintained as part of the main HBase source tree, under /src/docbkx and /src/site. The former is this reference guide; the latter, in most cases, are legacy pages that are in the process of being merged into the docbkx tree. + To contribute to the reference guide, edit these files and submit them as a patch (see ). Your Jira should contain a summary of the changes in each section (see HBASE-6081 for an example). + To generate the site locally while you're working on it, run: + mvn site + Then you can load up the generated HTML files in your browser (file are under /target/site). +
+
+ Publishing hbase.apache.org + If you're a committer with rights to publish the site artifacts: set up your apache credentials and the target site location locally in a place and + form that maven can pick it up, in ~/.m2/settings.xml. See for an example. + Next, run the following: + $ mvn -DskipTests -Papache-release site site:deploy + You will be asked for your password. It can take a little time. + Remember that it can take a few hours for your site changes to show up. + +
-
Tests