remove import doc comments

The "// import <path>" comment has been superseded by Go modules.
We don't have to remove them, but doing so has some advantages:

- They are used inconsistently, which is confusing.
- We can then also remove the (currently broken) hack/update-vanity-imports.sh.
- Last but not least, it would be a first step towards avoiding the k8s.io domain.

This commit was generated with
   sed -i -e 's;^package \(.*\) // import.*;package \1;' $(git grep -l '^package.*// import' | grep -v 'vendor/')

Everything was included, except for
   package labels // import k8s.io/kubernetes/pkg/util/labels
because that package is marked as "read-only".

Kubernetes-commit: 8a908e0c0bd96a3455edf7e3b5f5af90564e65b0
This commit is contained in:
Patrick Ohly 2024-12-02 14:43:58 +01:00 committed by Kubernetes Publisher
parent 706280d1e7
commit 70a4950f35
30 changed files with 30 additions and 30 deletions

View File

@ -148,4 +148,4 @@ reconciliation code that performs a "read/modify-in-place/update" (or patch) wor
// apply // apply
applied, err := deploymentClient.Apply(ctx, extractedDeployment, metav1.ApplyOptions{FieldManager: fieldMgr}) applied, err := deploymentClient.Apply(ctx, extractedDeployment, metav1.ApplyOptions{FieldManager: fieldMgr})
*/ */
package applyconfigurations // import "k8s.io/client-go/applyconfigurations" package applyconfigurations

View File

@ -16,4 +16,4 @@ limitations under the License.
// Package discovery provides ways to discover server-supported // Package discovery provides ways to discover server-supported
// API groups, versions and resources. // API groups, versions and resources.
package discovery // import "k8s.io/client-go/discovery" package discovery

2
doc.go
View File

@ -14,4 +14,4 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
package clientgo // import "k8s.io/client-go" package clientgo

View File

@ -17,4 +17,4 @@ limitations under the License.
// Package fakeclient contains examples on how to use fakeclient in tests. // Package fakeclient contains examples on how to use fakeclient in tests.
// Note: This file is here to avoid warnings on go build since there are no // Note: This file is here to avoid warnings on go build since there are no
// non-test files in this package. // non-test files in this package.
package fakeclient // import "k8s.io/client-go/examples/fake-client" package fakeclient

View File

@ -15,4 +15,4 @@ limitations under the License.
*/ */
// Package informers provides generated informers for Kubernetes APIs. // Package informers provides generated informers for Kubernetes APIs.
package informers // import "k8s.io/client-go/informers" package informers

View File

@ -16,4 +16,4 @@ limitations under the License.
// Package kubernetes holds packages which implement a clientset for Kubernetes // Package kubernetes holds packages which implement a clientset for Kubernetes
// APIs. // APIs.
package kubernetes // import "k8s.io/client-go/kubernetes" package kubernetes

View File

@ -16,4 +16,4 @@ limitations under the License.
// This file exists to enforce this clientset's vanity import path. // This file exists to enforce this clientset's vanity import path.
package kubernetes // import "k8s.io/client-go/kubernetes" package kubernetes

View File

@ -15,4 +15,4 @@ limitations under the License.
*/ */
// Package listers provides generated listers for Kubernetes APIs. // Package listers provides generated listers for Kubernetes APIs.
package listers // import "k8s.io/client-go/listers" package listers

View File

@ -17,4 +17,4 @@ limitations under the License.
// +k8s:deepcopy-gen=package // +k8s:deepcopy-gen=package
// +groupName=client.authentication.k8s.io // +groupName=client.authentication.k8s.io
package clientauthentication // import "k8s.io/client-go/pkg/apis/clientauthentication" package clientauthentication

View File

@ -21,4 +21,4 @@ limitations under the License.
// +groupName=client.authentication.k8s.io // +groupName=client.authentication.k8s.io
package v1 // import "k8s.io/client-go/pkg/apis/clientauthentication/v1" package v1

