From 1d637ff29e8fefca4160f7458b260571d10b4c74 Mon Sep 17 00:00:00 2001 From: Tim Hockin Date: Thu, 12 Jan 2023 09:51:33 -0800 Subject: [PATCH] Don't generate clientset/doc.go in client-gen It seems valuable to be able to provide hand-written docs for these first-level directories, and if don't want them, the generated doc.go files are not actually very helpful. This commit also adds new doc.go files for client-go listers/ and informers/. Kubernetes-commit: 95bf7b0afe9dd6a0f00125b1d290514a23e778e2 --- informers/doc.go | 18 ++++++++++++++++++ kubernetes/doc.go | 7 +++---- listers/doc.go | 18 ++++++++++++++++++ 3 files changed, 39 insertions(+), 4 deletions(-) create mode 100644 informers/doc.go create mode 100644 listers/doc.go diff --git a/informers/doc.go b/informers/doc.go new file mode 100644 index 00000000..231bffb6 --- /dev/null +++ b/informers/doc.go @@ -0,0 +1,18 @@ +/* +Copyright 2023 The Kubernetes Authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package informers provides generated informers for Kubernetes APIs. +package informers diff --git a/kubernetes/doc.go b/kubernetes/doc.go index b272334a..9cef4242 100644 --- a/kubernetes/doc.go +++ b/kubernetes/doc.go @@ -1,5 +1,5 @@ /* -Copyright The Kubernetes Authors. +Copyright 2023 The Kubernetes Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -14,7 +14,6 @@ See the License for the specific language governing permissions and limitations under the License. */ -// Code generated by client-gen. DO NOT EDIT. - -// This package has the automatically generated clientset. +// Package kubernetes holds packages which implement a clientset for Kubernetes +// APIs. package kubernetes diff --git a/listers/doc.go b/listers/doc.go new file mode 100644 index 00000000..da6a8040 --- /dev/null +++ b/listers/doc.go @@ -0,0 +1,18 @@ +/* +Copyright 2023 The Kubernetes Authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Package listers provides generated listers for Kubernetes APIs. +package listers