summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorHunter Haugen <hunter@puppet.com>2016-08-17 10:27:54 -0700
committerHunter Haugen <hunter@puppet.com>2016-12-08 09:41:18 -0800
commit1cd0209aec84b0135adbe6b5fc2769f0053c26f3 (patch)
treef55288ba293ac86583739642f8afe254d1adae7a /README.markdown
parent7507af555361b2dcba8ed6189dc54c21e64ea031 (diff)
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 a6b7bda..3039a2a 100644
--- a/README.markdown
+++ b/README.markdown
@@ -935,6 +935,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.