From 9ca0d32fbbb86b731df95bc9f604184fde69b4a8 Mon Sep 17 00:00:00 2001 From: Kai Chen Date: Fri, 5 Jan 2018 00:43:46 -0800 Subject: [PATCH] Improve comments for kubelet --- pkg/kubelet/apis/cri/runtime/v1alpha2/api.pb.go | 8 ++++---- pkg/kubelet/apis/cri/runtime/v1alpha2/api.proto | 8 ++++---- pkg/kubelet/apis/deviceplugin/v1alpha/api.pb.go | 6 +++--- pkg/kubelet/apis/deviceplugin/v1alpha/api.proto | 4 ++-- pkg/kubelet/apis/deviceplugin/v1alpha/constants.go | 4 ++-- pkg/kubelet/cadvisor/testing/cadvisor_fake.go | 2 +- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/pkg/kubelet/apis/cri/runtime/v1alpha2/api.pb.go b/pkg/kubelet/apis/cri/runtime/v1alpha2/api.pb.go index 79aea641047..4c930f77888 100644 --- a/pkg/kubelet/apis/cri/runtime/v1alpha2/api.pb.go +++ b/pkg/kubelet/apis/cri/runtime/v1alpha2/api.pb.go @@ -1066,7 +1066,7 @@ func (m *PodSandboxStatus) GetAnnotations() map[string]string { type PodSandboxStatusResponse struct { // Status of the PodSandbox. Status *PodSandboxStatus `protobuf:"bytes,1,opt,name=status" json:"status,omitempty"` - // Info is extra information of the PodSandbox. The key could be abitrary string, and + // Info is extra information of the PodSandbox. The key could be arbitrary string, and // value should be in json format. The information could include anything useful for // debug, e.g. network namespace for linux container based container runtime. // It should only be returned non-empty when Verbose is true. @@ -2401,7 +2401,7 @@ func (m *ContainerStatus) GetLogPath() string { type ContainerStatusResponse struct { // Status of the container. Status *ContainerStatus `protobuf:"bytes,1,opt,name=status" json:"status,omitempty"` - // Info is extra information of the Container. The key could be abitrary string, and + // Info is extra information of the Container. The key could be arbitrary string, and // value should be in json format. The information could include anything useful for // debug, e.g. pid for linux container based container runtime. // It should only be returned non-empty when Verbose is true. @@ -2870,7 +2870,7 @@ func (m *ImageStatusRequest) GetVerbose() bool { type ImageStatusResponse struct { // Status of the image. Image *Image `protobuf:"bytes,1,opt,name=image" json:"image,omitempty"` - // Info is extra information of the Image. The key could be abitrary string, and + // Info is extra information of the Image. The key could be arbitrary string, and // value should be in json format. The information could include anything useful // for debug, e.g. image config for oci image based container runtime. // It should only be returned non-empty when Verbose is true. @@ -3173,7 +3173,7 @@ func (m *StatusRequest) GetVerbose() bool { type StatusResponse struct { // Status of the Runtime. Status *RuntimeStatus `protobuf:"bytes,1,opt,name=status" json:"status,omitempty"` - // Info is extra information of the Runtime. The key could be abitrary string, and + // Info is extra information of the Runtime. The key could be arbitrary string, and // value should be in json format. The information could include anything useful for // debug, e.g. plugins used by the container runtime. // It should only be returned non-empty when Verbose is true. diff --git a/pkg/kubelet/apis/cri/runtime/v1alpha2/api.proto b/pkg/kubelet/apis/cri/runtime/v1alpha2/api.proto index 5c81e5f4c6d..d6f1aba5641 100644 --- a/pkg/kubelet/apis/cri/runtime/v1alpha2/api.proto +++ b/pkg/kubelet/apis/cri/runtime/v1alpha2/api.proto @@ -414,7 +414,7 @@ message PodSandboxStatus { message PodSandboxStatusResponse { // Status of the PodSandbox. PodSandboxStatus status = 1; - // Info is extra information of the PodSandbox. The key could be abitrary string, and + // Info is extra information of the PodSandbox. The key could be arbitrary string, and // value should be in json format. The information could include anything useful for // debug, e.g. network namespace for linux container based container runtime. // It should only be returned non-empty when Verbose is true. @@ -852,7 +852,7 @@ message ContainerStatus { message ContainerStatusResponse { // Status of the container. ContainerStatus status = 1; - // Info is extra information of the Container. The key could be abitrary string, and + // Info is extra information of the Container. The key could be arbitrary string, and // value should be in json format. The information could include anything useful for // debug, e.g. pid for linux container based container runtime. // It should only be returned non-empty when Verbose is true. @@ -993,7 +993,7 @@ message ImageStatusRequest { message ImageStatusResponse { // Status of the image. Image image = 1; - // Info is extra information of the Image. The key could be abitrary string, and + // Info is extra information of the Image. The key could be arbitrary string, and // value should be in json format. The information could include anything useful // for debug, e.g. image config for oci image based container runtime. // It should only be returned non-empty when Verbose is true. @@ -1088,7 +1088,7 @@ message StatusRequest { message StatusResponse { // Status of the Runtime. RuntimeStatus status = 1; - // Info is extra information of the Runtime. The key could be abitrary string, and + // Info is extra information of the Runtime. The key could be arbitrary string, and // value should be in json format. The information could include anything useful for // debug, e.g. plugins used by the container runtime. // It should only be returned non-empty when Verbose is true. diff --git a/pkg/kubelet/apis/deviceplugin/v1alpha/api.pb.go b/pkg/kubelet/apis/deviceplugin/v1alpha/api.pb.go index a0cb3df7cb2..0735b432867 100644 --- a/pkg/kubelet/apis/deviceplugin/v1alpha/api.pb.go +++ b/pkg/kubelet/apis/deviceplugin/v1alpha/api.pb.go @@ -106,7 +106,7 @@ func (*Empty) ProtoMessage() {} func (*Empty) Descriptor() ([]byte, []int) { return fileDescriptorApi, []int{1} } // ListAndWatch returns a stream of List of Devices -// Whenever a Device state change or a Device disapears, ListAndWatch +// Whenever a Device state changes or a Device disappears, ListAndWatch // returns the new list type ListAndWatchResponse struct { Devices []*Device `protobuf:"bytes,1,rep,name=devices" json:"devices,omitempty"` @@ -388,7 +388,7 @@ var _Registration_serviceDesc = grpc.ServiceDesc{ type DevicePluginClient interface { // ListAndWatch returns a stream of List of Devices - // Whenever a Device state change or a Device disapears, ListAndWatch + // Whenever a Device state changes or a Device disappears, ListAndWatch // returns the new list ListAndWatch(ctx context.Context, in *Empty, opts ...grpc.CallOption) (DevicePlugin_ListAndWatchClient, error) // Allocate is called during container creation so that the Device @@ -450,7 +450,7 @@ func (c *devicePluginClient) Allocate(ctx context.Context, in *AllocateRequest, type DevicePluginServer interface { // ListAndWatch returns a stream of List of Devices - // Whenever a Device state change or a Device disapears, ListAndWatch + // Whenever a Device state changes or a Device disappears, ListAndWatch // returns the new list ListAndWatch(*Empty, DevicePlugin_ListAndWatchServer) error // Allocate is called during container creation so that the Device diff --git a/pkg/kubelet/apis/deviceplugin/v1alpha/api.proto b/pkg/kubelet/apis/deviceplugin/v1alpha/api.proto index a38206f3691..3198a0d4063 100644 --- a/pkg/kubelet/apis/deviceplugin/v1alpha/api.proto +++ b/pkg/kubelet/apis/deviceplugin/v1alpha/api.proto @@ -40,7 +40,7 @@ message Empty { // DevicePlugin is the service advertised by Device Plugins service DevicePlugin { // ListAndWatch returns a stream of List of Devices - // Whenever a Device state change or a Device disapears, ListAndWatch + // Whenever a Device state changes or a Device disappears, ListAndWatch // returns the new list rpc ListAndWatch(Empty) returns (stream ListAndWatchResponse) {} @@ -51,7 +51,7 @@ service DevicePlugin { } // ListAndWatch returns a stream of List of Devices -// Whenever a Device state change or a Device disapears, ListAndWatch +// Whenever a Device state changes or a Device disappears, ListAndWatch // returns the new list message ListAndWatchResponse { repeated Device devices = 1; diff --git a/pkg/kubelet/apis/deviceplugin/v1alpha/constants.go b/pkg/kubelet/apis/deviceplugin/v1alpha/constants.go index 4ac85b93602..34e8847fa2f 100644 --- a/pkg/kubelet/apis/deviceplugin/v1alpha/constants.go +++ b/pkg/kubelet/apis/deviceplugin/v1alpha/constants.go @@ -17,9 +17,9 @@ limitations under the License. package deviceplugin const ( - // Healthy means that the device is healty + // Healthy means that the device is healthy Healthy = "Healthy" - // UnHealthy means that the device is unhealthy + // Unhealthy means that the device is unhealthy Unhealthy = "Unhealthy" // Current version of the API supported by kubelet diff --git a/pkg/kubelet/cadvisor/testing/cadvisor_fake.go b/pkg/kubelet/cadvisor/testing/cadvisor_fake.go index 53ab4afea31..f809aac4bca 100644 --- a/pkg/kubelet/cadvisor/testing/cadvisor_fake.go +++ b/pkg/kubelet/cadvisor/testing/cadvisor_fake.go @@ -51,7 +51,7 @@ func (c *Fake) DockerContainer(name string, req *cadvisorapi.ContainerInfoReques } func (c *Fake) MachineInfo() (*cadvisorapi.MachineInfo, error) { - // Simulate a matching with 1 core and 3.75GB of memory. + // Simulate a machine with 1 core and 3.75GB of memory. // We set it to non-zero values to make non-zero-capacity machines in Kubemark. return &cadvisorapi.MachineInfo{ NumCores: 1,