summaryrefslogtreecommitdiffstats
path: root/lib/facter/fqdn.rb
diff options
context:
space:
mode:
authorBen H <git@mumble.org.uk>2011-03-13 14:07:37 +1100
committerBen Hughes <ben@puppetlabs.com>2011-03-31 17:35:40 +1100
commit7c082702c72c168f3e739b9bc1c7562b0aa15ddd (patch)
tree48a5a3fc8c76ef67981def4fd6e9d574a824a379 /lib/facter/fqdn.rb
parent28f475ab83319e1bf15ee108d5895cadc72383ad (diff)
downloadfacter-7c082702c72c168f3e739b9bc1c7562b0aa15ddd.tar.gz
facter-7c082702c72c168f3e739b9bc1c7562b0aa15ddd.tar.xz
facter-7c082702c72c168f3e739b9bc1c7562b0aa15ddd.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/fqdn.rb')
-rw-r--r--lib/facter/fqdn.rb11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/facter/fqdn.rb b/lib/facter/fqdn.rb
index 5ebc5f5..090ca63 100644
--- a/lib/facter/fqdn.rb
+++ b/lib/facter/fqdn.rb
@@ -1,3 +1,14 @@
+# Fact: fqdn
+#
+# Purpose: Returns the fully qualified domain name of the host.
+#
+# Resolution: Simply joins the hostname fact with the domain name fact.
+#
+# Caveats: No attempt is made to check that the two facts are accurate or that
+# the two facts go together. At no point is there any DNS resolution made
+# either.
+#
+
Facter.add(:fqdn) do
setcode do
host = Facter.value(:hostname)