Merge pull request #87181 from tanjunchen/add-comment-hack-update

add comment in hack/update-*.sh

hack/pin-dependency.sh

@@ -14,6 +14,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Usage:
+#   hack/pin-dependency.sh $MODULE $SHA-OR-TAG
+#
+# Example:
+#   hack/pin-dependency.sh github.com/docker/docker 501cb131a7b7
+
 set -o errexit
 set -o nounset
 set -o pipefail
@@ -21,12 +27,6 @@ set -o pipefail
 KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 source "${KUBE_ROOT}/hack/lib/init.sh"
 
-# Usage:
-#   hack/pin-dependency.sh $MODULE $SHA-OR-TAG
-#
-# Example:
-#   hack/pin-dependency.sh github.com/docker/docker 501cb131a7b7
-
 # Explicitly opt into go modules, even though we're inside a GOPATH directory
 export GO111MODULE=on
 # Explicitly clear GOFLAGS, since GOFLAGS=-mod=vendor breaks dependency resolution while rebuilding vendor

hack/update-all.sh

@@ -16,6 +16,9 @@
 
 # This script is a vestigial redirection.  Please do not add "real" logic.
 # The "true" target of this makerule is `hack/make-rules/update.sh`.
+# We should run `hack/update-all.sh` if anything fails after 
+# running `hack/verify-all.sh`. It is equivalent to `make update`. 
+# Usage: `hack/update-all.sh` or `make update`.
 
 set -o errexit
 set -o nounset

hack/update-codegen.sh

@@ -14,6 +14,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Please do not add any logic to this shell script. Add logic to the go code
+# that generates the set-gen program.
+
 set -o errexit
 set -o nounset
 set -o pipefail
@@ -34,10 +37,6 @@ clientgen=$(kube::util::find-binary "client-gen")
 listergen=$(kube::util::find-binary "lister-gen")
 informergen=$(kube::util::find-binary "informer-gen")
 
-# Please do not add any logic to this shell script. Add logic to the go code
-# that generates the set-gen program.
-#
-
 IFS=" " read -r -a GROUP_VERSIONS <<< "${KUBE_AVAILABLE_GROUP_VERSIONS}"
 GV_DIRS=()
 for gv in "${GROUP_VERSIONS[@]}"; do

hack/update-generated-device-plugin-dockerized.sh

@@ -14,6 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script generates `*/api.pb.go` from the protobuf file `*/api.proto`.
+# Example:
+#   kube::protoc::generate_proto "${DEVICE_PLUGIN_ALPHA}"
+
 set -o errexit
 set -o nounset
 set -o pipefail

hack/update-generated-kubelet-plugin-registration-dockerized.sh

@@ -14,6 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script generates `*/api.pb.go` from the protobuf file `*/api.proto`.
+# Example:
+#   kube::protoc::generate_proto "${KUBELET_PLUGIN_REGISTRATION_V1ALPHA}"
+
 set -o errexit
 set -o nounset
 set -o pipefail

hack/update-generated-pod-resources-dockerized.sh

@@ -14,6 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script generates `*/api.pb.go` from the protobuf file `*/api.proto`.
+# Example:
+#   kube::protoc::generate_proto "${POD_RESOURCES_ALPHA}"
+
 set -o errexit
 set -o nounset
 set -o pipefail

hack/update-import-aliases.sh

@@ -14,6 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script fixes imports programmatically according to 
+# all the imports that we have our preferred alias(es).
+# Usage: `hack/update-import-aliases.sh`.
+
 set -o errexit
 set -o nounset
 set -o pipefail

hack/update-translations.sh

@@ -14,6 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script updates `translations/kubectl/template.pot` for 
+# `pkg/kubectl/cmd/*.go pkg/kubectl/cmd/*/*.go`. 
+# Usage: `update-translations.sh`.
+
 KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 source "${KUBE_ROOT}/hack/lib/util.sh"