Skip to content

Commit ee00497

Browse files
committed
add comment in several hack/ sh scripts.
1 parent bae9f61 commit ee00497

File tree

5 files changed

+41
-0
lines changed

5 files changed

+41
-0
lines changed

hack/benchmark-go.sh

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@
1414
# See the License for the specific language governing permissions and
1515
# limitations under the License.
1616

17+
# This script runs `make test` command with some args for benchmark test.
18+
# The "true" target of this makerule is `hack/make-rules/test.sh`.
19+
# Args:
20+
# WHAT: Directory names to test. All *_test.go files under these
21+
# directories will be run. If not specified, "everything" will be tested.
22+
# Usage: `hack/benchmark-go.sh`.
23+
# Example: `hack/benchmark-go.sh WHAT=./pkg/kubelet`.
24+
1725
set -o errexit
1826
set -o nounset
1927
set -o pipefail

hack/build-cross.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@
1515
# limitations under the License.
1616

1717
# This script is a vestigial redirection. Please do not add "real" logic.
18+
# The "true" target of this makerule is `hack/make-rules/cross.sh`.
19+
20+
# This script runs `make cross` command.
21+
# The command sets up a go workspace locally and builds all for all appropriate
22+
# platforms.
23+
# Usage: `hack/build-cross.sh`.
1824

1925
set -o errexit
2026
set -o nounset

hack/build-go.sh

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,15 @@
1616

1717
# This script is a vestigial redirection. Please do not add "real" logic.
1818

19+
# This script runs `make all` command.
20+
# The command compiles all Makefile configs.
21+
# Args:
22+
# WHAT: Directory names to build. If any of these directories has a 'main'
23+
# package, the build will produce executable files under $(OUT_DIR)/go/bin.
24+
# If not specified, "everything" will be built.
25+
# Usage: `hack/build-go.sh`.
26+
# Example: `hack/build-go.sh WHAT=cmd/kubelet`.
27+
1928
set -o errexit
2029
set -o nounset
2130
set -o pipefail

hack/e2e-node-test.sh

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@
1515
# limitations under the License.
1616

1717
# This script is a vestigial redirection. Please do not add "real" logic.
18+
# The "true" target of this makerule is `hack/make-rules/test-e2e-node.sh`.
19+
20+
# This script runs `make test-e2e-node` command.
21+
# The command builds and runs node end-to-end tests.
22+
# Args:
23+
# FOCUS: Regexp that matches the tests to be run. Defaults to "".
24+
# SKIP: Regexp that matches the tests that needs to be skipped. Defaults
25+
# Usage: `hack/e2e-node-test.sh `.
26+
# Example: `hack/e2e-node-test.sh FOCUS=Kubelet SKIP=container`.
1827

1928
set -o errexit
2029
set -o nounset

hack/get-build.sh

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@
1414
# See the License for the specific language governing permissions and
1515
# limitations under the License.
1616

17+
# This script runs `curl` command to get the kubernetes build file.
18+
# Version number or publication is either a proper version number'
19+
# (e.g. "v1.0.6", "v1.2.0-alpha.1.881+376438b69c7612") or a version'
20+
# publication of the form <bucket>/<version> (e.g. "release/stable",'
21+
# "ci/latest-1").'
22+
23+
# Usage `hack/get-build.sh [Version]`.
24+
# Example `hack/get-build.sh v1.16.4`.
25+
1726
set -o errexit
1827
set -o nounset
1928
set -o pipefail

0 commit comments

Comments
 (0)