Add and fix comments for exported types

marquiz · marquiz · commit 00fa1a124e60 · 2025-08-29T13:34:22.000+03:00
Mixed bag of comments for exported types. Makes revive happier.

Signed-off-by: Markus Lehtonen &lt;markus.lehtonen@intel.com&gt;
diff --git a/pkg/adaptation/adaptation.go b/pkg/adaptation/adaptation.go
@@ -43,7 +43,7 @@ const (
 	DefaultPluginPath = "/opt/nri/plugins"
 	// DefaultSocketPath is the default socket path for external plugins.
 	DefaultSocketPath = api.DefaultSocketPath
-	// PluginConfigDir is the drop-in directory for NRI-launched plugin configuration.
+	// DefaultPluginConfigPath is the drop-in directory for NRI-launched plugin configuration.
 	DefaultPluginConfigPath = "/etc/nri/conf.d"
 )
 
@@ -711,6 +711,7 @@ func (r *Adaptation) finishedPluginSync() {
 	r.syncLock.Unlock()
 }
 
+// PluginSyncBlock is a handle for blocking plugin synchronization.
 type PluginSyncBlock struct {
 	r *Adaptation
 }
diff --git a/pkg/api/adjustment.go b/pkg/api/adjustment.go
@@ -116,6 +116,7 @@ func (a *ContainerAdjustment) AddHooks(h *Hooks) {
 	}
 }
 
