Add usage in some hack/update scripts

This commit is contained in:
ZhiFeng1993 2020-05-26 21:49:38 -07:00
parent a79c711191
commit 4ad6ae83ae
6 changed files with 22 additions and 1 deletions

View File

@ -14,6 +14,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.
# This script generates `/pkg/kubelet/apis/podresources/v1alpha1/api.pb.go`
# from the protobuf file `/pkg/kubelet/apis/podresources/v1alpha1/api.proto`
# for pods.
# Usage: `hack/update-generated-pod-resources.sh`.
set -o errexit
set -o nounset
set -o pipefail

View File

@ -14,6 +14,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.
# This script genertates `*/api.pb.go` from the protobuf file `*/api.proto`.
# Usage:
# hack/update-generated-protobuf-dockerized.sh "${APIROOTS}"
# An example APIROOT is: "k8s.io/api/admissionregistration/v1"
set -o errexit
set -o nounset
set -o pipefail

View File

@ -14,6 +14,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.
# This script generates all go files from the corresponding protobuf files.
# Usage: `hack/update-generated-protobuf.sh`.
set -o errexit
set -o nounset
set -o pipefail

View File

@ -14,6 +14,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.
# This script builds protoc-gen-gogo binary in runtime and genertates
# `*/api.pb.go` from the protobuf file `*/api.proto`.
set -o errexit
set -o nounset
set -o pipefail

View File

@ -14,6 +14,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.
# This script builds protoc-gen-gogo binary in runtime and genertates
# `*/api.pb.go` from the protobuf file `*/api.proto`.
# Usage:
# hack/update-generated-runtime.sh
set -o errexit
set -o nounset
set -o pipefail

View File

@ -14,7 +14,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
# Generates `types_swagger_doc_generated.go` files for API group
# This script generates `types_swagger_doc_generated.go` files for API group
# versions. That file contains functions on API structs that return
# the comments that should be surfaced for the corresponding API type
# in our API docs.