From e1eabf8576af4c73b1e2039799f772753ab12271 Mon Sep 17 00:00:00 2001
From: Jin Hase <hase.jin@jp.fujitsu.com>
Date: Thu, 16 Jan 2020 13:54:58 +0900
Subject: [PATCH] Add comments in several hack/verify-*.sh

---
 hack/verify-all.sh                           | 5 ++++-
 hack/verify-api-groups.sh                    | 4 ++--
 hack/verify-bazel.sh                         | 4 ++++
 hack/verify-boilerplate.sh                   | 3 +++
 hack/verify-cli-conventions.sh               | 4 ++++
 hack/verify-codegen.sh                       | 5 +++++
 hack/verify-conformance-requirements.sh      | 4 ++++
 hack/verify-description.sh                   | 4 ++++
 hack/verify-external-dependencies-version.sh | 3 +++
 9 files changed, 33 insertions(+), 3 deletions(-)

diff --git a/hack/verify-all.sh b/hack/verify-all.sh
index c66f23e6838..108ab78d6a5 100755
--- a/hack/verify-all.sh
+++ b/hack/verify-all.sh
@@ -14,7 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# This script is a vestigial redirection.  Please do not add "real" logic.
+# This script runs all the verify scripts respectively, so we should run
+# `hack/verify-all.sh` before submit a PR. It is equivalent to `make verify`.
+# Usage: `hack/verify-all.sh` or `make verify`.
+# Note: This script is a vestigial redirection. Please do not add "real" logic.
 
 set -o errexit
 set -o nounset
diff --git a/hack/verify-api-groups.sh b/hack/verify-api-groups.sh
index 32da301594b..3274d7ef801 100755
--- a/hack/verify-api-groups.sh
+++ b/hack/verify-api-groups.sh
@@ -14,8 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# locate all API groups by their packages and versions
-
+# This scripts locates all API groups by their packages and versions
+# Usage: `hack/verify-api-groups.sh`.
 
 set -o errexit
 set -o nounset
diff --git a/hack/verify-bazel.sh b/hack/verify-bazel.sh
index 4b2f8f7e1a6..c3ff748f26f 100755
--- a/hack/verify-bazel.sh
+++ b/hack/verify-bazel.sh
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script checks whether updating of the bazel compilation files is needed
+# or not. We should run `hack/update-bazel.sh` if actually updates them.
+# Usage: `hack/verify-bazel.sh`.
+
 set -o errexit
 set -o nounset
 set -o pipefail
diff --git a/hack/verify-boilerplate.sh b/hack/verify-boilerplate.sh
index 19283371ce6..0819e20f286 100755
--- a/hack/verify-boilerplate.sh
+++ b/hack/verify-boilerplate.sh
@@ -14,6 +14,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script checks boilerplate header for all files.
+# Usage: `hack/verify-boilerplate.sh`.
+
 set -o errexit
 set -o nounset
 set -o pipefail
diff --git a/hack/verify-cli-conventions.sh b/hack/verify-cli-conventions.sh
index 61f3707dc1c..9a3b7a45f55 100755
--- a/hack/verify-cli-conventions.sh
+++ b/hack/verify-cli-conventions.sh
@@ -14,6 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script checks the description format of help message of kubectl command
+# is valid or not. And this checking is done for all kubectl sub-commands.
+# Usage: `hack/verify-cli-conventions.sh`.
+
 set -o errexit
 set -o nounset
 set -o pipefail
diff --git a/hack/verify-codegen.sh b/hack/verify-codegen.sh
index 6aa52346f0c..f45af22ab93 100755
--- a/hack/verify-codegen.sh
+++ b/hack/verify-codegen.sh
@@ -14,6 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script verifies whether code update is needed or not against the
+# specific sub-projects. The sub-projects are listed below this script(the
+# line that starts with `CODEGEN_PKG`).
+# Usage: `hack/verify-codegen.sh`.
+
 set -o errexit
 set -o nounset
 set -o pipefail
diff --git a/hack/verify-conformance-requirements.sh b/hack/verify-conformance-requirements.sh
index 58accea5bff..c4f01d60f9a 100755
--- a/hack/verify-conformance-requirements.sh
+++ b/hack/verify-conformance-requirements.sh
@@ -14,6 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script checks conformance tests follow the requirements as
+# https://git.k8s.io/community/contributors/devel/sig-architecture/conformance-tests.md#conformance-test-requirements
+# Usage: `hack/verify-conformance-requirements.sh`.
+
 set -o errexit
 set -o nounset
 set -o pipefail
diff --git a/hack/verify-description.sh b/hack/verify-description.sh
index 17cb9b6dc19..52a86456845 100755
--- a/hack/verify-description.sh
+++ b/hack/verify-description.sh
@@ -14,6 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script checks API-related files for missing descriptions and outputs a
+# list of structs and fields that are missing descriptions.
+# Usage: `hack/verify-description.sh`.
+
 set -o errexit
 set -o nounset
 set -o pipefail
diff --git a/hack/verify-external-dependencies-version.sh b/hack/verify-external-dependencies-version.sh
index 83b109e1a26..20f8bb158ed 100755
--- a/hack/verify-external-dependencies-version.sh
+++ b/hack/verify-external-dependencies-version.sh
@@ -14,6 +14,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script verifies that dependencies are up-to-date across different files
+# Usage: `hack/verify-external-dependencies-version.sh`.
+
 set -o errexit
 set -o nounset
 set -o pipefail