Преглед изворни кода

seccomp: improve GoDoc for Seccomp fields

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Sebastiaan van Stijn пре 4 година
родитељ
комит
b309e96b11
1 измењених фајлова са 13 додато и 3 уклоњено
  1. 13 3
      profiles/seccomp/seccomp.go

+ 13 - 3
profiles/seccomp/seccomp.go

@@ -18,9 +18,19 @@ type Seccomp struct {
 
 
 	// Architectures is kept to maintain backward compatibility with the old
 	// Architectures is kept to maintain backward compatibility with the old
 	// seccomp profile.
 	// seccomp profile.
-	Architectures []specs.Arch   `json:"architectures,omitempty"`
-	ArchMap       []Architecture `json:"archMap,omitempty"`
-	Syscalls      []*Syscall     `json:"syscalls"`
+	Architectures []specs.Arch `json:"architectures,omitempty"`
+
+	// ArchMap contains a list of Architectures and Sub-architectures for the
+	// profile. When generating the profile, this list is expanded to a
+	// []specs.Arch, to propagate the Architectures field of the profile.
+	ArchMap []Architecture `json:"archMap,omitempty"`
+
+	// Syscalls contains lists of syscall rules. Rules can define conditions
+	// for them to be included or excluded in the resulting profile (based on
+	// on kernel version, architecture, capabilities, etc.). These lists are
+	// expanded to an specs.Syscall  When generating the profile, these lists
+	// are expanded to a []specs.LinuxSyscall.
+	Syscalls []*Syscall `json:"syscalls"`
 }
 }
 
 
 // Architecture is used to represent a specific architecture
 // Architecture is used to represent a specific architecture