Fix indentation/spacing in comments to render correctly in godoc

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

@@ -97,9 +97,8 @@ 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.
+// 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) {
 	if instanceOptions == nil {
 		instanceOptions = NewDefaultTestServerOptions()

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,8 +388,7 @@ 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.
+// given the loopMode.
 type ControllerInitializersFunc func(loopMode ControllerLoopMode) (initializers map[string]InitFunc)
 
 var _ ControllerInitializersFunc = NewControllerInitializers
@@ -746,8 +746,7 @@ 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.
+// 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 {
 		initializers := make(map[string]InitFunc)

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

@@ -58,9 +58,8 @@ 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.
+// 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) {
 	stopCh := make(chan struct{})
 	var errCh chan error

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

@@ -59,9 +59,8 @@ 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.
+// 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) {
 	ctx, cancel := context.WithCancel(context.Background())
 

cmd/kubeadm/app/cmd/init.go

@@ -89,8 +89,7 @@ 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
+// the newInitOptions method, that implements all the command options validation logic
 func newCmdInit(out io.Writer, initOptions *initOptions) *cobra.Command {
 	if initOptions == nil {
 		initOptions = newInitOptions()

cmd/kubeadm/app/cmd/join.go

@@ -156,8 +156,7 @@ 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
+// the newJoinData method, that implements all the command options validation logic
 func newCmdJoin(out io.Writer, joinOptions *joinOptions) *cobra.Command {
 	if joinOptions == nil {
 		joinOptions = newJoinOptions()

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

@@ -38,15 +38,13 @@ 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)
+// 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)
+// 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,8 +160,7 @@ 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
+// information in the local kubelet config.yaml
 func getNodeNameFromKubeletConfig(fileName string) (string, error) {
 	// loads the kubelet.conf file
 	config, err := clientcmd.LoadFromFile(fileName)

pkg/apis/certificates/types.go

@@ -92,8 +92,9 @@ 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
-	//      https://tools.ietf.org/html/rfc5280#section-4.2.1.12
+	// 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
 
 	// Information about the requesting user.
@@ -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,9 +143,8 @@ 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).
+// PodControllerRefManager instance. Create a new instance if it makes
+// sense to check CanAdopt() again (e.g. in a different sync pass).
 func NewPodControllerRefManager(
 	podControl PodControlInterface,
 	controller metav1.Object,
@@ -284,9 +283,8 @@ 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).
+// ReplicaSetControllerRefManager instance. Create a new instance if it
+// makes sense to check CanAdopt() again (e.g. in a different sync pass).
 func NewReplicaSetControllerRefManager(
 	rsControl RSControlInterface,
 	controller metav1.Object,
@@ -423,9 +421,8 @@ 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).
+// ControllerRevisionControllerRefManager instance. Create a new instance if it
+// makes sense to check canAdopt() again (e.g. in a different sync pass).
 func NewControllerRevisionControllerRefManager(
 	crControl ControllerRevisionControlInterface,
 	controller metav1.Object,

pkg/controller/cronjob/utils.go

@@ -58,8 +58,7 @@ 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.
+// 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
 // the list of missed times.

pkg/controller/deployment/util/deployment_util.go

@@ -303,7 +303,7 @@ var annotationsToSkip = map[string]bool{
 // skipCopyAnnotation returns true if we should skip copying the annotation with the given annotation key
 // TODO: How to decide which annotations should / should not be copied?
 //
-//	See https://github.com/kubernetes/kubernetes/pull/20035#issuecomment-179558615
+// See https://github.com/kubernetes/kubernetes/pull/20035#issuecomment-179558615
 func skipCopyAnnotation(key string) bool {
 	return annotationsToSkip[key]
 }

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,8 +290,7 @@ 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.
+// 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
 	// has a ControllerRef pointing to this StatefulSet.

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

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

pkg/controlplane/instance.go

@@ -343,8 +343,7 @@ 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
+// KubeletClientConfig
 func (c completedConfig) New(delegationTarget genericapiserver.DelegationTarget) (*Instance, error) {
 	if reflect.DeepEqual(c.ExtraConfig.KubeletClientConfig, kubeletclient.KubeletClientConfig{}) {
 		return nil, fmt.Errorf("Master.New() called with empty config.KubeletClientConfig")

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,15 +1574,15 @@ 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
+// 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
 //
-//	be used to determine the set of actions that should be taken during
-//	this loop of syncPod
+// 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
 //
 // The workflow is:
 //   - If the pod is being created, record pod worker start latency

pkg/kubelet/lifecycle/predicate.go

@@ -185,8 +185,7 @@ 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.
+// node's OS.
 func rejectPodAdmissionBasedOnOSField(pod *v1.Pod) bool {
 	if pod.Spec.OS == nil {
 		return false

pkg/kubelet/pluginmanager/cache/types.go

@@ -36,14 +36,12 @@ 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.
+// 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
+// registers at foo.com/foo-1.9.9
 //
 // DeRegistration: When ReRegistration happens only the deletion of the new socket will trigger a DeRegister call
 type PluginHandler interface {

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)
 //
-//	(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,12 +81,10 @@ 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
+// successive executions
 //
 // podManager - the kubelet podManager that is the source of truth for the pods
-//
-//	that exist on this host
+// that exist on this host
 //
 // desiredStateOfWorld - the cache to populate
 func NewDesiredStateOfWorldPopulator(

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
+// 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
+// successive executions
 //
 // waitForAttachTimeout - the amount of time the Mount function will wait for
-//
-//	the volume to be attached
+// 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
 //
-//	adding pods to the desiredStateOfWorld cache at least once after sources
-//	are all ready (before sources are ready, pods are probably missing)
+// 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)
+// 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,