From b6413de273816ccbce20d318a2481f456f667fb5 Mon Sep 17 00:00:00 2001 From: "Nicolas \"Pixel\" Noble" <pixel@nobis-crew.org> Date: Fri, 10 Apr 2015 00:24:09 +0200 Subject: [PATCH] Updating documentation. --- cpp/README.md | 5 +++-- cpp/cpptutorial.md | 11 +++++++---- cpp/helloworld/README.md | 5 +++-- 3 files changed, 13 insertions(+), 8 deletions(-) diff --git a/cpp/README.md b/cpp/README.md index e9e9962a9b..e0a09ff8b8 100644 --- a/cpp/README.md +++ b/cpp/README.md @@ -30,12 +30,13 @@ $ cd grpc-common/cpp/helloworld/ To generate the client and server side interfaces: ```sh -$ make helloworld.pb.cc +$ make helloworld.grpc.pb.cc helloworld.pb.cc ``` Which internally invokes the proto-compiler as: ```sh -$ protoc -I ../../protos/ --cpp_out=. --grpc_out=. --plugin=protoc-gen-grpc=grpc_cpp_plugin ../../protos/helloworld.proto +$ protoc -I ../../protos/ --grpc_out=. --plugin=protoc-gen-grpc=grpc_cpp_plugin ../../protos/helloworld.proto +$ protoc -I ../../protos/ --cpp_out=. ../../protos/helloworld.proto ``` ### Client and server implementations diff --git a/cpp/cpptutorial.md b/cpp/cpptutorial.md index ebad7b183b..9d49405118 100644 --- a/cpp/cpptutorial.md +++ b/cpp/cpptutorial.md @@ -94,18 +94,21 @@ Next we need to generate the gRPC client and server interfaces from our .proto s For simplicity, we've provided a [makefile](https://github.com/grpc/grpc-common/blob/master/cpp/route_guide/Makefile) that runs `protoc` for you with the appropriate plugin, input, and output (if you want to run this yourself, make sure you've installed protoc and followed the gRPC code [installation instructions](https://github.com/grpc/grpc/blob/master/INSTALL) first): ```shell -$ make route_guide.pb.cc +$ make route_guide.grpc.pb.cc route_guide.pb.cc ``` which actually runs: ```shell -$ protoc -I ../../protos --cpp_out=. --grpc_out=. --plugin=protoc-gen-grpc=`which grpc_cpp_plugin` ../../protos/route_guide.proto +$ protoc -I ../../protos --grpc_out=. --plugin=protoc-gen-grpc=`which grpc_cpp_plugin` ../../protos/route_guide.proto +$ protoc -I ../../protos --cpp_out=. ../../protos/route_guide.proto ``` Running this command generates the following files in your current directory: -- `route_guide.pb.h`, the header which declares your generated classes -- `route_guide.pb.cc`, which contains the implementation of your classes +- `route_guide.pb.h`, the header which declares your generated message classes +- `route_guide.pb.cc`, which contains the implementation of your message classes +- `route_guide.grpc.pb.h`, the header which declares your generated service classes +- `route_guide.grpc.pb.cc`, which contains the implementation of your service classes These contain: - All the protocol buffer code to populate, serialize, and retrieve our request and response message types diff --git a/cpp/helloworld/README.md b/cpp/helloworld/README.md index 16456a8245..bc7df3f8c7 100644 --- a/cpp/helloworld/README.md +++ b/cpp/helloworld/README.md @@ -78,12 +78,13 @@ defined in our `Greeting` service. To generate the client and server side interfaces: ```sh -$ make helloworld.pb.cc +$ make helloworld.grpc.pb.cc helloworld.pb.cc ``` Which internally invokes the proto-compiler as: ```sh -$protoc -I ../../protos/ --cpp_out=. --grpc_out=. --plugin=protoc-gen-grpc=grpc_cpp_plugin helloworld.proto +$ protoc -I ../../protos/ --grpc_out=. --plugin=protoc-gen-grpc=grpc_cpp_plugin ../../protos/helloworld.proto +$ protoc -I ../../protos/ --cpp_out=. ../../protos/helloworld.proto ``` ### Writing a client -- GitLab