From 0f53ba8d9a3351d3fc96b707df77e086f5b4f26c Mon Sep 17 00:00:00 2001 From: Edd Robinson Date: Thu, 8 Apr 2021 22:16:29 +0100 Subject: [PATCH] docs: improve flatc install --- docs/regenerating_flatbuffers.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/regenerating_flatbuffers.md b/docs/regenerating_flatbuffers.md index 1c5f8a07f5..f01bdede18 100644 --- a/docs/regenerating_flatbuffers.md +++ b/docs/regenerating_flatbuffers.md @@ -5,3 +5,6 @@ When updating the version of the [flatbuffers](https://crates.io/crates/flatbuff To update the generated code, edit `generated_types/regenerate-flatbuffers.sh` and set the `FB_COMMIT` variable at the top of the file to the commit SHA of the same commit in the [flatbuffers repository](https://github.com/google/flatbuffers) where the `flatbuffers` Rust crate version was updated. This ensures we'll be [using the same version of `flatc` that the crate was tested with](https://github.com/google/flatbuffers/issues/6199#issuecomment-714562121). Then run the `generated_types/regenerate-flatbuffers.sh` script and check in any changes. Check the whole project builds. + +`generated_types/regenerate-flatbuffers.sh` will build `flatc` from source if it cannot be found. +In order to do that your system will require `bazel`; you can likely install this with your favourite package manager.