pkg/apparmor: clarify Godoc

Signed-off-by: Bjorn Neergaard <bneergaard@mirantis.com>
This commit is contained in:
Bjorn Neergaard 2023-02-10 10:13:48 -07:00
parent a3265102d9
commit d33a43cc23
No known key found for this signature in database
2 changed files with 8 additions and 8 deletions

View File

@ -16,13 +16,13 @@
package apparmor package apparmor
// HostSupports returns true if apparmor is enabled for the host, // On non-Linux returns false // HostSupports returns true if apparmor is enabled for the host:
// On Linux returns true if apparmor_parser is enabled, and if we // - On Linux returns true if apparmor is enabled, apparmor_parser is
// present, and if we are not running docker-in-docker.
// - On non-Linux returns false.
// //
// are not running docker-in-docker. // This is derived from libcontainer/apparmor.IsEnabled(), with the addition
// // of checks for apparmor_parser to be present and docker-in-docker.
// It is a modified version of libcontainer/apparmor.IsEnabled(), which does not
// check for apparmor_parser to be present, or if we're running docker-in-docker.
func HostSupports() bool { func HostSupports() bool {
return hostSupports() return hostSupports()
} }

View File

@ -29,8 +29,8 @@ var (
// hostSupports returns true if apparmor is enabled for the host, if // hostSupports returns true if apparmor is enabled for the host, if
// apparmor_parser is enabled, and if we are not running docker-in-docker. // apparmor_parser is enabled, and if we are not running docker-in-docker.
// //
// It is a modified version of libcontainer/apparmor.IsEnabled(), which does not // This is derived from libcontainer/apparmor.IsEnabled(), with the addition
// check for apparmor_parser to be present, or if we're running docker-in-docker. // of checks for apparmor_parser to be present and docker-in-docker.
func hostSupports() bool { func hostSupports() bool {
checkAppArmor.Do(func() { checkAppArmor.Do(func() {
// see https://github.com/opencontainers/runc/blob/0d49470392206f40eaab3b2190a57fe7bb3df458/libcontainer/apparmor/apparmor_linux.go // see https://github.com/opencontainers/runc/blob/0d49470392206f40eaab3b2190a57fe7bb3df458/libcontainer/apparmor/apparmor_linux.go