Skip to content

Commit

Permalink
minor(docs): Add docs for regen.sh (#13321)
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanc-n authored Nov 10, 2024
1 parent e6ad9d6 commit 221c85f
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/source/contributor-guide/howtos.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,17 @@ After you've confirmed your `taplo` version, you can format all the `.toml` file
```bash
taplo fmt
```

## How to update protobuf/gen dependencies

The prost/tonic code can be generated by running `./regen.sh`, which in turn invokes the Rust binary located in [gen](./gen)

This is necessary after modifying the protobuf definitions or altering the dependencies of [gen](./gen), and requires a
valid installation of [protoc] (see [installation instructions] for details).

```bash
./regen.sh
```

[protoc]: https://github.com/protocolbuffers/protobuf#protocol-compiler-installation
[installation instructions]: https://datafusion.apache.org/contributor-guide/getting_started.html#protoc-installation

0 comments on commit 221c85f

Please sign in to comment.