HBASE-16742 Add chapter for devs on how we do protobufs going forward; ADDENDUM -- add in Duo Zhang remark
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/b5d34cf6 Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/b5d34cf6 Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/b5d34cf6 Branch: refs/heads/hbase-12439 Commit: b5d34cf6fc1daeb7e1140c34282885a13a1df473 Parents: 9e0c256 Author: stack <[email protected]> Authored: Tue Oct 4 08:34:10 2016 -0700 Committer: stack <[email protected]> Committed: Tue Oct 4 08:34:39 2016 -0700 ---------------------------------------------------------------------- src/main/asciidoc/_chapters/protobuf.adoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/b5d34cf6/src/main/asciidoc/_chapters/protobuf.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/_chapters/protobuf.adoc b/src/main/asciidoc/_chapters/protobuf.adoc index 3cbc504..4181878 100644 --- a/src/main/asciidoc/_chapters/protobuf.adoc +++ b/src/main/asciidoc/_chapters/protobuf.adoc @@ -74,12 +74,13 @@ practice needs to whither. We'll make plain why in the later xref:shaded.protobuf[hbase-2.0.0] section. [[cpeps]] -=== Coprocessor Endpoints +=== Coprocessor Endpoints (CPEPs) xref:cp:[Coprocessor Endpoints] are custom API a developer can add to HBase. Protobufs are used to describe the methods and arguments that comprise the new Service. Coprocessor Endpoints should make no use of HBase internals and -only avail of public APIs. This is not always possible but beware +only avail of public APIs; ideally a CPEP should depend on Interfaces +and data structures only. This is not always possible but beware that doing so makes the Endpoint brittle, liable to breakage as HBase internals evolve. HBase internal APIs annotated as private or evolving do not have to respect semantic versioning rules or general java rules on
