Notes on troubleshooting protobuf code generation

2015-07-06 08:57:54 -04:00 · 2015-07-06 08:57:54 -04:00 · b49bc3626d
parent 2e1bca1ffc
commit b49bc3626d
1 changed files with 5 additions and 0 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -198,6 +198,11 @@ Finally run, `go generate` after updating any `*.proto` file:
 ```bash
 go generate ./...
 ```
+**Trouleshooting**
+
+If generating the protobuf code is failing for you, check each of the following:
+ * Ensure the protobuf library can be found. Make sure that `LD_LIBRRARY_PATH` includes the directory in which the library `libprotoc.so` has been installed.
+ * Ensure the command `protoc-gen-gogo`, found in `GOPATH/bin` is on your path. This can be done by adding `GOPATH/bin` to `PATH`.

 Continuous Integration testing
 -----