diff --git a/hack/get-build.sh b/hack/get-build.sh index 69ee76fe157..b88c7cf39ae 100755 --- a/hack/get-build.sh +++ b/hack/get-build.sh @@ -14,6 +14,11 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script retrieves the specified version of the Kubernetes tar.gz file via +# Google Cloud Storage. +# Usage: `hack/get-build.sh `. +# Example: `./hack/get-build.sh release/latest`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/ginkgo-e2e.sh b/hack/ginkgo-e2e.sh index f3c21a9c194..a501cb850aa 100755 --- a/hack/ginkgo-e2e.sh +++ b/hack/ginkgo-e2e.sh @@ -14,6 +14,9 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script runs e2e tests on Google Cloud Platform. +# Usage: `hack/ginkgo-e2e.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/grab-profiles.sh b/hack/grab-profiles.sh index b0a9bc08904..6657aa03f81 100755 --- a/hack/grab-profiles.sh +++ b/hack/grab-profiles.sh @@ -14,6 +14,9 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script grabs profiles from running components. +# Usage: `hack/grab-profiles.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/install-etcd.sh b/hack/install-etcd.sh index f66562cd2cc..897707460e8 100755 --- a/hack/install-etcd.sh +++ b/hack/install-etcd.sh @@ -14,8 +14,9 @@ # See the License for the specific language governing permissions and # limitations under the License. -# Convenience script to download and install etcd in third_party. +# This script is convenience to download and install etcd in third_party. # Mostly just used by CI. +# Usage: `hack/install-etcd.sh`. set -o errexit set -o nounset diff --git a/hack/lint-dependencies.sh b/hack/lint-dependencies.sh index 44c717ccdd2..f48df9c68b0 100755 --- a/hack/lint-dependencies.sh +++ b/hack/lint-dependencies.sh @@ -14,6 +14,10 @@ # See the License for the specific language governing permissions and # limitations under the License. +# This script checks version dependencies of modules. It checks whether all +# pinned versions of checked dependencies match their preferred version or not. +# Usage: `hack/lint-dependencies.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/list-feature-tests.sh b/hack/list-feature-tests.sh index 5d6bc77923e..d0af1c5529a 100755 --- a/hack/list-feature-tests.sh +++ b/hack/list-feature-tests.sh @@ -14,7 +14,9 @@ # See the License for the specific language governing permissions and # limitations under the License. -# A single script that lists all of the [Feature:.+] tests in our e2e suite. +# This script lists all of the [Feature:.+] tests in our e2e suite. +# Usage: `hack/list-feature-tests.sh`. + set -o errexit set -o nounset set -o pipefail diff --git a/hack/local-up-cluster.sh b/hack/local-up-cluster.sh index 4424f2b2f9a..e8f8a2bf046 100755 --- a/hack/local-up-cluster.sh +++ b/hack/local-up-cluster.sh @@ -16,9 +16,11 @@ KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/.. -# This command builds and runs a local kubernetes cluster. -# You may need to run this as root to allow kubelet to open docker's socket, -# and to write the test CA in /var/run/kubernetes. +# This script builds and runs a local kubernetes cluster. You may need to run +# this as root to allow kubelet to open docker's socket, and to write the test +# CA in /var/run/kubernetes. +# Usage: `hack/local-up-cluster.sh`. + DOCKER_OPTS=${DOCKER_OPTS:-""} export DOCKER=(docker "${DOCKER_OPTS[@]}") DOCKER_ROOT=${DOCKER_ROOT:-""} diff --git a/hack/pin-dependency.sh b/hack/pin-dependency.sh index 12abff23d4e..96150a7841d 100755 --- a/hack/pin-dependency.sh +++ b/hack/pin-dependency.sh @@ -14,11 +14,9 @@ # 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 +# This script switches to the preferred version for specified module. +# 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 diff --git a/hack/print-workspace-status.sh b/hack/print-workspace-status.sh index d4e415baa60..767567c034d 100755 --- a/hack/print-workspace-status.sh +++ b/hack/print-workspace-status.sh @@ -13,8 +13,9 @@ # See the License for the specific language governing permissions and # limitations under the License. -# This command is used by bazel as the workspace_status_command -# to implement build stamping with git information. +# This script is used by bazel as the workspace_status_command to implement +# build stamping with git information. +# Usage: `hack/print-workspace-status.sh`. set -o errexit set -o nounset diff --git a/hack/run-in-gopath.sh b/hack/run-in-gopath.sh index e29bb175f58..25cb5291671 100755 --- a/hack/run-in-gopath.sh +++ b/hack/run-in-gopath.sh @@ -15,9 +15,10 @@ # limitations under the License. # This script sets up a temporary Kubernetes GOPATH and runs an arbitrary -# command under it. Go tooling requires that the current directory be under +# command under it. Go tooling requires that the current directory be under # GOPATH or else it fails to find some things, such as the vendor directory for # the project. +# Usage: `hack/run-in-gopath.sh `. set -o errexit set -o nounset diff --git a/hack/test-go.sh b/hack/test-go.sh index d13946d8602..f95165454d3 100755 --- a/hack/test-go.sh +++ b/hack/test-go.sh @@ -14,7 +14,9 @@ # 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 *_test.go files. It is equivalent to `make test`. +# Usage: `hack/test-go.sh` or `make test`. +# Note: This script is a vestigial redirection. Please do not add "real" logic. set -o errexit set -o nounset diff --git a/hack/test-integration.sh b/hack/test-integration.sh index 5f1a9b5394f..033024e91ba 100755 --- a/hack/test-integration.sh +++ b/hack/test-integration.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 has been replaced by `make test-integration`. +# `make test-integration` runs all integration tests. +# Usage: `make test-integration`. +# Note: This script is a vestigial redirection. Please do not add "real" logic. set -o errexit set -o nounset