summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff McCune <jeff@puppetlabs.com>2011-06-21 17:06:46 -0700
committerJeff McCune <jeff@puppetlabs.com>2011-06-21 17:06:46 -0700
commit0ea7a0ffdef8b676c088d35f13f265a577fa2c2f (patch)
tree827f8a4c03eab4c8af422136ca1e83ce8b446d36
parentf036fbbb24c91a3f213210be42ff1e8d67615ce3 (diff)
Update README with getvar() and validate_hash()
The README now provides quick examples of how to take advantage of the getvar() and validate_hash() functions included in this release of the stdlib.
-rw-r--r--README.markdown14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
index f79b975..1e93c6f 100644
--- a/README.markdown
+++ b/README.markdown
@@ -28,4 +28,18 @@ TBA
Jeff McCune <jeff@puppetlabs.com>
+# Functions #
+## validate\_hash ##
+ $somehash = { 'one' => 'two' }
+ validate\_hash($somehash)
+
+## getvar() ##
+
+This function aims to look up variables in user-defined namespaces within
+puppet. Note, if the namespace is a class, it should already be evaluated
+before the function is used.
+
+ $namespace = 'site::data'
+ include "${namespace}"
+ $myvar = getvar("${namespace}::myvar")