Add comments in several hack/verify-generated-*.sh

Author: hase1128

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

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

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

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

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

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

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

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

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

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