From 98b9d946132a29fb975e69d0da4c7ef876d40db2 Mon Sep 17 00:00:00 2001
From: William Banfield <wbanfield@gmail.com>
Date: Thu, 3 Mar 2022 15:21:54 -0500
Subject: [PATCH] add comment to explain files

---
 Makefile                                       |  2 ++
 proto/tendermint/abci/types.proto.intermediate | 14 +++++++++-----
 scripts/abci-gen.sh                            |  6 ++++++
 3 files changed, 17 insertions(+), 5 deletions(-)

diff --git a/Makefile b/Makefile
index 5ab7f0544..e0ec1fb7e 100644
--- a/Makefile
+++ b/Makefile
@@ -92,6 +92,8 @@ proto-gen:
 	@$(DOCKER_PROTO_BUILDER) buf generate --template=./buf.gen.yaml --config ./buf.yaml
 .PHONY: proto-gen
 
+# Should be removed when work on ABCI++ is complete.
+# For more information, see https://github.com/tendermint/tendermint/issues/8066
 abci-proto-gen:
 	./scripts/abci-gen.sh
 .PHONY: proto-gen
diff --git a/proto/tendermint/abci/types.proto.intermediate b/proto/tendermint/abci/types.proto.intermediate
index ac1a82a49..0535ca1da 100644
--- a/proto/tendermint/abci/types.proto.intermediate
+++ b/proto/tendermint/abci/types.proto.intermediate
@@ -1,8 +1,6 @@
 syntax = "proto3";
 package tendermint.abci;
 
-// For more information on gogo.proto, see:
-// https://github.com/gogo/protobuf/blob/master/extensions.md
 import "tendermint/crypto/proof.proto";
 import "tendermint/types/types.proto";
 import "tendermint/crypto/keys.proto";
@@ -10,9 +8,15 @@ import "tendermint/types/params.proto";
 import "google/protobuf/timestamp.proto";
 import "gogoproto/gogo.proto";
 
-// This file is copied from http://github.com/tendermint/abci
-// NOTE: When using custom types, mind the warnings.
-// https://github.com/gogo/protobuf/blob/master/custom_types.md#warnings-and-issues
+
+// This file is a temporary workaround to enable development during the ABCI++
+// project. This file should be deleted and any references to it removed when 
+// the ongoing work on ABCI++ is completed.
+//
+// For the duration of ABCI++, this file should be able to build the `abci/types/types.pb.go`
+// file. Any changes that that update that file must come as a result of a change in
+// this .proto file.
+// For more information, see https://github.com/tendermint/tendermint/issues/8066
 
 //----------------------------------------
 // Request types
diff --git a/scripts/abci-gen.sh b/scripts/abci-gen.sh
index 55ec7b958..fe3728ad4 100755
--- a/scripts/abci-gen.sh
+++ b/scripts/abci-gen.sh
@@ -1,4 +1,10 @@
 #!/usr/bin/env bash
+
+# This file was added during development of ABCI++. This file is a script to allow
+# the intermediate proto files to be built while active development proceeds
+# on ABCI++.
+# This file should be removed when work on ABCI++ is complete.
+# For more information, see https://github.com/tendermint/tendermint/issues/8066.
 set -euo pipefail
 
 cp ./proto/tendermint/abci/types.proto.intermediate ./proto/tendermint/abci/types.proto