github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-23 11:50:44 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #91479 from ZhiFeng1993/ZF--add-comments-in-hack-update-scripts

Browse Source 
Add usage in some hack/update scripts
This commit is contained in:
Kubernetes Prow Robot 2020-06-15 05:28:26 -07:00 committed by GitHub
commit 7ac6b15ee4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
hack/update-generated-pod-resources.sh
View File

@ -14,6 +14,11 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # 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 errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

5
hack/update-generated-protobuf-dockerized.sh
View File

@ -14,6 +14,11 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # 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 errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

3
hack/update-generated-protobuf.sh
View File

@ -14,6 +14,9 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # 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 errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

3
hack/update-generated-runtime-dockerized.sh
View File

@ -14,6 +14,9 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # 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 errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

5
hack/update-generated-runtime.sh
View File

@ -14,6 +14,11 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # 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 errexit
set -o nounset set -o nounset
set -o pipefail set -o pipefail

2
hack/update-generated-swagger-docs.sh
View File

@ -14,7 +14,7 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # 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 # versions. That file contains functions on API structs that return
# the comments that should be surfaced for the corresponding API type # the comments that should be surfaced for the corresponding API type
# in our API docs. # in our API docs.