Skip to content

Commit 4ad6ae8

Browse files
author
ZhiFeng1993
committed
Add usage in some hack/update scripts
1 parent a79c711 commit 4ad6ae8

6 files changed

+22
-1
lines changed

hack/update-generated-pod-resources.sh

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

17+
# This script generates `/pkg/kubelet/apis/podresources/v1alpha1/api.pb.go`
18+
# from the protobuf file `/pkg/kubelet/apis/podresources/v1alpha1/api.proto`
19+
# for pods.
20+
# Usage: `hack/update-generated-pod-resources.sh`.
21+
1722
set -o errexit
1823
set -o nounset
1924
set -o pipefail

hack/update-generated-protobuf-dockerized.sh

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

17+
# This script genertates `*/api.pb.go` from the protobuf file `*/api.proto`.
18+
# Usage:
19+
# hack/update-generated-protobuf-dockerized.sh "${APIROOTS}"
20+
# An example APIROOT is: "k8s.io/api/admissionregistration/v1"
21+
1722
set -o errexit
1823
set -o nounset
1924
set -o pipefail

hack/update-generated-protobuf.sh

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

17+
# This script generates all go files from the corresponding protobuf files.
18+
# Usage: `hack/update-generated-protobuf.sh`.
19+
1720
set -o errexit
1821
set -o nounset
1922
set -o pipefail

hack/update-generated-runtime-dockerized.sh

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

17+
# This script builds protoc-gen-gogo binary in runtime and genertates
18+
# `*/api.pb.go` from the protobuf file `*/api.proto`.
19+
1720
set -o errexit
1821
set -o nounset
1922
set -o pipefail

hack/update-generated-runtime.sh

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

17+
# This script builds protoc-gen-gogo binary in runtime and genertates
18+
# `*/api.pb.go` from the protobuf file `*/api.proto`.
19+
# Usage:
20+
# hack/update-generated-runtime.sh
21+
1722
set -o errexit
1823
set -o nounset
1924
set -o pipefail

hack/update-generated-swagger-docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
# See the License for the specific language governing permissions and
1515
# limitations under the License.
1616

17-
# Generates `types_swagger_doc_generated.go` files for API group
17+
# This script generates `types_swagger_doc_generated.go` files for API group
1818
# versions. That file contains functions on API structs that return
1919
# the comments that should be surfaced for the corresponding API type
2020
# in our API docs.

0 commit comments

Comments
 (0)