pkg/api/seccomp: add comments for exported functions

marquiz · marquiz · commit ac21da7be8f9 · 2025-08-29T13:34:22.000+03:00
Signed-off-by: Markus Lehtonen &lt;markus.lehtonen@intel.com&gt;
diff --git a/pkg/api/seccomp.go b/pkg/api/seccomp.go
@@ -20,6 +20,7 @@ import (
 	rspec "github.com/opencontainers/runtime-spec/specs-go"
 )
 
+// FromOCILinuxSeccomp converts an seccomp configuration from an OCI runtime spec.
 func FromOCILinuxSeccomp(o *rspec.LinuxSeccomp) *LinuxSeccomp {
 	var errno *OptionalUInt32
 	if o.DefaultErrnoRet != nil {
@@ -47,6 +48,7 @@ func FromOCILinuxSeccomp(o *rspec.LinuxSeccomp) *LinuxSeccomp {
 	}
 }
 
+// FromOCILinuxSyscalls converts seccomp syscalls configuration from an OCI runtime spec.
 func FromOCILinuxSyscalls(o []rspec.LinuxSyscall) []*LinuxSyscall {
 	syscalls := make([]*LinuxSyscall, len(o))
 
@@ -67,6 +69,7 @@ func FromOCILinuxSyscalls(o []rspec.LinuxSyscall) []*LinuxSyscall {
 	return syscalls
 }
 
+// FromOCILinuxSeccompArgs converts seccomp syscall args from an OCI runtime spec.
 func FromOCILinuxSeccompArgs(o []rspec.LinuxSeccompArg) []*LinuxSeccompArg {
 	args := make([]*LinuxSeccompArg, len(o))
 
@@ -82,6 +85,7 @@ func FromOCILinuxSeccompArgs(o []rspec.LinuxSeccompArg) []*LinuxSeccompArg {
 	return args
 }
 
+// ToOCILinuxSyscalls converts seccomp syscalls configuration to an OCI runtime spec.
 func ToOCILinuxSyscalls(o []*LinuxSyscall) []rspec.LinuxSyscall {
 	syscalls := make([]rspec.LinuxSyscall, len(o))
 
@@ -103,6 +107,7 @@ func ToOCILinuxSyscalls(o []*LinuxSyscall) []rspec.LinuxSyscall {
 	return syscalls
 }
 
+// ToOCILinuxSeccompArgs converts seccomp syscall args to an OCI runtime spec.
 func ToOCILinuxSeccompArgs(o []*LinuxSeccompArg) []rspec.LinuxSeccompArg {
 	args := make([]rspec.LinuxSeccompArg, len(o))
 

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ import (`
`20`	`20`	`rspec "github.com/opencontainers/runtime-spec/specs-go"`
`21`	`21`	`)`
`22`	`22`
	`23`	`+// FromOCILinuxSeccomp converts an seccomp configuration from an OCI runtime spec.`
`23`	`24`	`func FromOCILinuxSeccomp(o rspec.LinuxSeccomp) LinuxSeccomp {`
`24`	`25`	`var errno *OptionalUInt32`
`25`	`26`	`if o.DefaultErrnoRet != nil {`
`@@ -47,6 +48,7 @@ func FromOCILinuxSeccomp(o rspec.LinuxSeccomp) LinuxSeccomp {`
`47`	`48`	`}`
`48`	`49`	`}`
`49`	`50`
	`51`	`+// FromOCILinuxSyscalls converts seccomp syscalls configuration from an OCI runtime spec.`
`50`	`52`	`func FromOCILinuxSyscalls(o []rspec.LinuxSyscall) []*LinuxSyscall {`
`51`	`53`	`syscalls := make([]*LinuxSyscall, len(o))`
`52`	`54`
`@@ -67,6 +69,7 @@ func FromOCILinuxSyscalls(o []rspec.LinuxSyscall) []*LinuxSyscall {`
`67`	`69`	`return syscalls`
`68`	`70`	`}`
`69`	`71`
	`72`	`+// FromOCILinuxSeccompArgs converts seccomp syscall args from an OCI runtime spec.`
`70`	`73`	`func FromOCILinuxSeccompArgs(o []rspec.LinuxSeccompArg) []*LinuxSeccompArg {`
`71`	`74`	`args := make([]*LinuxSeccompArg, len(o))`
`72`	`75`
`@@ -82,6 +85,7 @@ func FromOCILinuxSeccompArgs(o []rspec.LinuxSeccompArg) []*LinuxSeccompArg {`
`82`	`85`	`return args`
`83`	`86`	`}`
`84`	`87`
	`88`	`+// ToOCILinuxSyscalls converts seccomp syscalls configuration to an OCI runtime spec.`
`85`	`89`	`func ToOCILinuxSyscalls(o []*LinuxSyscall) []rspec.LinuxSyscall {`
`86`	`90`	`syscalls := make([]rspec.LinuxSyscall, len(o))`
`87`	`91`
`@@ -103,6 +107,7 @@ func ToOCILinuxSyscalls(o []*LinuxSyscall) []rspec.LinuxSyscall {`
`103`	`107`	`return syscalls`
`104`	`108`	`}`
`105`	`109`
	`110`	`+// ToOCILinuxSeccompArgs converts seccomp syscall args to an OCI runtime spec.`
`106`	`111`	`func ToOCILinuxSeccompArgs(o []*LinuxSeccompArg) []rspec.LinuxSeccompArg {`
`107`	`112`	`args := make([]rspec.LinuxSeccompArg, len(o))`
`108`	`113`