aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/ruby/pb/README.md
diff options
context:
space:
mode:
authorGravatar Jan Tattermusch <jtattermusch@google.com>2015-08-26 08:50:19 -0700
committerGravatar Jan Tattermusch <jtattermusch@google.com>2015-08-26 08:50:19 -0700
commit0608a00b505fe43a52614ec8703bb589332af064 (patch)
tree72937fe6fb2423e52134af3ce2a4beea73da69d3 /src/ruby/pb/README.md
parentd8fc8606740416b1cbe4d2f3754705b108fd2c5c (diff)
parentafbbaf9c3e21b6a4fe41242df9d052e077dc25c0 (diff)
Merge remote-tracking branch 'upstream/master' into csharp_upgrade_to_proto3
Conflicts: src/csharp/Grpc.IntegrationTesting/InteropClient.cs
Diffstat (limited to 'src/ruby/pb/README.md')
-rw-r--r--src/ruby/pb/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/src/ruby/pb/README.md b/src/ruby/pb/README.md
new file mode 100644
index 0000000000..84644e1098
--- /dev/null
+++ b/src/ruby/pb/README.md
@@ -0,0 +1,42 @@
+Protocol Buffers
+================
+
+This folder contains protocol buffers provided with gRPC ruby, and the generated
+code to them.
+
+PREREQUISITES
+-------------
+
+The code is is generated using the protoc (> 3.0.0.alpha.1) and the
+grpc_ruby_plugin. These must be installed to regenerate the IDL defined
+classes, but that's not necessary just to use them.
+
+health_check/v1alpha
+--------------------
+
+This package defines the surface of a simple health check service that gRPC
+servers may choose to implement, and provides an implementation for it. To
+re-generate the surface.
+
+```bash
+$ # (from this directory)
+$ protoc -I . grpc/health/v1alpha/health.proto \
+ --grpc_out=. \
+ --ruby_out=. \
+ --plugin=protoc-gen-grpc=`which grpc_ruby_plugin`
+```
+
+test
+----
+
+This package defines the surface of the gRPC interop test service and client
+To re-generate the surface, it's necessary to have checked-out versions of
+the grpc interop test proto, e.g, by having the full gRPC repository. E.g,
+
+```bash
+$ # (from this directory within the grpc repo)
+$ protoc -I../../.. ../../../test/proto/{messages,test,empty}.proto \
+ --grpc_out=. \
+ --ruby_out=. \
+ --plugin=protoc-gen-grpc=`which grpc_ruby_plugin`
+```