+// AddRlimit records the addition of rlimit (POSIX resource limits) to a container.
 func (a *ContainerAdjustment) AddRlimit(typ string, hard, soft uint64) {
 	a.initRlimits()
 	a.Rlimits = append(a.Rlimits, &POSIXRlimit{
diff --git a/pkg/api/container.go b/pkg/api/container.go
@@ -18,6 +18,7 @@ package api
 
 import "time"
 
+// GetCreatedAtTime returns the time the container was created at as time.Time.
 func (x *Container) GetCreatedAtTime() time.Time {
 	t := time.Time{}
 	if x != nil {
@@ -26,6 +27,7 @@ func (x *Container) GetCreatedAtTime() time.Time {
 	return t
 }
 
+// GetStartedAtTime returns the time the container was started at as time.Time.
 func (x *Container) GetStartedAtTime() time.Time {
 	t := time.Time{}
 	if x != nil {
@@ -34,6 +36,7 @@ func (x *Container) GetStartedAtTime() time.Time {
 	return t
 }
 
+// GetFinishedAtTime returns the time the container was finished at as time.Time.
 func (x *Container) GetFinishedAtTime() time.Time {
 	t := time.Time{}
 	if x != nil {
diff --git a/pkg/api/ioprio.go b/pkg/api/ioprio.go
@@ -47,7 +47,7 @@ func (ioprio *LinuxIOPriority) ToOCI() *rspec.LinuxIOPriority {
 	}
 }
 
-// FromOCIIOPrioClass returns the IOPrioClass corresponding the the given
+// FromOCIIOPriorityClass returns the IOPrioClass corresponding the the given
 // OCI IOPriorityClass.
 func FromOCIIOPriorityClass(o rspec.IOPriorityClass) IOPrioClass {
 	return IOPrioClass(IOPrioClass_value[string(o)])
diff --git a/pkg/runtime-tools/generate/generate.go b/pkg/runtime-tools/generate/generate.go
@@ -445,6 +445,7 @@ func (g *Generator) InjectCDIDevices(devices []*nri.CDIDevice) error {
 	return g.injectCDIDevices(g.Config, names)
 }
 
+// AdjustRlimits adjusts the (Linux) POSIX resource limits in the OCI Spec.
 func (g *Generator) AdjustRlimits(rlimits []*nri.POSIXRlimit) error {
 	for _, l := range rlimits {
 		if l == nil {
@@ -601,6 +602,7 @@ func (g *Generator) SetLinuxResourcesBlockIO(blockIO *rspec.LinuxBlockIO) {
 	g.Config.Linux.Resources.BlockIO = blockIO
 }
 
+// SetProcessIOPriority sets the (Linux) IO priority of the container.
 func (g *Generator) SetProcessIOPriority(ioprio *rspec.LinuxIOPriority) {
 	g.initConfigProcess()
 	if ioprio != nil && ioprio.Class == "" {
diff --git a/plugins/default-validator/builtin/plugin.go b/plugins/default-validator/builtin/plugin.go
@@ -26,6 +26,7 @@ import (
 )
 
 type (
+	// DefaultValidatorConfig is an alias for DefaultValidatorConfig from main package.
 	DefaultValidatorConfig = validator.DefaultValidatorConfig
 )
 
diff --git a/plugins/default-validator/default-validator.go b/plugins/default-validator/default-validator.go
@@ -30,6 +30,7 @@ import (
 	yaml "gopkg.in/yaml.v3"
 )
 
+// DefaultValidatorConfig is the configuration for the default validator plugin.
 type DefaultValidatorConfig struct {
 	// Enable the default validator plugin.
 	Enable bool `yaml:"enable" toml:"enable"`

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ const (`
`43`	`43`	`DefaultPluginPath = "/opt/nri/plugins"`
`44`	`44`	`// DefaultSocketPath is the default socket path for external plugins.`
`45`	`45`	`DefaultSocketPath = api.DefaultSocketPath`
`46`		`- // PluginConfigDir is the drop-in directory for NRI-launched plugin configuration.`
	`46`	`+ // DefaultPluginConfigPath is the drop-in directory for NRI-launched plugin configuration.`
`47`	`47`	`DefaultPluginConfigPath = "/etc/nri/conf.d"`
`48`	`48`	`)`
`49`	`49`
`@@ -711,6 +711,7 @@ func (r *Adaptation) finishedPluginSync() {`
`711`	`711`	`r.syncLock.Unlock()`
`712`	`712`	`}`
`713`	`713`
	`714`	`+// PluginSyncBlock is a handle for blocking plugin synchronization.`
`714`	`715`	`type PluginSyncBlock struct {`
`715`	`716`	`r *Adaptation`
`716`	`717`	`}`
Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,7 @@ func (a ContainerAdjustment) AddHooks(h Hooks) {`
`116`	`116`	`}`
`117`	`117`	`}`
`118`	`118`
	`119`	`+// AddRlimit records the addition of rlimit (POSIX resource limits) to a container.`
`119`	`120`	`func (a *ContainerAdjustment) AddRlimit(typ string, hard, soft uint64) {`
`120`	`121`	`a.initRlimits()`
`121`	`122`	`a.Rlimits = append(a.Rlimits, &POSIXRlimit{`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ func (ioprio LinuxIOPriority) ToOCI() rspec.LinuxIOPriority {`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`
`50`		`-// FromOCIIOPrioClass returns the IOPrioClass corresponding the the given`
	`50`	`+// FromOCIIOPriorityClass returns the IOPrioClass corresponding the the given`
`51`	`51`	`// OCI IOPriorityClass.`
`52`	`52`	`func FromOCIIOPriorityClass(o rspec.IOPriorityClass) IOPrioClass {`
`53`	`53`	`return IOPrioClass(IOPrioClass_value[string(o)])`
Original file line number	Diff line number	Diff line change
`@@ -445,6 +445,7 @@ func (g Generator) InjectCDIDevices(devices []nri.CDIDevice) error {`
`445`	`445`	`return g.injectCDIDevices(g.Config, names)`
`446`	`446`	`}`
`447`	`447`
	`448`	`+// AdjustRlimits adjusts the (Linux) POSIX resource limits in the OCI Spec.`
`448`	`449`	`func (g Generator) AdjustRlimits(rlimits []nri.POSIXRlimit) error {`
`449`	`450`	`for _, l := range rlimits {`
`450`	`451`	`if l == nil {`
`@@ -601,6 +602,7 @@ func (g Generator) SetLinuxResourcesBlockIO(blockIO rspec.LinuxBlockIO) {`
`601`	`602`	`g.Config.Linux.Resources.BlockIO = blockIO`
`602`	`603`	`}`
`603`	`604`
	`605`	`+// SetProcessIOPriority sets the (Linux) IO priority of the container.`
`604`	`606`	`func (g Generator) SetProcessIOPriority(ioprio rspec.LinuxIOPriority) {`
`605`	`607`	`g.initConfigProcess()`
`606`	`608`	`if ioprio != nil && ioprio.Class == "" {`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ import (`
`26`	`26`	`)`
`27`	`27`
`28`	`28`	`type (`
	`29`	`+ // DefaultValidatorConfig is an alias for DefaultValidatorConfig from main package.`
`29`	`30`	`DefaultValidatorConfig = validator.DefaultValidatorConfig`
`30`	`31`	`)`
`31`	`32`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ import (`
`30`	`30`	`yaml "gopkg.in/yaml.v3"`
`31`	`31`	`)`
`32`	`32`
	`33`	`+// DefaultValidatorConfig is the configuration for the default validator plugin.`
`33`	`34`	`type DefaultValidatorConfig struct {`
`34`	`35`	`// Enable the default validator plugin.`
`35`	`36`	Enable bool `yaml:"enable" toml:"enable"`