Fix indentation/spacing in comments to render correctly in godoc

cmd/kube-apiserver/app/testing/testserver.go

@@ -97,7 +97,6 @@ func NewDefaultTestServerOptions() *TestServerInstanceOptions {
 // and location of the tmpdir are returned.
 //
 // Note: we return a tear-down func instead of a stop channel because the later will leak temporary
-//
 // files that because Golang testing's call to os.Exit will not give a stop channel go routine
 // enough time to remove temporary files.
 func StartTestServer(t Logger, instanceOptions *TestServerInstanceOptions, customFlags []string, storageConfig *storagebackend.Config) (result TestServer, err error) {

cmd/kube-controller-manager/app/controllermanager.go

@@ -28,6 +28,7 @@ import (
 	"time"
 
 	"github.com/spf13/cobra"
+
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
@@ -387,7 +388,6 @@ func (c ControllerContext) IsControllerEnabled(name string) bool {
 type InitFunc func(ctx context.Context, controllerCtx ControllerContext) (controller controller.Interface, enabled bool, err error)
 
 // ControllerInitializersFunc is used to create a collection of initializers
-//
 // given the loopMode.
 type ControllerInitializersFunc func(loopMode ControllerLoopMode) (initializers map[string]InitFunc)
 
@@ -746,7 +746,6 @@ func leaderElectAndRun(c *config.CompletedConfig, lockIdentity string, electionC
 }
 
 // createInitializersFunc creates a initializersFunc that returns all initializer
-//
 // with expected as the result after filtering through filterFunc.
 func createInitializersFunc(filterFunc leadermigration.FilterFunc, expected leadermigration.FilterResult) ControllerInitializersFunc {
 	return func(loopMode ControllerLoopMode) map[string]InitFunc {

cmd/kube-controller-manager/app/testing/testserver.go

@@ -58,7 +58,6 @@ type Logger interface {
 // and location of the tmpdir are returned.
 //
 // Note: we return a tear-down func instead of a stop channel because the later will leak temporary
-//
 // files that because Golang testing's call to os.Exit will not give a stop channel go routine
 // enough time to remove temporary files.
 func StartTestServer(t Logger, customFlags []string) (result TestServer, err error) {

cmd/kube-scheduler/app/testing/testserver.go

@@ -59,7 +59,6 @@ type Logger interface {
 // and location of the tmpdir are returned.
 //
 // Note: we return a tear-down func instead of a stop channel because the later will leak temporary
-//
 // files that because Golang testing's call to os.Exit will not give a stop channel go routine
 // enough time to remove temporary files.
 func StartTestServer(t Logger, customFlags []string) (result TestServer, err error) {

cmd/kubeadm/app/cmd/init.go

@@ -89,7 +89,6 @@ type initData struct {
 
 // newCmdInit returns "kubeadm init" command.
 // NB. initOptions is exposed as parameter for allowing unit testing of
-//
 // the newInitOptions method, that implements all the command options validation logic
 func newCmdInit(out io.Writer, initOptions *initOptions) *cobra.Command {
 	if initOptions == nil {

cmd/kubeadm/app/cmd/join.go

@@ -156,7 +156,6 @@ type joinData struct {
 
 // newCmdJoin returns "kubeadm join" command.
 // NB. joinOptions is exposed as parameter for allowing unit testing of
-//
 // the newJoinData method, that implements all the command options validation logic
 func newCmdJoin(out io.Writer, joinOptions *joinOptions) *cobra.Command {
 	if joinOptions == nil {

cmd/kubeadm/app/cmd/util/join.go

@@ -38,14 +38,12 @@ var joinCommandTemplate = template.Must(template.New("join").Parse(`` +
 ))
 
 // GetJoinWorkerCommand returns the kubeadm join command for a given token and
-//
 // Kubernetes cluster (the current cluster in the kubeconfig file)
 func GetJoinWorkerCommand(kubeConfigFile, token string, skipTokenPrint bool) (string, error) {
 	return getJoinCommand(kubeConfigFile, token, "", false, skipTokenPrint, false)
 }
 
 // GetJoinControlPlaneCommand returns the kubeadm join command for a given token and
-//
 // Kubernetes cluster (the current cluster in the kubeconfig file)
 func GetJoinControlPlaneCommand(kubeConfigFile, token, key string, skipTokenPrint, skipCertificateKeyPrint bool) (string, error) {
 	return getJoinCommand(kubeConfigFile, token, key, true, skipTokenPrint, skipCertificateKeyPrint)

cmd/kubeadm/app/util/config/cluster.go

@@ -160,7 +160,6 @@ func GetNodeRegistration(kubeconfigFile string, client clientset.Interface, node
 
 // getNodeNameFromKubeletConfig gets the node name from a kubelet config file
 // TODO: in future we want to switch to a more canonical way for doing this e.g. by having this
-//
 // information in the local kubelet config.yaml
 func getNodeNameFromKubeletConfig(fileName string) (string, error) {
 	// loads the kubelet.conf file

pkg/apis/certificates/types.go

@@ -92,7 +92,8 @@ type CertificateSigningRequestSpec struct {
 
 	// usages specifies a set of usage contexts the key will be
 	// valid for.
-	// See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3
+	// See:
+	//	https://tools.ietf.org/html/rfc5280#section-4.2.1.3
 	//	https://tools.ietf.org/html/rfc5280#section-4.2.1.12
 	Usages []KeyUsage
 
@@ -192,8 +193,9 @@ type CertificateSigningRequestList struct {
 }
 
 // KeyUsages specifies valid usage contexts for keys.
-// See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3
+// See:
 //
+//	https://tools.ietf.org/html/rfc5280#section-4.2.1.3
 //	https://tools.ietf.org/html/rfc5280#section-4.2.1.12
 type KeyUsage string
 

pkg/controller/controller_ref_manager.go

@@ -143,7 +143,6 @@ type PodControllerRefManager struct {
 // If CanAdopt() returns a non-nil error, all adoptions will fail.
 //
 // NOTE: Once CanAdopt() is called, it will not be called again by the same
-//
 // PodControllerRefManager instance. Create a new instance if it makes
 // sense to check CanAdopt() again (e.g. in a different sync pass).
 func NewPodControllerRefManager(
@@ -284,7 +283,6 @@ type ReplicaSetControllerRefManager struct {
 // If CanAdopt() returns a non-nil error, all adoptions will fail.
 //
 // NOTE: Once CanAdopt() is called, it will not be called again by the same
-//
 // ReplicaSetControllerRefManager instance. Create a new instance if it
 // makes sense to check CanAdopt() again (e.g. in a different sync pass).
 func NewReplicaSetControllerRefManager(
@@ -423,7 +421,6 @@ type ControllerRevisionControllerRefManager struct {
 // If canAdopt() returns a non-nil error, all adoptions will fail.
 //
 // NOTE: Once canAdopt() is called, it will not be called again by the same
-//
 // ControllerRevisionControllerRefManager instance. Create a new instance if it
 // makes sense to check canAdopt() again (e.g. in a different sync pass).
 func NewControllerRevisionControllerRefManager(

pkg/controller/cronjob/utils.go

@@ -58,7 +58,6 @@ func deleteFromActiveList(cj *batchv1.CronJob, uid types.UID) {
 }
 
 // getNextScheduleTime gets the time of next schedule after last scheduled and before now
-//
 // it returns nil if no unmet schedule times.
 //
 // If there are too many (>100) unstarted times, it will raise a warning and but still return

pkg/controller/disruption/disruption_test.go

@@ -278,7 +278,6 @@ func updatePodOwnerToRs(t *testing.T, pod *v1.Pod, rs *apps.ReplicaSet) {
 	pod.OwnerReferences = append(pod.OwnerReferences, controllerReference)
 }
 
-// pod, podName := newPod(t, name)
 func updatePodOwnerToSs(t *testing.T, pod *v1.Pod, ss *apps.StatefulSet) {
 	var controllerReference metav1.OwnerReference
 	var trueVar = true

pkg/controller/statefulset/stateful_set.go

@@ -290,7 +290,6 @@ func (ssc *StatefulSetController) deletePod(obj interface{}) {
 // It also reconciles ControllerRef by adopting/orphaning.
 //
 // NOTE: Returned Pods are pointers to objects from the cache.
-//
 // If you need to modify one, you need to copy it first.
 func (ssc *StatefulSetController) getPodsForStatefulSet(ctx context.Context, set *apps.StatefulSet, selector labels.Selector) ([]*v1.Pod, error) {
 	// List all pods to include the pods that don't match the selector anymore but

pkg/controller/volume/attachdetach/populator/desired_state_of_world_populator.go

@@ -48,11 +48,9 @@ type DesiredStateOfWorldPopulator interface {
 
 // NewDesiredStateOfWorldPopulator returns a new instance of DesiredStateOfWorldPopulator.
 // loopSleepDuration - the amount of time the populator loop sleeps between
-//
 // successive executions
 //
 // podManager - the kubelet podManager that is the source of truth for the pods
-//
 // that exist on this host
 //
 // desiredStateOfWorld - the cache to populate

pkg/controlplane/instance.go

@@ -343,7 +343,6 @@ func (c *Config) Complete() CompletedConfig {
 // New returns a new instance of Master from the given config.
 // Certain config fields will be set to a default value if unset.
 // Certain config fields must be specified, including:
-//
 // KubeletClientConfig
 func (c completedConfig) New(delegationTarget genericapiserver.DelegationTarget) (*Instance, error) {
 	if reflect.DeepEqual(c.ExtraConfig.KubeletClientConfig, kubeletclient.KubeletClientConfig{}) {

pkg/generated/openapi/zz_generated.openapi.go

@@ -15266,7 +15266,7 @@ func schema_k8sio_api_certificates_v1beta1_CertificateSigningRequestSpec(ref com
 							},
 						},
 						SchemaProps: spec.SchemaProps{
-							Description: "allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3\n     https://tools.ietf.org/html/rfc5280#section-4.2.1.12\nValid values are:\n \"signing\",\n \"digital signature\",\n \"content commitment\",\n \"key encipherment\",\n \"key agreement\",\n \"data encipherment\",\n \"cert sign\",\n \"crl sign\",\n \"encipher only\",\n \"decipher only\",\n \"any\",\n \"server auth\",\n \"client auth\",\n \"code signing\",\n \"email protection\",\n \"s/mime\",\n \"ipsec end system\",\n \"ipsec tunnel\",\n \"ipsec user\",\n \"timestamping\",\n \"ocsp signing\",\n \"microsoft sgc\",\n \"netscape sgc\"",
+							Description: "allowedUsages specifies a set of usage contexts the key will be valid for. See:\n\thttps://tools.ietf.org/html/rfc5280#section-4.2.1.3\n\thttps://tools.ietf.org/html/rfc5280#section-4.2.1.12\n\nValid values are:\n \"signing\",\n \"digital signature\",\n \"content commitment\",\n \"key encipherment\",\n \"key agreement\",\n \"data encipherment\",\n \"cert sign\",\n \"crl sign\",\n \"encipher only\",\n \"decipher only\",\n \"any\",\n \"server auth\",\n \"client auth\",\n \"code signing\",\n \"email protection\",\n \"s/mime\",\n \"ipsec end system\",\n \"ipsec tunnel\",\n \"ipsec user\",\n \"timestamping\",\n \"ocsp signing\",\n \"microsoft sgc\",\n \"netscape sgc\"",
 							Type:        []string{"array"},
 							Items: &spec.SchemaOrArray{
 								Schema: &spec.Schema{

pkg/kubelet/kubelet.go

@@ -32,11 +32,13 @@ import (
 	"time"
 
 	"github.com/opencontainers/selinux/go-selinux"
+
 	"k8s.io/client-go/informers"
 
 	cadvisorapi "github.com/google/cadvisor/info/v1"
 	libcontaineruserns "github.com/opencontainers/runc/libcontainer/userns"
 	"go.opentelemetry.io/otel/trace"
+
 	"k8s.io/mount-utils"
 	"k8s.io/utils/integer"
 	netutils "k8s.io/utils/net"
@@ -1572,13 +1574,13 @@ func (kl *Kubelet) Run(updates <-chan kubetypes.PodUpdate) {
 // Arguments:
 //
 // updateType - whether this is a create (first time) or an update, should
-//
 // only be used for metrics since this method must be reentrant
 //
 // pod - the pod that is being set up
-// mirrorPod - the mirror pod known to the kubelet for this pod, if any
-// podStatus - the most recent pod status observed for this pod which can
 //
+// mirrorPod - the mirror pod known to the kubelet for this pod, if any
+//
+// podStatus - the most recent pod status observed for this pod which can
 // be used to determine the set of actions that should be taken during
 // this loop of syncPod
 //

pkg/kubelet/lifecycle/predicate.go

@@ -185,7 +185,6 @@ func rejectPodAdmissionBasedOnOSSelector(pod *v1.Pod, node *v1.Node) bool {
 
 // rejectPodAdmissionBasedOnOSField rejects pods if their OS field doesn't match runtime.GOOS.
 // TODO: Relax this restriction when we start supporting LCOW in kubernetes where podOS may not match
-//
 // node's OS.
 func rejectPodAdmissionBasedOnOSField(pod *v1.Pod) bool {
 	if pod.Spec.OS == nil {

pkg/kubelet/pluginmanager/cache/types.go

@@ -36,13 +36,11 @@ package cache
 //
 // The pluginwatcher module follows strictly and sequentially this state machine for each *plugin name*.
 // e.g: If you are Registering a plugin foo, you cannot get a DeRegister call for plugin foo
-//
 // until the Register("foo") call returns. Nor will you get a Validate("foo", "Different endpoint", ...)
 // call until the Register("foo") call returns.
 //
 // ReRegistration: Socket created with same plugin name, usually for a plugin update
 // e.g: plugin with name foo registers at foo.com/foo-1.9.7 later a plugin with name foo
-//
 // registers at foo.com/foo-1.9.9
 //
 // DeRegistration: When ReRegistration happens only the deletion of the new socket will trigger a DeRegister call

pkg/kubelet/pluginmanager/reconciler/reconciler.go

@@ -47,18 +47,15 @@ type Reconciler interface {
 
 // NewReconciler returns a new instance of Reconciler.
 //
-// loopSleepDuration - the amount of time the reconciler loop sleeps between
-//
-//	successive executions
-//	syncDuration - the amount of time the syncStates sleeps between
-//	successive executions
-//
 // operationExecutor - used to trigger register/unregister operations safely
-//
 // (prevents more than one operation from being triggered on the same
 // socket path)
 //
+// loopSleepDuration - the amount of time the reconciler loop sleeps between
+// successive executions
+//
 // desiredStateOfWorld - cache containing the desired state of the world
+//
 // actualStateOfWorld - cache containing the actual state of the world
 func NewReconciler(
 	operationExecutor operationexecutor.OperationExecutor,

pkg/kubelet/volumemanager/populator/desired_state_of_world_populator.go

@@ -81,11 +81,9 @@ type podStateProvider interface {
 //
 // kubeClient - used to fetch PV and PVC objects from the API server
 // loopSleepDuration - the amount of time the populator loop sleeps between
-//
 // successive executions
 //
 // podManager - the kubelet podManager that is the source of truth for the pods
-//
 // that exist on this host
 //
 // desiredStateOfWorld - the cache to populate

pkg/kubelet/volumemanager/reconciler/reconciler_common.go

@@ -60,33 +60,33 @@ type Reconciler interface {
 // NewReconciler returns a new instance of Reconciler.
 //
 // controllerAttachDetachEnabled - if true, indicates that the attach/detach
-//
 // controller is responsible for managing the attach/detach operations for
 // this node, and therefore the volume manager should not
 //
 // loopSleepDuration - the amount of time the reconciler loop sleeps between
-//
 // successive executions
 //
 // waitForAttachTimeout - the amount of time the Mount function will wait for
-//
 // the volume to be attached
 //
 // nodeName - the Name for this node, used by Attach and Detach methods
-// desiredStateOfWorld - cache containing the desired state of the world
-// actualStateOfWorld - cache containing the actual state of the world
-// populatorHasAddedPods - checker for whether the populator has finished
 //
+// desiredStateOfWorld - cache containing the desired state of the world
+//
+// actualStateOfWorld - cache containing the actual state of the world
+//
+// populatorHasAddedPods - checker for whether the populator has finished
 // adding pods to the desiredStateOfWorld cache at least once after sources
 // are all ready (before sources are ready, pods are probably missing)
 //
 // operationExecutor - used to trigger attach/detach/mount/unmount operations
-//
 // safely (prevents more than one operation from being triggered on the same
 // volume)
 //
 // mounter - mounter passed in from kubelet, passed down unmount path
+//
 // hostutil - hostutil passed in from kubelet
+//
 // volumePluginMgr - volume plugin manager passed from kubelet
 func NewReconciler(
 	kubeClient clientset.Interface,

pkg/kubelet/volumemanager/volume_manager.go

@@ -165,11 +165,9 @@ type podStateProvider interface {
 // VolumeManager interface.
 //
 // kubeClient - kubeClient is the kube API client used by DesiredStateOfWorldPopulator
-//
 // to communicate with the API server to fetch PV and PVC objects
 //
 // volumePluginMgr - the volume plugin manager used to access volume plugins.
-//
 // Must be pre-initialized.
 func NewVolumeManager(
 	controllerAttachDetachEnabled bool,

pkg/probe/http/http.go

@@ -36,7 +36,6 @@ const (
 
 // New creates Prober that will skip TLS verification while probing.
 // followNonLocalRedirects configures whether the prober should follow redirects to a different hostname.
-//
 // If disabled, redirects to other hosts will trigger a warning result.
 func New(followNonLocalRedirects bool) Prober {
 	tlsConfig := &tls.Config{InsecureSkipVerify: true}
@@ -45,7 +44,6 @@ func New(followNonLocalRedirects bool) Prober {
 
 // NewWithTLSConfig takes tls config as parameter.
 // followNonLocalRedirects configures whether the prober should follow redirects to a different hostname.
-//
 // If disabled, redirects to other hosts will trigger a warning result.
 func NewWithTLSConfig(config *tls.Config, followNonLocalRedirects bool) Prober {
 	// We do not want the probe use node's local proxy set.

pkg/proxy/service.go

@@ -429,14 +429,16 @@ func (sm *ServicePortMap) apply(changes *ServiceChangeTracker, UDPStaleClusterIP
 //   - produce a string set which stores all other ServicePortMap's ServicePortName.String().
 //
 // For example,
-//   - A{}
-//   - B{{"ns", "cluster-ip", "http"}: {"172.16.55.10", 1234, "TCP"}}
-//   - A updated to be {{"ns", "cluster-ip", "http"}: {"172.16.55.10", 1234, "TCP"}}
-//   - produce string set {"ns/cluster-ip:http"}
-//   - A{{"ns", "cluster-ip", "http"}: {"172.16.55.10", 345, "UDP"}}
-//   - B{{"ns", "cluster-ip", "http"}: {"172.16.55.10", 1234, "TCP"}}
-//   - A updated to be {{"ns", "cluster-ip", "http"}: {"172.16.55.10", 1234, "TCP"}}
-//   - produce string set {"ns/cluster-ip:http"}
+//
+//	A{}
+//	B{{"ns", "cluster-ip", "http"}: {"172.16.55.10", 1234, "TCP"}}
+//	  A updated to be {{"ns", "cluster-ip", "http"}: {"172.16.55.10", 1234, "TCP"}}
+//	  produce string set {"ns/cluster-ip:http"}
+//
+//	A{{"ns", "cluster-ip", "http"}: {"172.16.55.10", 345, "UDP"}}
+//	B{{"ns", "cluster-ip", "http"}: {"172.16.55.10", 1234, "TCP"}}
+//	  A updated to be {{"ns", "cluster-ip", "http"}: {"172.16.55.10", 1234, "TCP"}}
+//	  produce string set {"ns/cluster-ip:http"}
 func (sm *ServicePortMap) merge(other ServicePortMap) sets.String {
 	// existingPorts is going to store all identifiers of all services in `other` ServicePortMap.
 	existingPorts := sets.NewString()

pkg/scheduler/framework/plugins/interpodaffinity/filtering.go

@@ -150,8 +150,8 @@ func podMatchesAllAffinityTerms(terms []framework.AffinityTerm, pod *v1.Pod) boo
 }
 
 // calculates the following for each existing pod on each node:
-// (1) Whether it has PodAntiAffinity
-// (2) Whether any AffinityTerm matches the incoming pod
+//  1. Whether it has PodAntiAffinity
+//  2. Whether any AffinityTerm matches the incoming pod
 func (pl *InterPodAffinity) getExistingAntiAffinityCounts(ctx context.Context, pod *v1.Pod, nsLabels labels.Set, nodes []*framework.NodeInfo) topologyToMatchedTermCount {
 	topoMaps := make([]topologyToMatchedTermCount, len(nodes))
 	index := int32(-1)

plugin/pkg/auth/authorizer/node/graph.go

@@ -328,7 +328,6 @@ func (g *Graph) recomputeDestinationIndex_locked(n graph.Node) {
 // It sets up edges for the following relationships (which are immutable for a pod once bound to a node):
 //
 //	pod       -> node
-//
 //	secret    -> pod
 //	configmap -> pod
 //	pvc       -> pod

staging/src/k8s.io/api/certificates/v1/types.go

@@ -274,8 +274,9 @@ type CertificateSigningRequestList struct {
 }
 
 // KeyUsage specifies valid usage contexts for keys.
-// See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3
+// See:
 //
+//	https://tools.ietf.org/html/rfc5280#section-4.2.1.3
 //	https://tools.ietf.org/html/rfc5280#section-4.2.1.12
 //
 // +enum

staging/src/k8s.io/api/certificates/v1beta1/generated.proto

@@ -124,8 +124,10 @@ message CertificateSigningRequestSpec {
 
   // allowedUsages specifies a set of usage contexts the key will be
   // valid for.
-  // See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3
+  // See:
+  // 	https://tools.ietf.org/html/rfc5280#section-4.2.1.3
   // 	https://tools.ietf.org/html/rfc5280#section-4.2.1.12
+  //
   // Valid values are:
   //  "signing",
   //  "digital signature",

staging/src/k8s.io/api/certificates/v1beta1/types.go

@@ -89,8 +89,10 @@ type CertificateSigningRequestSpec struct {
 
 	// allowedUsages specifies a set of usage contexts the key will be
 	// valid for.
-	// See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3
+	// See:
+	//	https://tools.ietf.org/html/rfc5280#section-4.2.1.3
 	//	https://tools.ietf.org/html/rfc5280#section-4.2.1.12
+	//
 	// Valid values are:
 	//  "signing",
 	//  "digital signature",
@@ -229,8 +231,9 @@ type CertificateSigningRequestList struct {
 }
 
 // KeyUsages specifies valid usage contexts for keys.
-// See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3
+// See:
 //
+//	https://tools.ietf.org/html/rfc5280#section-4.2.1.3
 //	https://tools.ietf.org/html/rfc5280#section-4.2.1.12
 type KeyUsage string
 

staging/src/k8s.io/api/certificates/v1beta1/types_swagger_doc_generated.go

@@ -55,7 +55,7 @@ var map_CertificateSigningRequestSpec = map[string]string{
 	"request":           "Base64-encoded PKCS#10 CSR data",
 	"signerName":        "Requested signer for the request. It is a qualified name in the form: `scope-hostname.io/name`. If empty, it will be defaulted:\n 1. If it's a kubelet client certificate, it is assigned\n    \"kubernetes.io/kube-apiserver-client-kubelet\".\n 2. If it's a kubelet serving certificate, it is assigned\n    \"kubernetes.io/kubelet-serving\".\n 3. Otherwise, it is assigned \"kubernetes.io/legacy-unknown\".\nDistribution of trust for signers happens out of band. You can select on this field using `spec.signerName`.",
 	"expirationSeconds": "expirationSeconds is the requested duration of validity of the issued certificate. The certificate signer may issue a certificate with a different validity duration so a client must check the delta between the notBefore and and notAfter fields in the issued certificate to determine the actual duration.\n\nThe v1.22+ in-tree implementations of the well-known Kubernetes signers will honor this field as long as the requested duration is not greater than the maximum duration they will honor per the --cluster-signing-duration CLI flag to the Kubernetes controller manager.\n\nCertificate signers may not honor this field for various reasons:\n\n  1. Old signer that is unaware of the field (such as the in-tree\n     implementations prior to v1.22)\n  2. Signer whose configured maximum is shorter than the requested duration\n  3. Signer whose configured minimum is longer than the requested duration\n\nThe minimum valid value for expirationSeconds is 600, i.e. 10 minutes.",
-	"usages":            "allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3\n     https://tools.ietf.org/html/rfc5280#section-4.2.1.12\nValid values are:\n \"signing\",\n \"digital signature\",\n \"content commitment\",\n \"key encipherment\",\n \"key agreement\",\n \"data encipherment\",\n \"cert sign\",\n \"crl sign\",\n \"encipher only\",\n \"decipher only\",\n \"any\",\n \"server auth\",\n \"client auth\",\n \"code signing\",\n \"email protection\",\n \"s/mime\",\n \"ipsec end system\",\n \"ipsec tunnel\",\n \"ipsec user\",\n \"timestamping\",\n \"ocsp signing\",\n \"microsoft sgc\",\n \"netscape sgc\"",
+	"usages":            "allowedUsages specifies a set of usage contexts the key will be valid for. See:\n\thttps://tools.ietf.org/html/rfc5280#section-4.2.1.3\n\thttps://tools.ietf.org/html/rfc5280#section-4.2.1.12\n\nValid values are:\n \"signing\",\n \"digital signature\",\n \"content commitment\",\n \"key encipherment\",\n \"key agreement\",\n \"data encipherment\",\n \"cert sign\",\n \"crl sign\",\n \"encipher only\",\n \"decipher only\",\n \"any\",\n \"server auth\",\n \"client auth\",\n \"code signing\",\n \"email protection\",\n \"s/mime\",\n \"ipsec end system\",\n \"ipsec tunnel\",\n \"ipsec user\",\n \"timestamping\",\n \"ocsp signing\",\n \"microsoft sgc\",\n \"netscape sgc\"",
 	"username":          "Information about the requesting user. See user.Info interface for details.",
 	"uid":               "UID information about the requesting user. See user.Info interface for details.",
 	"groups":            "Group information about the requesting user. See user.Info interface for details.",

staging/src/k8s.io/api/core/v1/toleration.go

@@ -28,13 +28,11 @@ func (t *Toleration) MatchToleration(tolerationToMatch *Toleration) bool {
 
 // ToleratesTaint checks if the toleration tolerates the taint.
 // The matching follows the rules below:
-// (1) Empty toleration.effect means to match all taint effects,
 //
+//  1. Empty toleration.effect means to match all taint effects,
 //     otherwise taint effect must equal to toleration.effect.
-//
-// (2) If toleration.operator is 'Exists', it means to match all taint values.
-// (3) Empty toleration.key means to match all taint keys.
-//
+//  2. If toleration.operator is 'Exists', it means to match all taint values.
+//  3. Empty toleration.key means to match all taint keys.
 //     If toleration.key is empty, toleration.operator must be 'Exists';
 //     this combination means to match all taint values and all taint keys.
 func (t *Toleration) ToleratesTaint(taint *Taint) bool {

staging/src/k8s.io/apiextensions-apiserver/pkg/apiserver/schema/cel/compilation.go

@@ -96,7 +96,7 @@ func getBaseEnv() (*cel.Env, error) {
 // CompilationResult for each ValidationRule, or an error. declType is expected to be a CEL DeclType corresponding
 // to the structural schema.
 // Each CompilationResult may contain:
-// / - non-nil Program, nil Error: The program was compiled successfully
+//   - non-nil Program, nil Error: The program was compiled successfully
 //   - nil Program, non-nil Error: Compilation resulted in an error
 //   - nil Program, nil Error: The provided rule was empty so compilation was not attempted
 //

staging/src/k8s.io/apiextensions-apiserver/pkg/cmd/server/testing/testserver.go

@@ -69,7 +69,6 @@ func NewDefaultTestServerOptions() *TestServerInstanceOptions {
 // and location of the tmpdir are returned.
 //
 // Note: we return a tear-down func instead of a stop channel because the later will leak temporary
-//
 // files that because Golang testing's call to os.Exit will not give a stop channel go routine
 // enough time to remove temporary files.
 func StartTestServer(t Logger, _ *TestServerInstanceOptions, customFlags []string, storageConfig *storagebackend.Config) (result TestServer, err error) {

staging/src/k8s.io/apimachinery/pkg/api/meta/help.go

@@ -40,7 +40,6 @@ var (
 
 // IsListType returns true if the provided Object has a slice called Items.
 // TODO: Replace the code in this check with an interface comparison by
-//
 // creating and enforcing that lists implement a list accessor.
 func IsListType(obj runtime.Object) bool {
 	switch t := obj.(type) {

staging/src/k8s.io/apimachinery/pkg/labels/selector.go

@@ -149,14 +149,12 @@ type Requirement struct {
 
 // NewRequirement is the constructor for a Requirement.
 // If any of these rules is violated, an error is returned:
-// (1) The operator can only be In, NotIn, Equals, DoubleEquals, Gt, Lt, NotEquals, Exists, or DoesNotExist.
-// (2) If the operator is In or NotIn, the values set must be non-empty.
-// (3) If the operator is Equals, DoubleEquals, or NotEquals, the values set must contain one value.
-// (4) If the operator is Exists or DoesNotExist, the value set must be empty.
-// (5) If the operator is Gt or Lt, the values set must contain only one value, which will be interpreted as an integer.
-// (6) The key is invalid due to its length, or sequence
-//
-//	of characters. See validateLabelKey for more details.
+//  1. The operator can only be In, NotIn, Equals, DoubleEquals, Gt, Lt, NotEquals, Exists, or DoesNotExist.
+//  2. If the operator is In or NotIn, the values set must be non-empty.
+//  3. If the operator is Equals, DoubleEquals, or NotEquals, the values set must contain one value.
+//  4. If the operator is Exists or DoesNotExist, the value set must be empty.
+//  5. If the operator is Gt or Lt, the values set must contain only one value, which will be interpreted as an integer.
+//  6. The key is invalid due to its length, or sequence of characters. See validateLabelKey for more details.
 //
 // The empty string is a valid value in the input values set.
 // Returned error, if not nil, is guaranteed to be an aggregated field.ErrorList
@@ -213,21 +211,14 @@ func (r *Requirement) hasValue(value string) bool {
 
 // Matches returns true if the Requirement matches the input Labels.
 // There is a match in the following cases:
-// (1) The operator is Exists and Labels has the Requirement's key.
-// (2) The operator is In, Labels has the Requirement's key and Labels'
-//
+//  1. The operator is Exists and Labels has the Requirement's key.
+//  2. The operator is In, Labels has the Requirement's key and Labels'
 //     value for that key is in Requirement's value set.
-//
-// (3) The operator is NotIn, Labels has the Requirement's key and
-//
+//  3. The operator is NotIn, Labels has the Requirement's key and
 //     Labels' value for that key is not in Requirement's value set.
-//
-// (4) The operator is DoesNotExist or NotIn and Labels does not have the
-//
+//  4. The operator is DoesNotExist or NotIn and Labels does not have the
 //     Requirement's key.
-//
-// (5) The operator is GreaterThanOperator or LessThanOperator, and Labels has
-//
+//  5. The operator is GreaterThanOperator or LessThanOperator, and Labels has
 //     the Requirement's key and the corresponding value satisfies mathematical inequality.
 func (r *Requirement) Matches(ls Labels) bool {
 	switch r.operator {
@@ -872,15 +863,14 @@ func (p *Parser) parseExactValue() (sets.String, error) {
 //	"x in (foo,,baz),y,z notin ()"
 //
 // Note:
-//
-//	(1) Inclusion - " in " - denotes that the KEY exists and is equal to any of the
+//  1. Inclusion - " in " - denotes that the KEY exists and is equal to any of the
 //     VALUEs in its requirement
-//	(2) Exclusion - " notin " - denotes that the KEY is not equal to any
+//  2. Exclusion - " notin " - denotes that the KEY is not equal to any
 //     of the VALUEs in its requirement or does not exist
-//	(3) The empty string is a valid VALUE
-//	(4) A requirement with just a KEY - as in "y" above - denotes that
+//  3. The empty string is a valid VALUE
+//  4. A requirement with just a KEY - as in "y" above - denotes that
 //     the KEY exists and can be any VALUE.
-//	(5) A requirement with just !KEY requires that the KEY not exist.
+//  5. A requirement with just !KEY requires that the KEY not exist.
 func Parse(selector string, opts ...field.PathOption) (Selector, error) {
 	parsedSelector, err := parse(selector, field.ToPath(opts...))
 	if err == nil {

staging/src/k8s.io/apimachinery/pkg/runtime/schema/group_version.go

@@ -191,7 +191,6 @@ func (gv GroupVersion) Identifier() string {
 // if none of the options match the group. It prefers a match to group and version over just group.
 // TODO: Move GroupVersion to a package under pkg/runtime, since it's used by scheme.
 // TODO: Introduce an adapter type between GroupVersion and runtime.GroupVersioner, and use LegacyCodec(GroupVersion)
-//
 // in fewer places.
 func (gv GroupVersion) KindForGroupVersionKinds(kinds []GroupVersionKind) (target GroupVersionKind, ok bool) {
 	for _, gvk := range kinds {
@@ -240,7 +239,6 @@ func (gv GroupVersion) WithResource(resource string) GroupVersionResource {
 // GroupVersions can be used to represent a set of desired group versions.
 // TODO: Move GroupVersions to a package under pkg/runtime, since it's used by scheme.
 // TODO: Introduce an adapter type between GroupVersions and runtime.GroupVersioner, and use LegacyCodec(GroupVersion)
-//
 // in fewer places.
 type GroupVersions []GroupVersion
 

staging/src/k8s.io/apimachinery/pkg/runtime/scheme.go

@@ -118,7 +118,6 @@ func (s *Scheme) Converter() *conversion.Converter {
 // API group and version that would never be updated.
 //
 // TODO: there is discussion about removing unversioned and replacing it with objects that are manifest into
-//
 // every version with particular schemas. Resolve this method at that point.
 func (s *Scheme) AddUnversionedTypes(version schema.GroupVersion, types ...Object) {
 	s.addObservedVersion(version)

staging/src/k8s.io/apimachinery/pkg/runtime/serializer/codec_factory.go

@@ -259,7 +259,6 @@ func (f CodecFactory) SupportedMediaTypes() []runtime.SerializerInfo {
 // invoke CodecForVersions. Callers that need only to read data should use UniversalDecoder().
 //
 // TODO: make this call exist only in pkg/api, and initialize it with the set of default versions.
-//
 // All other callers will be forced to request a Codec directly.
 func (f CodecFactory) LegacyCodec(version ...schema.GroupVersion) runtime.Codec {
 	return versioning.NewDefaultingCodecForScheme(f.scheme, f.legacySerializer, f.universal, schema.GroupVersions(version), runtime.InternalGroupVersioner)

staging/src/k8s.io/apimachinery/pkg/util/mergepatch/util.go

@@ -88,7 +88,6 @@ func toYAML(v interface{}) (string, error) {
 // supports JSON merge patch semantics.
 //
 // NOTE: Numbers with different types (e.g. int(0) vs int64(0)) will be detected as conflicts.
-//
 // Make sure the unmarshaling of left and right are consistent (e.g. use the same library).
 func HasConflicts(left, right interface{}) (bool, error) {
 	switch typedLeft := left.(type) {

staging/src/k8s.io/apiserver/pkg/endpoints/discovery/aggregated/etag.go

@@ -35,7 +35,6 @@ import (
 //   - Replies with 304 Not Modified, if If-None-Match header matches hash
 //
 // hash should be the value of calculateETag on object. If hash is empty, then
-//
 // the object is simply serialized without E-Tag functionality
 func ServeHTTPWithETag(
 	object runtime.Object,

staging/src/k8s.io/apiserver/pkg/server/options/authorization.go

@@ -38,7 +38,6 @@ import (
 // DelegatingAuthorizationOptions provides an easy way for composing API servers to delegate their authorization to
 // the root kube API server.
 // WARNING: never assume that every authenticated incoming request already does authorization.
-//
 // The aggregator in the kube API server does this today, but this behaviour is not
 // guaranteed in the future.
 type DelegatingAuthorizationOptions struct {

staging/src/k8s.io/apiserver/pkg/storage/etcd3/latency_tracker.go

@@ -47,7 +47,6 @@ func NewETCDLatencyTracker(delegate clientv3.KV) clientv3.KV {
 // tracking function TrackStorageLatency is thread safe.
 //
 // NOTE: Compact is an asynchronous process and is not associated with
-//
 // any request, so we will not be tracking its latency.
 type clientV3KVLatencyTracker struct {
 	clientv3.KV

staging/src/k8s.io/apiserver/pkg/util/flowcontrol/conc_alloc.go

@@ -108,11 +108,12 @@ const epsilon = 0.0000001
 // if possible otherwise returns an error saying why it is impossible.
 // `allocs` sums to `requiredSum`.
 // For each J in [0, len(classes)):
-// (1) `classes[J].lowerBound <= allocs[J] <= classes[J].upperBound` and
-// (2) exactly one of the following is true:
-// (2a) `allocs[J] == fairProp * classes[J].target`,
-// (2b) `allocs[J] == classes[J].lowerBound && classes[J].lowerBound > fairProp * classes[J].target`, or
-// (2c) `allocs[J] == classes[J].upperBound && classes[J].upperBound < fairProp * classes[J].target`.
+//  1. `classes[J].lowerBound <= allocs[J] <= classes[J].upperBound` and
+//  2. exactly one of the following is true:
+//     2a. `allocs[J] == fairProp * classes[J].target`,
+//     2b. `allocs[J] == classes[J].lowerBound && classes[J].lowerBound > fairProp * classes[J].target`, or
+//     2c. `allocs[J] == classes[J].upperBound && classes[J].upperBound < fairProp * classes[J].target`.
+//
 // Each allocProblemItem is required to have `target >= lowerBound >= 0` and `upperBound >= lowerBound`.
 // A target smaller than MinTarget is treated as if it were MinTarget.
 func computeConcurrencyAllocation(requiredSum int, classes []allocProblemItem) ([]float64, float64, error) {

staging/src/k8s.io/apiserver/pkg/util/flowcontrol/fairqueuing/testing/eventclock/fake.go

@@ -40,7 +40,6 @@ type waitGroupCounter struct {
 }
 
 // compile time assertion that waitGroupCounter meets requirements
-//
 // of GoRoutineCounter
 var _ counter.GoRoutineCounter = (*waitGroupCounter)(nil)
 

staging/src/k8s.io/apiserver/pkg/util/flowcontrol/watch_tracker.go

@@ -195,7 +195,6 @@ func (w *watchTracker) forgetWatch(identifier *watchIdentifier, index *indexValu
 // GetInterestedWatchCount implements WatchTracker interface.
 //
 // TODO(wojtek-t): As of now, requestInfo for object creation (POST) doesn't
-//
 // contain the Name field set. Figure out if we can somehow get it for the
 // more accurate cost estimation.
 //

staging/src/k8s.io/client-go/kubernetes/typed/events/v1beta1/event_expansion.go

@@ -82,7 +82,6 @@ func (e *events) UpdateWithEventNamespace(event *v1beta1.Event) (*v1beta1.Event,
 // It returns the copy of the event that the server returns, or an error.
 // The namespace and name of the target event is deduced from the event.
 // The namespace must either match this event client's namespace, or this event client must
-//
 // have been created with the "" namespace.
 func (e *events) PatchWithEventNamespace(event *v1beta1.Event, data []byte) (*v1beta1.Event, error) {
 	if e.ns != "" && event.Namespace != e.ns {

staging/src/k8s.io/client-go/rest/client.go

@@ -52,7 +52,6 @@ type Interface interface {
 // ClientContentConfig controls how RESTClient communicates with the server.
 //
 // TODO: ContentConfig will be updated to accept a Negotiator instead of a
-//
 // NegotiatedSerializer and NegotiatedSerializer will be removed.
 type ClientContentConfig struct {
 	// AcceptContentTypes specifies the types the client will accept and is optional.

staging/src/k8s.io/client-go/tools/watch/until.go

@@ -101,7 +101,6 @@ func UntilWithoutRetry(ctx context.Context, watcher watch.Interface, conditions
 // It guarantees you to see all events and in the order they happened.
 // Due to this guarantee there is no way it can deal with 'Resource version too old error'. It will fail in this case.
 // (See `UntilWithSync` if you'd prefer to recover from all the errors including RV too old by re-listing
-//
 // those items. In normal code you should care about being level driven so you'd not care about not seeing all the edges.)
 //
 // The most frequent usage for Until would be a test where you want to verify exact order of events ("edges").

staging/src/k8s.io/client-go/util/testing/fake_openapi_handler.go

@@ -41,8 +41,8 @@ type FakeOpenAPIServer struct {
 // API server.
 //
 // specsPath - Give a path to some test data organized so that each GroupVersion
-//
 // has its own OpenAPI V3 JSON file.
+//
 //	i.e. apps/v1beta1 is stored in <specsPath>/apps/v1beta1.json
 func NewFakeOpenAPIV3Server(specsPath string) (*FakeOpenAPIServer, error) {
 	mux := &testMux{

staging/src/k8s.io/cloud-provider/app/testing/testserver.go

@@ -60,7 +60,6 @@ type Logger interface {
 // and location of the tmpdir are returned.
 //
 // Note: we return a tear-down func instead of a stop channel because the later will leak temporary
-//
 // files that because Golang testing's call to os.Exit will not give a stop channel go routine
 // enough time to remove temporary files.
 func StartTestServer(t Logger, customFlags []string) (result TestServer, err error) {

staging/src/k8s.io/code-generator/cmd/go-to-protobuf/protobuf/parser.go

@@ -109,7 +109,6 @@ func RewriteGeneratedGogoProtobufFile(name string, extractFn ExtractFunc, option
 // as being "optional" (they may be nil on the wire). This allows protobuf to serialize a map or slice and
 // properly discriminate between empty and nil (which is not possible in protobuf).
 // TODO: move into upstream gogo-protobuf once https://github.com/gogo/protobuf/issues/181
-//
 // has agreement
 func rewriteOptionalMethods(decl ast.Decl, isOptional OptionalFunc) {
 	switch t := decl.(type) {

staging/src/k8s.io/component-base/metrics/metric.go

@@ -97,7 +97,6 @@ func (r *lazyMetric) lazyInit(self kubeCollector, fqName string) {
 //  2. if the metric is manually disabled via a CLI flag.
 //
 // Disclaimer:  disabling a metric via a CLI flag has higher precedence than
-//
 // deprecation and will override show-hidden-metrics for the explicitly
 // disabled metric.
 func (r *lazyMetric) preprocessMetric(version semver.Version) {

staging/src/k8s.io/component-base/metrics/value.go

@@ -60,7 +60,6 @@ func NewConstMetric(desc *Desc, valueType ValueType, value float64, labelValues
 // NewLazyMetricWithTimestamp is a helper of NewMetricWithTimestamp.
 //
 // Warning: the Metric 'm' must be the one created by NewLazyConstMetric(),
-//
 // otherwise, no stability guarantees would be offered.
 func NewLazyMetricWithTimestamp(t time.Time, m Metric) Metric {
 	if m == nil {

staging/src/k8s.io/controller-manager/pkg/leadermigration/config/default.go

@@ -19,7 +19,6 @@ package config
 import internal "k8s.io/controller-manager/config"
 
 // DefaultLeaderMigrationConfiguration returns the default LeaderMigrationConfiguration
-//
 // that is valid for this release of Kubernetes.
 func DefaultLeaderMigrationConfiguration() *internal.LeaderMigrationConfiguration {
 	return &internal.LeaderMigrationConfiguration{

staging/src/k8s.io/controller-manager/pkg/leadermigration/migrator.go

@@ -31,7 +31,6 @@ type LeaderMigrator struct {
 }
 
 // NewLeaderMigrator creates a LeaderMigrator with given config for the given component. component
-//
 // indicates which controller manager is requesting this leader migration, and it should be consistent
 // with the component field of ControllerLeaderConfiguration.
 func NewLeaderMigrator(config *internal.LeaderMigrationConfiguration, component string) *LeaderMigrator {

staging/src/k8s.io/legacy-cloud-providers/aws/aws.go

@@ -175,7 +175,6 @@ const ServiceAnnotationLoadBalancerSSLNegotiationPolicy = "service.beta.kubernet
 // ServiceAnnotationLoadBalancerBEProtocol is the annotation used on the service
 // to specify the protocol spoken by the backend (pod) behind a listener.
 // If `http` (default) or `https`, an HTTPS listener that terminates the
-//
 // connection and parses headers is created.
 //
 // If set to `ssl` or `tcp`, a "raw" SSL listener is used.

staging/src/k8s.io/legacy-cloud-providers/aws/aws_loadbalancer.go

@@ -1244,7 +1244,6 @@ func (c *Cloud) ensureLoadBalancer(namespacedName types.NamespacedName, loadBala
 
 // syncElbListeners computes a plan to reconcile the desired vs actual state of the listeners on an ELB
 // NOTE: there exists an O(nlgn) implementation for this function. However, as the default limit of
-//
 // listeners per elb is 100, this implementation is reduced from O(m*n) => O(n).
 func syncElbListeners(loadBalancerName string, listeners []*elb.Listener, listenerDescriptions []*elb.ListenerDescription) ([]*elb.Listener, []*int64) {
 	foundSet := make(map[int]bool)