adaptation/builtin: add comment for exported symbols

marquiz · marquiz · commit c0ba9da71293 · 2025-08-29T13:34:22.000+03:00
Signed-off-by: Markus Lehtonen &lt;markus.lehtonen@intel.com&gt;
diff --git a/pkg/adaptation/builtin/plugin.go b/pkg/adaptation/builtin/plugin.go
@@ -22,12 +22,15 @@ import (
 	"github.com/containerd/nri/pkg/api"
 )
 
+// BuiltinPlugin implements the NRI API and runs in-process
+// within the container runtime.
 type BuiltinPlugin struct {
 	Base     string
 	Index    string
 	Handlers BuiltinHandlers
 }
 
+// BuiltinHandlers contains request handlers for the builtin plugin.
 type BuiltinHandlers struct {
 	Configure            func(context.Context, *api.ConfigureRequest) (*api.ConfigureResponse, error)
 	Synchronize          func(context.Context, *api.SynchronizeRequest) (*api.SynchronizeResponse, error)
@@ -48,6 +51,7 @@ type BuiltinHandlers struct {
 	ValidateContainerAdjustment func(context.Context, *api.ValidateContainerAdjustmentRequest) error
 }
 
+// Configure implements PluginService of the NRI API.
 func (b *BuiltinPlugin) Configure(ctx context.Context, req *api.ConfigureRequest) (*api.ConfigureResponse, error) {
 	var (
 		rpl = &api.ConfigureResponse{}
@@ -110,38 +114,44 @@ func (b *BuiltinPlugin) Configure(ctx context.Context, req *api.ConfigureRequest
 	return rpl, err
 }
 
+// Synchronize implements PluginService of the NRI API.
 func (b *BuiltinPlugin) Synchronize(ctx context.Context, req *api.SynchronizeRequest) (*api.SynchronizeResponse, error) {
 	if b.Handlers.Synchronize != nil {
 		return b.Handlers.Synchronize(ctx, req)
 	}
 	return &api.SynchronizeResponse{}, nil
 }
 
+// Shutdown implements PluginService of the NRI API.
 func (b *BuiltinPlugin) Shutdown(context.Context, *api.ShutdownRequest) (*api.ShutdownResponse, error) {
 	return &api.ShutdownResponse{}, nil
 }
 
+// CreateContainer implements PluginService of the NRI API.
 func (b *BuiltinPlugin) CreateContainer(ctx context.Context, req *api.CreateContainerRequest) (*api.CreateContainerResponse, error) {
 	if b.Handlers.CreateContainer != nil {
 		return b.Handlers.CreateContainer(ctx, req)
 	}
 	return &api.CreateContainerResponse{}, nil
 }
 
+// UpdateContainer implements PluginService of the NRI API.
 func (b *BuiltinPlugin) UpdateContainer(ctx context.Context, req *api.UpdateContainerRequest) (*api.UpdateContainerResponse, error) {
 	if b.Handlers.UpdateContainer != nil {
 		return b.Handlers.UpdateContainer(ctx, req)
 	}
 	return &api.UpdateContainerResponse{}, nil
 }
 
+// StopContainer implements PluginService of the NRI API.
 func (b *BuiltinPlugin) StopContainer(ctx context.Context, req *api.StopContainerRequest) (*api.StopContainerResponse, error) {
 	if b.Handlers.StopContainer != nil {
 		return b.Handlers.StopContainer(ctx, req)
 	}
 	return &api.StopContainerResponse{}, nil
 }
 
+// StateChange implements PluginService of the NRI API.
 func (b *BuiltinPlugin) StateChange(ctx context.Context, evt *api.StateChangeEvent) (*api.StateChangeResponse, error) {
 	var err error
 	switch evt.Event {
@@ -182,20 +192,23 @@ func (b *BuiltinPlugin) StateChange(ctx context.Context, evt *api.StateChangeEve
 	return &api.StateChangeResponse{}, err
 }
 
+// UpdatePodSandbox implements PluginService of the NRI API.
 func (b *BuiltinPlugin) UpdatePodSandbox(ctx context.Context, req *api.UpdatePodSandboxRequest) (*api.UpdatePodSandboxResponse, error) {
 	if b.Handlers.UpdatePodSandbox != nil {
 		return b.Handlers.UpdatePodSandbox(ctx, req)
 	}
 	return &api.UpdatePodSandboxResponse{}, nil
 }
 
+// PostUpdatePodSandbox is a handler for the PostUpdatePodSandbox event.
 func (b *BuiltinPlugin) PostUpdatePodSandbox(ctx context.Context, req *api.PostUpdatePodSandboxRequest) error {
 	if b.Handlers.PostUpdatePodSandbox != nil {
 		return b.Handlers.PostUpdatePodSandbox(ctx, req)
 	}
 	return nil
 }
 
+// ValidateContainerAdjustment implements PluginService of the NRI API.
 func (b *BuiltinPlugin) ValidateContainerAdjustment(ctx context.Context, req *api.ValidateContainerAdjustmentRequest) (*api.ValidateContainerAdjustmentResponse, error) {
 	if b.Handlers.ValidateContainerAdjustment != nil {
 		if err := b.Handlers.ValidateContainerAdjustment(ctx, req); err != nil {

Original file line number	Diff line number	Diff line change
`@@ -22,12 +22,15 @@ import (`
`22`	`22`	`"github.com/containerd/nri/pkg/api"`
`23`	`23`	`)`
`24`	`24`
	`25`	`+// BuiltinPlugin implements the NRI API and runs in-process`
	`26`	`+// within the container runtime.`
`25`	`27`	`type BuiltinPlugin struct {`
`26`	`28`	`Base string`
`27`	`29`	`Index string`
`28`	`30`	`Handlers BuiltinHandlers`
`29`	`31`	`}`
`30`	`32`
	`33`	`+// BuiltinHandlers contains request handlers for the builtin plugin.`
`31`	`34`	`type BuiltinHandlers struct {`
`32`	`35`	`Configure func(context.Context, api.ConfigureRequest) (api.ConfigureResponse, error)`
`33`	`36`	`Synchronize func(context.Context, api.SynchronizeRequest) (api.SynchronizeResponse, error)`
`@@ -48,6 +51,7 @@ type BuiltinHandlers struct {`
`48`	`51`	`ValidateContainerAdjustment func(context.Context, *api.ValidateContainerAdjustmentRequest) error`
`49`	`52`	`}`
`50`	`53`
	`54`	`+// Configure implements PluginService of the NRI API.`
`51`	`55`	`func (b BuiltinPlugin) Configure(ctx context.Context, req api.ConfigureRequest) (*api.ConfigureResponse, error) {`
`52`	`56`	`var (`
`53`	`57`	`rpl = &api.ConfigureResponse{}`
`@@ -110,38 +114,44 @@ func (b BuiltinPlugin) Configure(ctx context.Context, req api.ConfigureRequest`
`110`	`114`	`return rpl, err`
`111`	`115`	`}`
`112`	`116`
	`117`	`+// Synchronize implements PluginService of the NRI API.`
`113`	`118`	`func (b BuiltinPlugin) Synchronize(ctx context.Context, req api.SynchronizeRequest) (*api.SynchronizeResponse, error) {`
`114`	`119`	`if b.Handlers.Synchronize != nil {`
`115`	`120`	`return b.Handlers.Synchronize(ctx, req)`
`116`	`121`	`}`
`117`	`122`	`return &api.SynchronizeResponse{}, nil`
`118`	`123`	`}`
`119`	`124`
	`125`	`+// Shutdown implements PluginService of the NRI API.`
`120`	`126`	`func (b BuiltinPlugin) Shutdown(context.Context, api.ShutdownRequest) (*api.ShutdownResponse, error) {`
`121`	`127`	`return &api.ShutdownResponse{}, nil`
`122`	`128`	`}`
`123`	`129`
	`130`	`+// CreateContainer implements PluginService of the NRI API.`
`124`	`131`	`func (b BuiltinPlugin) CreateContainer(ctx context.Context, req api.CreateContainerRequest) (*api.CreateContainerResponse, error) {`
`125`	`132`	`if b.Handlers.CreateContainer != nil {`
`126`	`133`	`return b.Handlers.CreateContainer(ctx, req)`
`127`	`134`	`}`
`128`	`135`	`return &api.CreateContainerResponse{}, nil`
`129`	`136`	`}`
`130`	`137`
	`138`	`+// UpdateContainer implements PluginService of the NRI API.`
`131`	`139`	`func (b BuiltinPlugin) UpdateContainer(ctx context.Context, req api.UpdateContainerRequest) (*api.UpdateContainerResponse, error) {`
`132`	`140`	`if b.Handlers.UpdateContainer != nil {`
`133`	`141`	`return b.Handlers.UpdateContainer(ctx, req)`
`134`	`142`	`}`
`135`	`143`	`return &api.UpdateContainerResponse{}, nil`
`136`	`144`	`}`
`137`	`145`
	`146`	`+// StopContainer implements PluginService of the NRI API.`
`138`	`147`	`func (b BuiltinPlugin) StopContainer(ctx context.Context, req api.StopContainerRequest) (*api.StopContainerResponse, error) {`
`139`	`148`	`if b.Handlers.StopContainer != nil {`
`140`	`149`	`return b.Handlers.StopContainer(ctx, req)`
`141`	`150`	`}`
`142`	`151`	`return &api.StopContainerResponse{}, nil`
`143`	`152`	`}`
`144`	`153`
	`154`	`+// StateChange implements PluginService of the NRI API.`
`145`	`155`	`func (b BuiltinPlugin) StateChange(ctx context.Context, evt api.StateChangeEvent) (*api.StateChangeResponse, error) {`
`146`	`156`	`var err error`
`147`	`157`	`switch evt.Event {`
`@@ -182,20 +192,23 @@ func (b BuiltinPlugin) StateChange(ctx context.Context, evt api.StateChangeEve`
`182`	`192`	`return &api.StateChangeResponse{}, err`
`183`	`193`	`}`
`184`	`194`
	`195`	`+// UpdatePodSandbox implements PluginService of the NRI API.`
`185`	`196`	`func (b BuiltinPlugin) UpdatePodSandbox(ctx context.Context, req api.UpdatePodSandboxRequest) (*api.UpdatePodSandboxResponse, error) {`
`186`	`197`	`if b.Handlers.UpdatePodSandbox != nil {`
`187`	`198`	`return b.Handlers.UpdatePodSandbox(ctx, req)`
`188`	`199`	`}`
`189`	`200`	`return &api.UpdatePodSandboxResponse{}, nil`
`190`	`201`	`}`
`191`	`202`
	`203`	`+// PostUpdatePodSandbox is a handler for the PostUpdatePodSandbox event.`
`192`	`204`	`func (b BuiltinPlugin) PostUpdatePodSandbox(ctx context.Context, req api.PostUpdatePodSandboxRequest) error {`
`193`	`205`	`if b.Handlers.PostUpdatePodSandbox != nil {`
`194`	`206`	`return b.Handlers.PostUpdatePodSandbox(ctx, req)`
`195`	`207`	`}`
`196`	`208`	`return nil`
`197`	`209`	`}`
`198`	`210`
	`211`	`+// ValidateContainerAdjustment implements PluginService of the NRI API.`
`199`	`212`	`func (b BuiltinPlugin) ValidateContainerAdjustment(ctx context.Context, req api.ValidateContainerAdjustmentRequest) (*api.ValidateContainerAdjustmentResponse, error) {`
`200`	`213`	`if b.Handlers.ValidateContainerAdjustment != nil {`
`201`	`214`	`if err := b.Handlers.ValidateContainerAdjustment(ctx, req); err != nil {`