Skip to content

Commit

Permalink
Document puppet-debugger integration
Browse files Browse the repository at this point in the history
  • Loading branch information
rski authored and roidelapluie committed Feb 13, 2017
1 parent 0cb83cd commit 03f6082
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Features
3. Tag navigation (aka `imenu`)
4. Manual validation and linting of manifests (see [Flycheck][] for on-the-fly
validation and linting)
5. Integration with [Puppet Debugger][]

Installation
------------
Expand Down Expand Up @@ -56,8 +57,16 @@ Key | Command
<kbd>C-c C-c</kbd> | Apply the current manifest in dry-run mode
<kbd>C-c C-v</kbd> | Validate the syntax of the current manifest
<kbd>C-c C-l</kbd> | Check the current manifest for semantic issues
<kbd>C-c C-z</kbd> | Launch a puppet-debugger REPL
<kbd>C-c C-r</kbd> | Send the currently marked region to the REPL
<kbd>C-c C-b</kbd> | Send the current buffer to the REPL


For the integration with puppet-debugger to work, the puppet-debugger gem needs
to be installed and available in your `$PATH`.
See [the instructions][puppet debugger install instructions] on
puppet-debugger's repository on how to install it.

Use `M-x customize-group RET puppet` to customize Puppet Mode.

Support
Expand Down Expand Up @@ -92,8 +101,10 @@ See [`COPYING`][copying] for the complete license.
[Puppet]: http://docs.puppetlabs.com/
[GNU Emacs]: https://www.gnu.org/software/emacs/
[Flycheck]: http://wwww.flycheck.org
[Puppet Debugger]: https://github.com/nwops/puppet-debugger
[MELPA]: https://melpa.org/
[MELPA Stable]: https://stable.melpa.org
[Cask]: http://cask.github.io/
[puppet debugger install instructions]: https://github.com/nwops/puppet-debugger/#installation
[Issue tracker]: https://github.com/voxpupuli/puppet-mode/issues
[Github]: https://github.com/voxpupuli/puppet-mode

0 comments on commit 03f6082

Please sign in to comment.