Merge pull request kubernetes#87379 from hase1128/add-comment-to-several-verify-scripts_3

Add comments in several hack/verify-*.sh(g-r)

Author: k8s-ci-robot

hack/verify-gofmt.sh

@@ -14,7 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# GoFmt apparently is changing @ head...
+# This script checks whether the source codes need to be formatted or not by
+# `gofmt`. We should run `hack/update-gofmt.sh` if actually formats them.
+# Usage: `hack/verify-gofmt.sh`.
+# Note: GoFmt apparently is changing @ head...
 
 set -o errexit
 set -o nounset

hack/verify-golint.sh

@@ -16,7 +16,7 @@
 
 # This script checks coding style for go language files in each
 # Kubernetes package by golint.
-# Usage: hack/verify-golint.sh
+# Usage: `hack/verify-golint.sh`.
 
 set -o errexit
 set -o nounset

hack/verify-govet.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 vets all *.go files by running `go vet`. It is equivalent to
+# `make vet`.
+# Usage: `hack/verify-govet.sh` or `make vet`.
+# Note: This script is a vestigial redirection. Please do not add "real" logic.
 
 set -o errexit
 set -o nounset

hack/verify-import-aliases.sh

@@ -14,6 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script verifies that all the imports have our preferred alias(es). The
+# preferred aliases for imports are listed in `hack/.import-aliases`.
+# Usage: `hack/verify-import-aliases.sh`.
+
 set -o errexit
 set -o nounset
 set -o pipefail

hack/verify-import-boss.sh

@@ -14,6 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script checks import restrictions. The script looks for a file called
+# `.import-restrictions` in each directory, then all imports of the package are
+# checked against each "rule" in the file.
+# Usage: `hack/verify-import-boss.sh`.
+
 set -o errexit
 set -o nounset
 set -o pipefail

hack/verify-imports.sh

@@ -14,6 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script checks restricted packages are imported or not and outputs the
+# result. Target directory's path and allowed packages against checking are
+# listed in `staging/publishing/import-restrictions.yaml`.
+# Usage: `hack/verify-imports.sh`.
+
 set -o errexit
 set -o nounset
 set -o pipefail

hack/verify-linkcheck.sh

@@ -17,7 +17,7 @@
 # This script extracts the links from types.go and .md files in pkg/api/,
 # pkg/apis/ and docs/ directories, checks the status code of the response, and
 # output the list of invalid links.
-# Usage: hack/verify-linkcheck.sh
+# Usage: `hack/verify-linkcheck.sh`.
 
 set -o errexit
 set -o nounset

hack/verify-no-vendor-cycles.sh

@@ -14,6 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script checks whether packages under `vendor` directory have cyclic
+# dependencies on `main` or `staging` repositories.
+# Usage: `hack/verify-no-vendor-cycles.sh`.
+
 set -o errexit
 set -o nounset
 set -o pipefail

hack/verify-openapi-spec.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 OpenAPI specification is needed or not.
+# We should run `hack/update-openapi-spec.sh` if OpenAPI specification is out of
+# date.
+# Usage: `hack/verify-openapi-spec.sh`.
+
 set -o errexit
 set -o nounset
 set -o pipefail

hack/verify-pkg-names.sh

@@ -14,7 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Verify whether codes follow golang convention.
+# This script verifies whether codes follow golang convention.
+# Usage: `hack/verify-pkg-names.sh`.
 
 set -o errexit
 set -o nounset