Skip to content

Commit 221c85f

Browse files
authored
minor(docs): Add docs for regen.sh (#13321)
1 parent e6ad9d6 commit 221c85f

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/source/contributor-guide/howtos.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,3 +132,17 @@ After you've confirmed your `taplo` version, you can format all the `.toml` file
132132
```bash
133133
taplo fmt
134134
```
135+
136+
## How to update protobuf/gen dependencies
137+
138+
The prost/tonic code can be generated by running `./regen.sh`, which in turn invokes the Rust binary located in [gen](./gen)
139+
140+
This is necessary after modifying the protobuf definitions or altering the dependencies of [gen](./gen), and requires a
141+
valid installation of [protoc] (see [installation instructions] for details).
142+
143+
```bash
144+
./regen.sh
145+
```
146+
147+
[protoc]: https://github.com/protocolbuffers/protobuf#protocol-compiler-installation
148+
[installation instructions]: https://datafusion.apache.org/contributor-guide/getting_started.html#protoc-installation

0 commit comments

Comments
 (0)