Skip to content

Commit 70a4950

Browse files
pohlyk8s-publishing-bot
authored andcommitted
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
1 parent 706280d commit 70a4950

File tree

30 files changed

+30
-30
lines changed

30 files changed

+30
-30
lines changed

applyconfigurations/doc.go

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

discovery/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ limitations under the License.
1616

1717
// Package discovery provides ways to discover server-supported
1818
// API groups, versions and resources.
19-
package discovery // import "k8s.io/client-go/discovery"
19+
package discovery

doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ See the License for the specific language governing permissions and
1414
limitations under the License.
1515
*/
1616

17-
package clientgo // import "k8s.io/client-go"
17+
package clientgo

examples/fake-client/doc.go

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

informers/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ limitations under the License.
1515
*/
1616

1717
// Package informers provides generated informers for Kubernetes APIs.
18-
package informers // import "k8s.io/client-go/informers"
18+
package informers

kubernetes/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ limitations under the License.
1616

1717
// Package kubernetes holds packages which implement a clientset for Kubernetes
1818
// APIs.
19-
package kubernetes // import "k8s.io/client-go/kubernetes"
19+
package kubernetes

kubernetes/import.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ limitations under the License.
1616

1717
// This file exists to enforce this clientset's vanity import path.
1818

19-
package kubernetes // import "k8s.io/client-go/kubernetes"
19+
package kubernetes

listers/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ limitations under the License.
1515
*/
1616

1717
// Package listers provides generated listers for Kubernetes APIs.
18-
package listers // import "k8s.io/client-go/listers"
18+
package listers

pkg/apis/clientauthentication/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ limitations under the License.
1717
// +k8s:deepcopy-gen=package
1818
// +groupName=client.authentication.k8s.io
1919

20-
package clientauthentication // import "k8s.io/client-go/pkg/apis/clientauthentication"
20+
package clientauthentication

pkg/apis/clientauthentication/v1/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ limitations under the License.
2121

2222
// +groupName=client.authentication.k8s.io
2323

24-
package v1 // import "k8s.io/client-go/pkg/apis/clientauthentication/v1"
24+
package v1

pkg/apis/clientauthentication/v1beta1/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ limitations under the License.
2121

2222
// +groupName=client.authentication.k8s.io
2323

24-
package v1beta1 // import "k8s.io/client-go/pkg/apis/clientauthentication/v1beta1"
24+
package v1beta1

pkg/version/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ limitations under the License.
1818

1919
// Package version supplies version information collected at build time to
2020
// kubernetes components.
21-
package version // import "k8s.io/client-go/pkg/version"
21+
package version

scale/doc.go

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

scale/scheme/appsint/doc.go

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

scale/scheme/appsv1beta1/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ limitations under the License.
1717
// +k8s:conversion-gen=k8s.io/client-go/scale/scheme
1818
// +k8s:conversion-gen-external-types=k8s.io/api/apps/v1beta1
1919

20-
package appsv1beta1 // import "k8s.io/client-go/scale/scheme/appsv1beta1"
20+
package appsv1beta1

scale/scheme/appsv1beta2/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ limitations under the License.
1717
// +k8s:conversion-gen=k8s.io/client-go/scale/scheme
1818
// +k8s:conversion-gen-external-types=k8s.io/api/apps/v1beta2
1919

20-
package appsv1beta2 // import "k8s.io/client-go/scale/scheme/appsv1beta2"
20+
package appsv1beta2

scale/scheme/autoscalingv1/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ limitations under the License.
1717
// +k8s:conversion-gen=k8s.io/client-go/scale/scheme
1818
// +k8s:conversion-gen-external-types=k8s.io/api/autoscaling/v1
1919

20-
package autoscalingv1 // import "k8s.io/client-go/scale/scheme/autoscalingv1"
20+
package autoscalingv1

scale/scheme/doc.go

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

scale/scheme/extensionsint/doc.go

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

scale/scheme/extensionsv1beta1/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ limitations under the License.
1717
// +k8s:conversion-gen=k8s.io/client-go/scale/scheme
1818
// +k8s:conversion-gen-external-types=k8s.io/api/extensions/v1beta1
1919

20-
package extensionsv1beta1 // import "k8s.io/client-go/scale/scheme/extensionsv1beta1"
20+
package extensionsv1beta1

tools/cache/doc.go

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

tools/clientcmd/api/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ limitations under the License.
1616

1717
// +k8s:deepcopy-gen=package
1818

19-
package api // import "k8s.io/client-go/tools/clientcmd/api"
19+
package api

tools/clientcmd/api/v1/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ limitations under the License.
1818
// +k8s:deepcopy-gen=package
1919
// +k8s:defaulter-gen=Kind
2020

21-
package v1 // import "k8s.io/client-go/tools/clientcmd/api/v1"
21+
package v1

tools/clientcmd/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ Sample usage from merged .kubeconfig files (local directory, home directory)
3434
client, err := metav1.New(config)
3535
// ...
3636
*/
37-
package clientcmd // import "k8s.io/client-go/tools/clientcmd"
37+
package clientcmd

tools/events/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ limitations under the License.
1616

1717
// Package events has all client logic for recording and reporting
1818
// "k8s.io/api/events/v1".Event events.
19-
package events // import "k8s.io/client-go/tools/events"
19+
package events

tools/portforward/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ limitations under the License.
1616

1717
// Package portforward adds support for SSH-like port forwarding from the client's
1818
// local host to remote containers.
19-
package portforward // import "k8s.io/client-go/tools/portforward"
19+
package portforward

tools/record/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ limitations under the License.
1616

1717
// Package record has all client logic for recording and reporting
1818
// "k8s.io/api/core/v1".Event events.
19-
package record // import "k8s.io/client-go/tools/record"
19+
package record

tools/remotecommand/doc.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ limitations under the License.
1717
// Package remotecommand adds support for executing commands in containers,
1818
// with support for separate stdin, stdout, and stderr streams, as well as
1919
// TTY.
20-
package remotecommand // import "k8s.io/client-go/tools/remotecommand"
20+
package remotecommand

util/jsonpath/doc.go

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

util/workqueue/doc.go

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

0 commit comments

Comments
 (0)