mirror of
https://github.com/etcd-io/etcd.git
synced 2024-09-27 06:25:44 +00:00
b1f95c314b
There was a bug in protodoc. This changes git SHA to use the latest protodoc. And make the letter casing consistent with original Protocol Buffer. Go capitalizes the member variables, but the protocol buffer documentation should be same as original proto files.
88 lines
2.7 KiB
Bash
Executable File
88 lines
2.7 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
#
|
|
# Generate all etcd protobuf bindings.
|
|
# Run from repository root.
|
|
#
|
|
set -e
|
|
|
|
if ! [[ "$0" =~ "scripts/genproto.sh" ]]; then
|
|
echo "must be run from repository root"
|
|
exit 255
|
|
fi
|
|
|
|
# for now, be conservative about what version of protoc we expect
|
|
if ! [[ $(protoc --version) =~ "3.0.0" ]]; then
|
|
echo "could not find protoc 3.0.0, is it installed + in PATH?"
|
|
exit 255
|
|
fi
|
|
|
|
# directories containing protos to be built
|
|
DIRS="./wal/walpb ./etcdserver/etcdserverpb ./snap/snappb ./raft/raftpb ./mvcc/mvccpb ./lease/leasepb ./auth/authpb"
|
|
|
|
# exact version of protoc-gen-gogo to build
|
|
SHA="c3995ae437bb78d1189f4f147dfe5f87ad3596e4"
|
|
|
|
# set up self-contained GOPATH for building
|
|
export GOPATH=${PWD}/gopath
|
|
export GOBIN=${PWD}/bin
|
|
export PATH="${GOBIN}:${PATH}"
|
|
|
|
COREOS_ROOT="${GOPATH}/src/github.com/coreos"
|
|
ETCD_ROOT="${COREOS_ROOT}/etcd"
|
|
GOGOPROTO_ROOT="${GOPATH}/src/github.com/gogo/protobuf"
|
|
GOGOPROTO_PATH="${GOGOPROTO_ROOT}:${GOGOPROTO_ROOT}/protobuf"
|
|
|
|
rm -f "${ETCD_ROOT}"
|
|
mkdir -p "${COREOS_ROOT}"
|
|
ln -s "${PWD}" "${ETCD_ROOT}"
|
|
|
|
# Ensure we have the right version of protoc-gen-gogo by building it every time.
|
|
# TODO(jonboulle): vendor this instead of `go get`ting it.
|
|
go get github.com/gogo/protobuf/{proto,protoc-gen-gogo,gogoproto}
|
|
go get golang.org/x/tools/cmd/goimports
|
|
pushd "${GOGOPROTO_ROOT}"
|
|
git reset --hard "${SHA}"
|
|
make install
|
|
popd
|
|
|
|
for dir in ${DIRS}; do
|
|
pushd ${dir}
|
|
protoc --gogofast_out=plugins=grpc,import_prefix=github.com/coreos/:. -I=.:"${GOGOPROTO_PATH}":"${COREOS_ROOT}" *.proto
|
|
sed -i.bak -E "s/github\.com\/coreos\/(gogoproto|github\.com|golang\.org|google\.golang\.org)/\1/g" *.pb.go
|
|
sed -i.bak -E 's/github\.com\/coreos\/(errors|fmt|io)/\1/g' *.pb.go
|
|
sed -i.bak -E 's/import _ \"gogoproto\"//g' *.pb.go
|
|
sed -i.bak -E 's/import fmt \"fmt\"//g' *.pb.go
|
|
rm -f *.bak
|
|
goimports -w *.pb.go
|
|
popd
|
|
done
|
|
|
|
|
|
# install protodoc
|
|
# go get -v -u github.com/coreos/protodoc
|
|
#
|
|
# by default, do not run this option.
|
|
# only run when './scripts/genproto.sh -g'
|
|
#
|
|
if [ "$1" = "-g" ]; then
|
|
echo "protodoc is auto-generating grpc API reference documentation..."
|
|
go get -v -u github.com/coreos/protodoc
|
|
SHA_PROTODOC="150f6f93d89aedb208f443d38f50bb03abbc9290"
|
|
PROTODOC_PATH="${GOPATH}/src/github.com/coreos/protodoc"
|
|
pushd "${PROTODOC_PATH}"
|
|
git reset --hard "${SHA_PROTODOC}"
|
|
go install
|
|
echo "protodoc is updated"
|
|
popd
|
|
|
|
protodoc --directories="etcdserver/etcdserverpb=service_message,mvcc/mvccpb=service_message,lease/leasepb=service_message,auth/authpb=service_message" \
|
|
--title="etcd API Reference" \
|
|
--output="Documentation/dev-guide/api_reference_v3.md" \
|
|
--message-only-from-this-file="etcdserver/etcdserverpb/rpc.proto"
|
|
|
|
echo "protodoc is finished..."
|
|
else
|
|
echo "skipping grpc API reference document auto-generation..."
|
|
fi
|
|
|