aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorShohei Kamimori <jyane.kstm@gmail.com>2018-03-29 07:34:18 +0900
committerEric Gribkoff <ericgribkoff@google.com>2018-03-28 15:34:18 -0700
commit5af2515f3ea55bdbf65a3e96bf664ab2e4e5678e (patch)
tree2c7ebdd300e5a215428944d2b5ced9d7e4973f89 /README.md
parent77e3b97f913c50594a0de28946d3e0416edbe86c (diff)
downloadgrpc-grpc-java-5af2515f3ea55bdbf65a3e96bf664ab2e4e5678e.tar.gz
core,README: add docs about grpc-java-api-checker (#4182)
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index de0e422db..1aacf3b2a 100644
--- a/README.md
+++ b/README.md
@@ -239,3 +239,16 @@ The [examples](https://github.com/grpc/grpc-java/tree/master/examples)
and the
[Android example](https://github.com/grpc/grpc-java/tree/master/examples/android) are standalone projects that
showcase the usage of gRPC.
+
+Tools
+-----
+
+APIs annotated with `@Internal` are for internal use by the gRPC library and
+should not be used by gRPC users. APIs annotated with `@ExperimentalApi` are
+subject to change in future releases, and library code that other projects
+may depend on should not use these APIs. We recommend using the
+[grpc-java-api-checker](https://github.com/grpc/grpc-java-api-checker)
+(an [Error Prone](https://github.com/google/error-prone) plugin)
+to check for usages of `@ExperimentalApi` and `@Internal` in any library code
+that depends on gRPC. It may also be used to check for `@Internal` usage or
+unintended `@ExperimentalApi` consumption in non-library code.