projects
/
mirror
/
dsa-puppet.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git]
/
3rdparty
/
modules
/
stdlib
/
lib
/
puppet
/
functions
/
fact.rb
diff --git
a/3rdparty/modules/stdlib/lib/puppet/functions/fact.rb
b/3rdparty/modules/stdlib/lib/puppet/functions/fact.rb
index
48736ad
..
c963d16
100644
(file)
--- a/
3rdparty/modules/stdlib/lib/puppet/functions/fact.rb
+++ b/
3rdparty/modules/stdlib/lib/puppet/functions/fact.rb
@@
-1,19
+1,25
@@
-# Digs into the facts hash using dot-notation
+# @summary
+# Digs into the facts hash using dot-notation
#
#
-# Example usage:
+# Supports the use of dot-notation for referring to structured facts. If a fact requested
+# does not exist, returns Undef.
#
#
+# @example Example usage:
# fact('osfamily')
# fact('os.architecture')
#
# fact('osfamily')
# fact('os.architecture')
#
-# Array indexing:
-#
+# @example Array indexing:
# fact('mountpoints."/dev".options.1')
#
# fact('mountpoints."/dev".options.1')
#
-# Fact containing a "." in the name:
-#
+# @example Fact containing a "." in the name:
# fact('vmware."VRA.version"')
#
Puppet::Functions.create_function(:fact) do
# fact('vmware."VRA.version"')
#
Puppet::Functions.create_function(:fact) do
+ # @param fact_name
+ # The name of the fact to check
+ #
+ # @return
+ # All information retrieved on the given fact_name
dispatch :fact do
param 'String', :fact_name
end
dispatch :fact do
param 'String', :fact_name
end