diff options
| author | Ben H <git@mumble.org.uk> | 2011-03-13 14:07:37 +1100 |
|---|---|---|
| committer | Adrien Thebo <adrien.thebo@gmail.com> | 2011-04-01 18:19:11 -0700 |
| commit | d31e3f9ee6b36e707a189569132bcdcea79f20f6 (patch) | |
| tree | 2a1eea877715b67963b9f48de93c6fc73dab9838 /lib/facter/id.rb | |
| parent | af4947c603b8f6610d861f303a7813cbc5ecf5e7 (diff) | |
| download | facter-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/id.rb')
| -rw-r--r-- | lib/facter/id.rb | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/lib/facter/id.rb b/lib/facter/id.rb index 1c42284..cc0a0a6 100644 --- a/lib/facter/id.rb +++ b/lib/facter/id.rb @@ -1,3 +1,16 @@ +# Fact: id +# +# Purpose: Internal fact used to specity the program to return the currently +# running user id. +# +# Resolution: +# On all Unixes bar Solaris, just returns "whoami". +# On Solaris, parses the output of the "id" command to grab the username, as +# Solaris doesn't have the whoami command. +# +# Caveats: +# + Facter.add(:id) do setcode "whoami" end |