Merge pull request moby#11853 from EricR/doc-PkgSysInfo

Add some basic doc for SysInfo
Axway · Mar 27, 2015 · 7cc7360 · 7cc7360
2 parents cc609c7 + 3716df5
commit 7cc7360
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/pkg/sysinfo/README.md b/pkg/sysinfo/README.md
@@ -0,0 +1 @@
+SysInfo stores information about which features a kernel supports.
diff --git a/pkg/sysinfo/sysinfo.go b/pkg/sysinfo/sysinfo.go
@@ -9,13 +9,15 @@ import (
 	"github.com/docker/libcontainer/cgroups"
 )
 
+// SysInfo stores information about which features a kernel supports.
 type SysInfo struct {
 	MemoryLimit            bool
 	SwapLimit              bool
 	IPv4ForwardingDisabled bool
 	AppArmor               bool
 }
 
+// New returns a new SysInfo, using the filesystem to detect which features the kernel supports.
 func New(quiet bool) *SysInfo {
 	sysInfo := &SysInfo{}
 	if cgroupMemoryMountpoint, err := cgroups.FindCgroupMountpoint("memory"); err != nil {
@@ -37,7 +39,7 @@ func New(quiet bool) *SysInfo {
 		}
 	}
 
-	// Check if AppArmor seems to be enabled on this system.
+	// Check if AppArmor is supported.
 	if _, err := os.Stat("/sys/kernel/security/apparmor"); os.IsNotExist(err) {
 		sysInfo.AppArmor = false
 	} else {
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		SysInfo stores information about which features a kernel supports.