[VOL-2875] Documentation update
General language (spelling, flow) fixes
Remove redundant documentation
Change protos Makefile to generate directory using dependencies
Change-Id: I24fb2c9259c1a29b7499a35fd13e50836333c58e
diff --git a/protos/Makefile b/protos/Makefile
index 1394778..7f5394f 100644
--- a/protos/Makefile
+++ b/protos/Makefile
@@ -34,7 +34,7 @@
.DEFAULT_GOAL := all
-all: googleapis get_openolt_proto grpc-target protobuf-target libopenoltapi.a
+all: googleapis voltha_protos grpc-target protobuf-target libopenoltapi.a
libopenoltapi.a: $(OBJS)
ar cr $@ $^
@@ -49,7 +49,8 @@
make -C googleapis LANGUAGE=cpp GRPCPLUGIN=$(GRPC_CPP_PLUGIN_PATH) all; \
fi;
-get_openolt_proto:
+voltha_protos:
+ mkdir voltha_protos
if [ ! -e "voltha_protos/openolt.proto" ]; then \
wget -O voltha_protos/openolt.proto https://raw.githubusercontent.com/opencord/voltha-protos/$(OPENOLT_PROTO_VER)/protos/voltha_protos/openolt.proto; \
fi; \
@@ -61,12 +62,12 @@
$(PROTOC) --proto_path=. -I./googleapis --grpc_out=. --plugin=protoc-gen-grpc=$(GRPC_CPP_PLUGIN_PATH) voltha_protos/openolt.proto
$(PROTOC) --proto_path=. -I./googleapis --grpc_out=. --plugin=protoc-gen-grpc=$(GRPC_CPP_PLUGIN_PATH) voltha_protos/tech_profile.proto
-protobuf-target:
+protobuf-target: voltha_protos
$(PROTOC) --proto_path=. -I./googleapis -I./ --cpp_out=. voltha_protos/openolt.proto
$(PROTOC) --proto_path=. -I./googleapis -I./ --cpp_out=. voltha_protos/tech_profile.proto
clean:
- rm -f *.a && cd voltha_protos/ && rm -f *.o *.pb.cc *.pb.h *.proto
+ rm -rf *.a voltha_protos
distclean: clean
rm -rf googleapis
diff --git a/protos/README.md b/protos/README.md
deleted file mode 100644
index 6e892c4..0000000
--- a/protos/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# openolt-api
-
-**openolt-api** is the protobuf definition of the gRPC service implemented by [OpenOLT](https://github.com/OpenOLT). See [openolt](https://github.com/OpenOLT/openolt) and [openasf](https://github.com/OpenOLT/openasf).
diff --git a/protos/voltha_protos/README.md b/protos/voltha_protos/README.md
deleted file mode 100644
index 84c6460..0000000
--- a/protos/voltha_protos/README.md
+++ /dev/null
@@ -1,5 +0,0 @@
-# Place holder directory for openolt.proto and tech_profile.proto
-
-This is a place holder directory for openolt.proto and tech_profile.proto file downloaded
-from https://github.com/opencord/voltha-protos repo.
-