View File

@ -21,4 +21,4 @@ limitations under the License.
// +groupName=client.authentication.k8s.io // +groupName=client.authentication.k8s.io
package v1beta1 // import "k8s.io/client-go/pkg/apis/clientauthentication/v1beta1" package v1beta1

View File

@ -18,4 +18,4 @@ limitations under the License.
// Package version supplies version information collected at build time to // Package version supplies version information collected at build time to
// kubernetes components. // kubernetes components.
package version // import "k8s.io/client-go/pkg/version" package version

View File

@ -18,4 +18,4 @@ limitations under the License.
// and updating Scale for any resource which implements the `scale` subresource, // and updating Scale for any resource which implements the `scale` subresource,
// as long as that subresource operates on a version of scale convertable to // as long as that subresource operates on a version of scale convertable to
// autoscaling.Scale. // autoscaling.Scale.
package scale // import "k8s.io/client-go/scale" package scale

View File

@ -19,4 +19,4 @@ limitations under the License.
// It doesn't have any of its own types -- it's just necessary to // It doesn't have any of its own types -- it's just necessary to
// get the expected behavior out of runtime.Scheme.ConvertToVersion // get the expected behavior out of runtime.Scheme.ConvertToVersion
// and associated methods. // and associated methods.
package appsint // import "k8s.io/client-go/scale/scheme/appsint" package appsint

View File

@ -17,4 +17,4 @@ limitations under the License.
// +k8s:conversion-gen=k8s.io/client-go/scale/scheme // +k8s:conversion-gen=k8s.io/client-go/scale/scheme
// +k8s:conversion-gen-external-types=k8s.io/api/apps/v1beta1 // +k8s:conversion-gen-external-types=k8s.io/api/apps/v1beta1
package appsv1beta1 // import "k8s.io/client-go/scale/scheme/appsv1beta1" package appsv1beta1

View File

@ -17,4 +17,4 @@ limitations under the License.
// +k8s:conversion-gen=k8s.io/client-go/scale/scheme // +k8s:conversion-gen=k8s.io/client-go/scale/scheme
// +k8s:conversion-gen-external-types=k8s.io/api/apps/v1beta2 // +k8s:conversion-gen-external-types=k8s.io/api/apps/v1beta2
package appsv1beta2 // import "k8s.io/client-go/scale/scheme/appsv1beta2" package appsv1beta2

View File

@ -17,4 +17,4 @@ limitations under the License.
// +k8s:conversion-gen=k8s.io/client-go/scale/scheme // +k8s:conversion-gen=k8s.io/client-go/scale/scheme
// +k8s:conversion-gen-external-types=k8s.io/api/autoscaling/v1 // +k8s:conversion-gen-external-types=k8s.io/api/autoscaling/v1
package autoscalingv1 // import "k8s.io/client-go/scale/scheme/autoscalingv1" package autoscalingv1

View File

@ -19,4 +19,4 @@ limitations under the License.
// Package scheme contains a runtime.Scheme to be used for serializing // Package scheme contains a runtime.Scheme to be used for serializing
// and deserializing different versions of Scale, and for converting // and deserializing different versions of Scale, and for converting
// in between them. // in between them.
package scheme // import "k8s.io/client-go/scale/scheme" package scheme

View File

@ -19,4 +19,4 @@ limitations under the License.
// It doesn't have any of its own types -- it's just necessary to // It doesn't have any of its own types -- it's just necessary to
// get the expected behavior out of runtime.Scheme.ConvertToVersion // get the expected behavior out of runtime.Scheme.ConvertToVersion
// and associated methods. // and associated methods.
package extensionsint // import "k8s.io/client-go/scale/scheme/extensionsint" package extensionsint

View File

