diff options
| author |  Jan Tattermusch <jtattermusch@users.noreply.github.com> | 2016-06-09 14:50:01 -0700 |
|---|---|---|
| committer | Jan Tattermusch <jtattermusch@users.noreply.github.com> | 2016-06-09 14:50:01 -0700 |
| commit | a5871cf9c27d616f467f1eef8bf5006a45017cc9 (patch) | |
| tree | 65506739485dc0c25531f8f8f4cffdcb91bafec2 /tools/distrib | |
| parent | c2663680a01cff10a1e8d0d27aef01d994023dff (diff) | |
| parent | 82c3dd1f0a96944122d3a0e40242d592a2c7db64 (diff) | |
Merge pull request #6843 from soltanmm/doc-tools
Add usage documentation to Python tools distribution
Diffstat (limited to 'tools/distrib')
| -rw-r--r-- | tools/distrib/python/grpcio_tools/README.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/tools/distrib/python/grpcio_tools/README.rst b/tools/distrib/python/grpcio_tools/README.rst index 10d2fe8c30..e9f137493b 100644 --- a/tools/distrib/python/grpcio_tools/README.rst +++ b/tools/distrib/python/grpcio_tools/README.rst @@ -126,3 +126,13 @@ Help, I ... GCC 6.0), this is probably a bug where GCC chokes on constant expressions when the :code:`-fwrapv` flag is specified. You should consider setting your environment with :code:`CFLAGS=-fno-wrapv` or using clang (:code:`CC=clang`). + +Usage +----- + +Given protobuf include directories :code:`$INCLUDE`, an output directory +:code:`$OUTPUT`, and proto files :code:`$PROTO_FILES`, invoke as: + +:: + + $ python -m grpc.tools.protoc -I$INCLUDE --python_out=$OUTPUT --grpc_python_out=$OUTPUT $PROTO_FILES |