summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorBryan Jen <bryan.jen@gmail.com>2016-12-15 10:09:30 -0700
committerGitHub <noreply@github.com>2016-12-15 10:09:30 -0700
commit0d6df4fda791cb07e036365993d4f00f9d0f78aa (patch)
tree1d91edef1fe3c240dd7d0614da44d9ba299eaf13 /README.markdown
parent552445105f476434aa502bfccfb19dfb14b5b350 (diff)
parent1cd0209aec84b0135adbe6b5fc2769f0053c26f3 (diff)
Merge pull request #640 from hunner/add_pry
Add pry() function from hunner-pry
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
index 627e73a..5aea25f 100644
--- a/README.markdown
+++ b/README.markdown
@@ -944,6 +944,20 @@ For example:
*Type*: rvalue.
+#### `pry`
+
+This function invokes a pry debugging session in the current scope object. This is useful for debugging manifest code at specific points during a compilation. Should only be used when running `puppet apply` or running a puppet master in the foreground. This requires the `pry` gem to be installed in puppet's rubygems.
+
+*Examples:*
+```puppet
+pry()
+```
+Once in a pry session, some interesting commands:
+
+* Run `catalog` to see the contents currently compiling catalog
+* Run `cd catalog` and `ls` to see catalog methods and instance variables
+* Run `@resource_table` to see the current catalog resource table
+
#### `assert_private`
Sets the current class or definition as private. Calling the class or definition from outside the current module will fail.