summaryrefslogtreecommitdiffstats
path: root/lib/facter/memory.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/facter/memory.rb')
-rw-r--r--lib/facter/memory.rb17
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/facter/memory.rb b/lib/facter/memory.rb
index 0aa5e88..992f2ad 100644
--- a/lib/facter/memory.rb
+++ b/lib/facter/memory.rb
@@ -1,3 +1,20 @@
+# Fact: memory
+#
+# Purpose: Return information about memory and swap usage.
+#
+# Resolution:
+# On Linuxes, uses Facter::Memory.meminfo_number from
+# 'facter/util/memory.rb'
+# On AIX, parses "swap -l" for swap values only.
+# On OpenBSD, it parses "swapctl -l" for swap values, vmstat via a module for
+# free memory, and "sysctl hw.physmem" for maximum memory.
+# On Solaris, use "swap -l" for swap values, and parsing prtconf for maximum
+# memory, and again, the vmstat module for free memory.
+#
+# Caveats:
+# Some BSD platforms aren't covered at all. AIX is missing memory values.
+#
+
# memory.rb
# Additional Facts for memory/swap usage
#