From ee00497ea94f2cf571bfe3ec56a7567df05147a1 Mon Sep 17 00:00:00 2001
From: Kobayashi Daisuke <kobayashi.da-06@fujitsu.com>
Date: Wed, 22 Jan 2020 13:48:13 +0900
Subject: [PATCH] add comment in several hack/ sh scripts.

---
 hack/benchmark-go.sh  | 8 ++++++++
 hack/build-cross.sh   | 6 ++++++
 hack/build-go.sh      | 9 +++++++++
 hack/e2e-node-test.sh | 9 +++++++++
 hack/get-build.sh     | 9 +++++++++
 5 files changed, 41 insertions(+)

diff --git a/hack/benchmark-go.sh b/hack/benchmark-go.sh
index 7a16d68f9aa..87da54693fe 100755
--- a/hack/benchmark-go.sh
+++ b/hack/benchmark-go.sh
@@ -14,6 +14,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script runs `make test` command with some args for benchmark test.
+# The "true" target of this makerule is `hack/make-rules/test.sh`.
+# Args:
+#   WHAT: Directory names to test.  All *_test.go files under these
+#     directories will be run.  If not specified, "everything" will be tested.
+# Usage: `hack/benchmark-go.sh`.
+# Example: `hack/benchmark-go.sh WHAT=./pkg/kubelet`.
+
 set -o errexit
 set -o nounset
 set -o pipefail
diff --git a/hack/build-cross.sh b/hack/build-cross.sh
index ce14beed7e4..343c1940c28 100755
--- a/hack/build-cross.sh
+++ b/hack/build-cross.sh
@@ -15,6 +15,12 @@
 # limitations under the License.
 
 # This script is a vestigial redirection.  Please do not add "real" logic.
+# The "true" target of this makerule is `hack/make-rules/cross.sh`.
+
+# This script runs `make cross` command.
+# The command sets up a go workspace locally and builds all for all appropriate
+# platforms.
+# Usage: `hack/build-cross.sh`.
 
 set -o errexit
 set -o nounset
diff --git a/hack/build-go.sh b/hack/build-go.sh
index bd709266146..fee6a922df9 100755
--- a/hack/build-go.sh
+++ b/hack/build-go.sh
@@ -16,6 +16,15 @@
 
 # This script is a vestigial redirection.  Please do not add "real" logic.
 
+# This script runs `make all` command.
+# The command compiles all Makefile configs.
+# Args:
+#   WHAT: Directory names to build.  If any of these directories has a 'main'
+#     package, the build will produce executable files under $(OUT_DIR)/go/bin.
+#     If not specified, "everything" will be built.
+# Usage: `hack/build-go.sh`.
+# Example: `hack/build-go.sh WHAT=cmd/kubelet`.
+
 set -o errexit
 set -o nounset
 set -o pipefail
diff --git a/hack/e2e-node-test.sh b/hack/e2e-node-test.sh
index 4a8bf6d66d7..94c2c7253ee 100755
--- a/hack/e2e-node-test.sh
+++ b/hack/e2e-node-test.sh
@@ -15,6 +15,15 @@
 # limitations under the License.
 
 # This script is a vestigial redirection.  Please do not add "real" logic.
+# The "true" target of this makerule is `hack/make-rules/test-e2e-node.sh`.
+
+# This script runs `make test-e2e-node` command.
+# The command builds and runs node end-to-end tests.
+# Args:
+#  FOCUS: Regexp that matches the tests to be run.  Defaults to "".
+#  SKIP: Regexp that matches the tests that needs to be skipped.  Defaults
+# Usage: `hack/e2e-node-test.sh `.
+# Example: `hack/e2e-node-test.sh FOCUS=Kubelet SKIP=container`.
 
 set -o errexit
 set -o nounset
diff --git a/hack/get-build.sh b/hack/get-build.sh
index 69ee76fe157..1c9d8f01e97 100755
--- a/hack/get-build.sh
+++ b/hack/get-build.sh
@@ -14,6 +14,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This script runs `curl` command to get the kubernetes build file.
+# Version number or publication is either a proper version number'
+# (e.g. "v1.0.6", "v1.2.0-alpha.1.881+376438b69c7612") or a version'
+#  publication of the form <bucket>/<version> (e.g. "release/stable",'
+# "ci/latest-1").'
+
+# Usage `hack/get-build.sh [Version]`.
+# Example `hack/get-build.sh v1.16.4`.
+
 set -o errexit
 set -o nounset
 set -o pipefail