From 09a132be29df3e3f39b3092aa6147e42434e4381 Mon Sep 17 00:00:00 2001 From: Jin Hase Date: Fri, 17 Jan 2020 14:20:48 +0900 Subject: [PATCH] Add comments in several hack/verify-generated-*.sh --- hack/verify-generated-device-plugin.sh | 5 +++++ hack/verify-generated-docs.sh | 4 ++++ hack/verify-generated-files-remake.sh | 6 ++++++ hack/verify-generated-files.sh | 4 ++++ hack/verify-generated-kms.sh | 4 ++++ hack/verify-generated-kubelet-plugin-registration.sh | 6 ++++++ hack/verify-generated-pod-resources.sh | 5 +++++ hack/verify-generated-protobuf.sh | 5 +++++ hack/verify-generated-runtime.sh | 5 +++++ hack/verify-generated-swagger-docs.sh | 5 +++++ 10 files changed, 49 insertions(+) diff --git a/hack/verify-generated-device-plugin.sh b/hack/verify-generated-device-plugin.sh index 720b4a1d821..88118821761 100755 --- a/hack/verify-generated-device-plugin.sh +++ b/hack/verify-generated-device-plugin.sh @@ -14,6 +14,11 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether updating of device plugin API is needed or not. We +# should run `hack/update-generated-device-plugin.sh` if device plugin API is +# out of date. +# Usage: `hack/verify-generated-device-plugin.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-generated-docs.sh b/hack/verify-generated-docs.sh index 81f6c841301..a38df2e91d4 100755 --- a/hack/verify-generated-docs.sh +++ b/hack/verify-generated-docs.sh @@ -14,6 +14,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks that various type of documents(* .md, * .yaml and man +# files) are generated correctly(just verifies the generation process). +# Usage: `hack/verify-generated-docs.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-generated-files-remake.sh b/hack/verify-generated-files-remake.sh index d5c750a364b..dba39a057a0 100755 --- a/hack/verify-generated-files-remake.sh +++ b/hack/verify-generated-files-remake.sh @@ -14,6 +14,12 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script verifies that the expected results are obtained when creating each +# type of file(e.g. codegen tool itself, a file in a package that needs codegen, +# and etc.) for verification and then generating the code(executes +# `make generated_files`). +# Usage: `hack/verify-generated-files-remake.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-generated-files.sh b/hack/verify-generated-files.sh index e78b5e81e25..3ae824f7516 100755 --- a/hack/verify-generated-files.sh +++ b/hack/verify-generated-files.sh @@ -14,6 +14,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether updating of generated code is needed or not. We +# should run `make generated_files` if generated code is out of date. +# Usage: `hack/verify-generated-files.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-generated-kms.sh b/hack/verify-generated-kms.sh index 23f6616fe17..2b48334c90d 100755 --- a/hack/verify-generated-kms.sh +++ b/hack/verify-generated-kms.sh @@ -14,6 +14,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether updating of KMS gRPC is needed or not. We should +# run `hack/update-generated-kms.sh` if KMS gRPC is out of date. +# Usage: `hack/verify-generated-kms.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-generated-kubelet-plugin-registration.sh b/hack/verify-generated-kubelet-plugin-registration.sh index b02bb48a7aa..07b2f2af7c7 100755 --- a/hack/verify-generated-kubelet-plugin-registration.sh +++ b/hack/verify-generated-kubelet-plugin-registration.sh @@ -14,6 +14,12 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether updating of kubelet plugin registration API is +# needed or not. We should run +# `hack/update-generated-kubelet-plugin-registration.sh` if kubelet plugin +# registration API is out of date. +# Usage: `hack/verify-generated-kubelet-plugin-registration.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-generated-pod-resources.sh b/hack/verify-generated-pod-resources.sh index 43ab1340521..423e1819b76 100755 --- a/hack/verify-generated-pod-resources.sh +++ b/hack/verify-generated-pod-resources.sh @@ -14,6 +14,11 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether updating of Pod resources API is needed or not. We +# should run `hack/update-generated-pod-resources.sh` if Pod resources API is +# out of date. +# Usage: `hack/verify-generated-pod-resources.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-generated-protobuf.sh b/hack/verify-generated-protobuf.sh index 81a737d35fb..76185f8c8dc 100755 --- a/hack/verify-generated-protobuf.sh +++ b/hack/verify-generated-protobuf.sh @@ -14,6 +14,11 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether updating of the packages which explicitly +# requesting generation is needed or not. We should run +# `hack/update-generated-protobuf.sh` if those packages are out of date. +# Usage: `hack/verify-generated-protobuf.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-generated-runtime.sh b/hack/verify-generated-runtime.sh index 06f005e879b..0b237e65b09 100755 --- a/hack/verify-generated-runtime.sh +++ b/hack/verify-generated-runtime.sh @@ -14,6 +14,11 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether updating of container runtime API is needed or not. +# We should run `hack/update-generated-runtime.sh` if container runtime API is +# out of date. +# Usage: `hack/verify-generated-runtime.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/verify-generated-swagger-docs.sh b/hack/verify-generated-swagger-docs.sh index a69acce1a01..eae6e723e35 100755 --- a/hack/verify-generated-swagger-docs.sh +++ b/hack/verify-generated-swagger-docs.sh @@ -14,6 +14,11 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks whether updating of swagger type documentation is needed or +# not. We should run `hack/update-generated-swagger-docs.sh` if swagger type +# documentation is out of date. +# Usage: `hack/verify-generated-swagger-docs.sh`. + set -o errexit set -o nounset set -o pipefail