| Index: bootstrap/cipd/doc/infra/tools/protoc/linux-amd64/README.md
|
| diff --git a/bootstrap/cipd/doc/infra/tools/protoc/linux-amd64/README.md b/bootstrap/cipd/doc/infra/tools/protoc/linux-amd64/README.md
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..cb4b0a4876a40b326b0a57bceab60f17d274593a
|
| --- /dev/null
|
| +++ b/bootstrap/cipd/doc/infra/tools/protoc/linux-amd64/README.md
|
| @@ -0,0 +1,60 @@
|
| +# `infra/tools/protoc/linux-amd64`
|
| +## Building Instructions.
|
| +
|
| +Choose a build directory. We'll use the enviornment variable `$ROOT` to
|
| +represent it.
|
| +
|
| + $ cd $ROOT
|
| +
|
| +Clone the `protobuf` repository:
|
| +
|
| + $ git clone https://github.com/google/protobuf
|
| +
|
| +Run the build. We include the following additional configuration flags:
|
| +- `--disable-shared`: Build a static library.
|
| +- `--prefix $ROOT/PREFIX`: The installation prefix. This allows us to install
|
| + locally, so we don't need root.
|
| +
|
| +Build:
|
| +
|
| + $ cd protobuf
|
| + $ ./autogen.sh
|
| + $ ./configure --disable-shared --prefix $ROOT/PREFIX
|
| + $ make -j24 install
|
| +
|
| +This will install the generator to `$ROOT/PREFIX`. Afterwards, strip the binary.
|
| +This removes symbols and debugging information, including your username, from
|
| +the binary, reducing its size from ~40MiB to ~3MiB.
|
| +
|
| + $ strip -g $ROOT/PREFIX/bin/protoc
|
| +
|
| +We need to package the `$ROOT/PREFIX/include` directory because it includes
|
| +the protobuf standard library. However, we don't want to include all of the
|
| +C++ header files, nor do we want to include the compiled libraries. Prune the
|
| +contents of `$ROOT/PREFIX` to include only:
|
| +- The `protoc` binary.
|
| +- The standard library header files.
|
| +
|
| + $ rm -rf $ROOT/PREFIX/lib
|
| + $ find $ROOT/PREFIX/include -type f ! -name '*.proto' -delete
|
| +
|
| +The `protoc` utility searches for its default `include` path relative to its
|
| +binary location. First, it searches to see if the `include` path is in the same
|
| +directory as itself; if not, it looks in the parent directory. Because of the
|
| +way `CIPD` packages are installed, we opt to exploit the former location by
|
| +moving the `include` directory into the `bin` directory, then making the `bin`
|
| +directory the `CIPD` package root.
|
| +
|
| + $ mv $ROOT/PREFIX/include $ROOT/PREFIX/bin
|
| +
|
| +This will result in a deployment that looks like:
|
| + - `/protoc`: The statically-linked protocol buffers compiler.
|
| + - `/include/...`: Standard `proto3` include protobufs.
|
| +
|
| +Create package and deploy to `CIPD` server. Tag it with the Git commit of the
|
| +`protobuf` source from which it was built.
|
| +
|
| + $ cipd create \
|
| + -name "infra/tools/protoc/linux-amd64" \
|
| + -in $ROOT/PREFIX/bin \
|
| + -tag "git_commit:`git rev-parse HEAD`"
|
|
|