@ -17,4 +17,4 @@ limitations under the License.
// +k8s:conversion-gen=k8s.io/client-go/scale/scheme // +k8s:conversion-gen=k8s.io/client-go/scale/scheme
// +k8s:conversion-gen-external-types=k8s.io/api/extensions/v1beta1 // +k8s:conversion-gen-external-types=k8s.io/api/extensions/v1beta1
package extensionsv1beta1 // import "k8s.io/client-go/scale/scheme/extensionsv1beta1" package extensionsv1beta1

2
tools/cache/doc.go vendored
View File

@ -21,4 +21,4 @@ limitations under the License.
// list currently available nodes), and one that additionally acts as // list currently available nodes), and one that additionally acts as
// a FIFO queue (for example, to allow a scheduler to process incoming // a FIFO queue (for example, to allow a scheduler to process incoming
// pods). // pods).
package cache // import "k8s.io/client-go/tools/cache" package cache

View File

@ -16,4 +16,4 @@ limitations under the License.
// +k8s:deepcopy-gen=package // +k8s:deepcopy-gen=package
package api // import "k8s.io/client-go/tools/clientcmd/api" package api

View File

@ -18,4 +18,4 @@ limitations under the License.
// +k8s:deepcopy-gen=package // +k8s:deepcopy-gen=package
// +k8s:defaulter-gen=Kind // +k8s:defaulter-gen=Kind
package v1 // import "k8s.io/client-go/tools/clientcmd/api/v1" package v1

View File

@ -34,4 +34,4 @@ Sample usage from merged .kubeconfig files (local directory, home directory)
client, err := metav1.New(config) client, err := metav1.New(config)
// ... // ...
*/ */
package clientcmd // import "k8s.io/client-go/tools/clientcmd" package clientcmd

View File

@ -16,4 +16,4 @@ limitations under the License.
// Package events has all client logic for recording and reporting // Package events has all client logic for recording and reporting
// "k8s.io/api/events/v1".Event events. // "k8s.io/api/events/v1".Event events.
package events // import "k8s.io/client-go/tools/events" package events

View File

@ -16,4 +16,4 @@ limitations under the License.
// Package portforward adds support for SSH-like port forwarding from the client's // Package portforward adds support for SSH-like port forwarding from the client's
// local host to remote containers. // local host to remote containers.
package portforward // import "k8s.io/client-go/tools/portforward" package portforward

View File

@ -16,4 +16,4 @@ limitations under the License.
// Package record has all client logic for recording and reporting // Package record has all client logic for recording and reporting
// "k8s.io/api/core/v1".Event events. // "k8s.io/api/core/v1".Event events.
package record // import "k8s.io/client-go/tools/record" package record

View File

@ -17,4 +17,4 @@ limitations under the License.
// Package remotecommand adds support for executing commands in containers, // Package remotecommand adds support for executing commands in containers,
// with support for separate stdin, stdout, and stderr streams, as well as // with support for separate stdin, stdout, and stderr streams, as well as
// TTY. // TTY.
package remotecommand // import "k8s.io/client-go/tools/remotecommand" package remotecommand

View File

@ -17,4 +17,4 @@ limitations under the License.
// package jsonpath is a template engine using jsonpath syntax, // package jsonpath is a template engine using jsonpath syntax,
// which can be seen at http://goessner.net/articles/JsonPath/. // which can be seen at http://goessner.net/articles/JsonPath/.
// In addition, it has {range} {end} function to iterate list and slice. // In addition, it has {range} {end} function to iterate list and slice.
package jsonpath // import "k8s.io/client-go/util/jsonpath" package jsonpath

View File

@ -23,4 +23,4 @@ limitations under the License.
// - Multiple consumers and producers. In particular, it is allowed for an // - Multiple consumers and producers. In particular, it is allowed for an
// item to be reenqueued while it is being processed. // item to be reenqueued while it is being processed.
// - Shutdown notifications. // - Shutdown notifications.
package workqueue // import "k8s.io/client-go/util/workqueue" package workqueue