Skip to content

Commit c52d5ff

Browse files
authored
Merge pull request #197 from glennsarti/add-debug-note
(maint) Use noop by default and fix readme typo
2 parents 55cc029 + 874d9cd commit c52d5ff

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

client/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ To use any of the above commands, open the command palette and start typing a co
104104

105105
**Note - This is an experimental feature**
106106

107-
The Puppet extension is able to debug the compilation of a Puppet manifest, much like a Go, PowerShell, C# etc. The debugger supports:
107+
The Puppet extension is able to debug the compilation of a Puppet manifest, much like the Go, PowerShell, and C# languages. The debugger supports:
108108

109109
* Line breakpoints but not conditions on those breakpoints
110110
* Function breakpoints
@@ -116,11 +116,13 @@ The Puppet extension is able to debug the compilation of a Puppet manifest, much
116116

117117
You may be presented with a Launch Configuration on first use. Please see the [VSCode Debugging link](https://code.visualstudio.com/docs/editor/debugging) for instructions on how to set this up.
118118

119+
The debugging features in the extension are based on the excellent ideas in [puppet-debugger](https://www.puppet-debugger.com/) by [Corey Osman](https://github.com/nwops).
120+
119121
Settings:
120122

121123
`manifest` - The manifest to apply. By default this is the currently open file in the editor
122124

123-
`noop` - Whether the `puppet apply` sets No Operation (Noop) mode. By default, this is set to false. This means when runing the debugger it can make changes to your system
125+
`noop` - Whether the `puppet apply` sets No Operation (Noop) mode. By default, this is set to true. This means when running the debugger it will not make changes to your system. The [documentation about the puppet agent](https://puppet.com/docs/puppet/5.3/man/apply.html#OPTIONS) has more information about `puppet apply` and and the `noop` option.
124126

125127
`args` - Additional arguements to pass to `puppet apply`, for example `['--debug']` will output debug information
126128

client/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -353,8 +353,8 @@
353353
},
354354
"noop": {
355355
"type": "boolean",
356-
"description": "Optional: Whether the the Puppet run is in NoOp mode. Default is false.",
357-
"default": false
356+
"description": "Optional: Whether the the Puppet run is in NoOp mode. Default is true.",
357+
"default": true
358358
},
359359
"args": {
360360
"type": "array",

0 commit comments

Comments
 (0)