svn commit: r1576829 - /accumulo/site/trunk/content/source.mdtext

[bh...@apache.org]

Author: bhavanki
Date: Wed Mar 12 17:30:44 2014
New Revision: 1576829

URL: http://svn.apache.org/r1576829
Log:
Added public API definition based on README.

Modified:
    accumulo/site/trunk/content/source.mdtext

Modified: accumulo/site/trunk/content/source.mdtext
URL: http://svn.apache.org/viewvc/accumulo/site/trunk/content/source.mdtext?rev=1576829&r1=1576828&r2=1576829&view=diff
==============================================================================
--- accumulo/site/trunk/content/source.mdtext (original)
+++ accumulo/site/trunk/content/source.mdtext Wed Mar 12 17:30:44 2014
@@ -88,6 +88,19 @@ Accumulo [tracks issues][jiraloc] with [
 
 Changes should be merged from earlier branches of Accumulo to later branches.  Ask the dev list for instructions.
 
+### Public API
+
+The following classes constitute the Accumulo "public API":
+
+* All classes in org.apache.accumulo.core.client except those in "impl" subpackages
+* The following classes in org.apache.accumulo.core.data:
+  * Key
+  * Mutation
+  * Value
+  * Range
+
+Changes to non-private members of those classes are subject to additional scrutiny to minimize compatibility problems across Accumulo versions.
+
 ### Coding Practices
 
 * License Header: Always add the current ASF license header as described in [ASF Source Header][srcheaders].