From: Jeff McCune <jeff@puppetlabs.com>
Date: Wed, 22 Jun 2011 00:06:46 +0000 (-0700)
Subject: Update README with getvar() and validate_hash()
X-Git-Url: https://gitweb.fluxo.info/?a=commitdiff_plain;h=0ea7a0ffdef8b676c088d35f13f265a577fa2c2f;p=puppet-stdlib.git

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.
---

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")