Skip to content

Commit c32b719

Browse files
committed
Add note about PROTOC_PATH
1 parent 5e4ea56 commit c32b719

File tree

5 files changed

+25
-0
lines changed

5 files changed

+25
-0
lines changed

Examples/echo/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ HTTP/2 transport.
1616

1717
You must have the Protocol Buffers compiler (`protoc`) installed. You can find
1818
the instructions for doing this in the [gRPC Swift Protobuf documentation][0].
19+
The `swift` commands below are all prefixed with `PROTOC_PATH=$(which protoc)`,
20+
this is to let the build system know where `protoc` is located so that it can
21+
generate stubs for you. You can read more about it in the [gRPC Swift Protobuf
22+
documentation][1].
1923

2024
## Usage
2125

@@ -51,3 +55,4 @@ $ PROTOC_PATH=$(which protoc) swift run echo --help
5155
```
5256

5357
[0]: https://swiftpackageindex.com/grpc/grpc-swift-protobuf/documentation/grpcprotobuf/installing-protoc
58+
[1]: https://swiftpackageindex.com/grpc/grpc-swift-protobuf/documentation/grpcprotobuf/generating-stubs

Examples/error-details/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ Guide](https://grpc.io/docs/guides/error/) and is made available via the
1414

1515
You must have the Protocol Buffers compiler (`protoc`) installed. You can find
1616
the instructions for doing this in the [gRPC Swift Protobuf documentation][0].
17+
The `swift` commands below are all prefixed with `PROTOC_PATH=$(which protoc)`,
18+
this is to let the build system know where `protoc` is located so that it can
19+
generate stubs for you. You can read more about it in the [gRPC Swift Protobuf
20+
documentation][1].
1721

1822
## Usage
1923

@@ -31,3 +35,4 @@ Error details:
3135
```
3236

3337
[0]: https://swiftpackageindex.com/grpc/grpc-swift-protobuf/documentation/grpcprotobuf/installing-protoc
38+
[1]: https://swiftpackageindex.com/grpc/grpc-swift-protobuf/documentation/grpcprotobuf/generating-stubs

Examples/hello-world/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ HTTP/2 transport.
1414

1515
You must have the Protocol Buffers compiler (`protoc`) installed. You can find
1616
the instructions for doing this in the [gRPC Swift Protobuf documentation][0].
17+
The `swift` commands below are all prefixed with `PROTOC_PATH=$(which protoc)`,
18+
this is to let the build system know where `protoc` is located so that it can
19+
generate stubs for you. You can read more about it in the [gRPC Swift Protobuf
20+
documentation][1].
1721

1822
## Usage
1923

@@ -39,3 +43,4 @@ Hello, PanCakes 🐶
3943
```
4044

4145
[0]: https://swiftpackageindex.com/grpc/grpc-swift-protobuf/documentation/grpcprotobuf/installing-protoc
46+
[1]: https://swiftpackageindex.com/grpc/grpc-swift-protobuf/documentation/grpcprotobuf/generating-stubs

Examples/reflection-server/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ protoc --descriptor_set_out=path/to/output.pb path/to/input.proto \
2727

2828
You must have the Protocol Buffers compiler (`protoc`) installed. You can find
2929
the instructions for doing this in the [gRPC Swift Protobuf documentation][0].
30+
The `swift` commands below are all prefixed with `PROTOC_PATH=$(which protoc)`,
31+
this is to let the build system know where `protoc` is located so that it can
32+
generate stubs for you. You can read more about it in the [gRPC Swift Protobuf
33+
documentation][1].
3034

3135
## Usage
3236

@@ -66,3 +70,4 @@ $ grpcurl -plaintext -d '{ "text": "Hello" }' 127.0.0.1:31415 echo.Echo.Get
6670
```
6771

6872
[0]: https://swiftpackageindex.com/grpc/grpc-swift-protobuf/documentation/grpcprotobuf/installing-protoc
73+
[1]: https://swiftpackageindex.com/grpc/grpc-swift-protobuf/documentation/grpcprotobuf/generating-stubs

Examples/route-guide/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ Index](https://swiftpackageindex.com/grpc/grpc-swift/main/tutorials/grpccore/rou
1919

2020
You must have the Protocol Buffers compiler (`protoc`) installed. You can find
2121
the instructions for doing this in the [gRPC Swift Protobuf documentation][0].
22+
The `swift` commands below are all prefixed with `PROTOC_PATH=$(which protoc)`,
23+
this is to let the build system know where `protoc` is located so that it can
24+
generate stubs for you. You can read more about it in the [gRPC Swift Protobuf
25+
documentation][1].
2226

2327
## Usage
2428

@@ -49,3 +53,4 @@ SUBCOMMANDS:
4953
```
5054

5155
[0]: https://swiftpackageindex.com/grpc/grpc-swift-protobuf/documentation/grpcprotobuf/installing-protoc
56+
[1]: https://swiftpackageindex.com/grpc/grpc-swift-protobuf/documentation/grpcprotobuf/generating-stubs

0 commit comments

Comments
 (0)