summaryrefslogtreecommitdiffstats
path: root/lib/facter/kernel.rb
diff options
context:
space:
mode:
authorBen H <git@mumble.org.uk>2011-03-13 14:07:37 +1100
committerAdrien Thebo <adrien.thebo@gmail.com>2011-04-01 18:19:11 -0700
commitd31e3f9ee6b36e707a189569132bcdcea79f20f6 (patch)
tree2a1eea877715b67963b9f48de93c6fc73dab9838 /lib/facter/kernel.rb
parentaf4947c603b8f6610d861f303a7813cbc5ecf5e7 (diff)
downloadfacter-d31e3f9ee6b36e707a189569132bcdcea79f20f6.tar.gz
facter-d31e3f9ee6b36e707a189569132bcdcea79f20f6.tar.xz
facter-d31e3f9ee6b36e707a189569132bcdcea79f20f6.zip
(#5394) Document each Facter fact.
Document all the builtin Facter facts in puppetdoc/rdoc format. This is laying the ground work for using a tool like puppet doc, or puppet describe but for facter, so you can see what a fact is for and how it resolves this. This is the "leg work" of documenting the actual facts, and the syntax of them may change in future.
Diffstat (limited to 'lib/facter/kernel.rb')
-rw-r--r--lib/facter/kernel.rb11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/facter/kernel.rb b/lib/facter/kernel.rb
index 66f21ce..f457e01 100644
--- a/lib/facter/kernel.rb
+++ b/lib/facter/kernel.rb
@@ -1,3 +1,14 @@
+# Fact: kernel
+#
+# Purpose: Returns the operating system's name.
+#
+# Resolution:
+# Uses Ruby's rbconfig to find host_os, if that is a Windows derivative, the
+# returns 'windows', otherwise returns "uname -s" verbatim.
+#
+# Caveats:
+#
+
Facter.add(:kernel) do
setcode do
require 'rbconfig'