diff options
| author | Tim Smith <tsmith@chef.io> | 2017-12-19 13:40:22 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-12-19 13:40:22 -0800 |
| commit | 0ebf198dd0a8788fcc536ea31e4b01a89fa63522 (patch) | |
| tree | dc1579a4d86882ab3e766186a808d8acbeab5d12 /lib/chef/resource/breakpoint.rb | |
| parent | 04d5cdb9bac717d9682707d0ffc65aaf3a7c591e (diff) | |
| parent | 034f00f6c466c3924e5fdb069b484d1961283c76 (diff) | |
| download | chef-0ebf198dd0a8788fcc536ea31e4b01a89fa63522.tar.gz | |
Merge pull request #6696 from chef/yard
Add descriptions and yard @since comments to all resources
Diffstat (limited to 'lib/chef/resource/breakpoint.rb')
| -rw-r--r-- | lib/chef/resource/breakpoint.rb | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/chef/resource/breakpoint.rb b/lib/chef/resource/breakpoint.rb index 81cfd89e5e..5d2c5555be 100644 --- a/lib/chef/resource/breakpoint.rb +++ b/lib/chef/resource/breakpoint.rb @@ -20,6 +20,12 @@ require "chef/resource" class Chef class Resource + # Use the breakpoint resource to add breakpoints to recipes. Run the chef-shell in chef-client mode, and then use + # those breakpoints to debug recipes. Breakpoints are ignored by the chef-client during an actual chef-client run. + # That said, breakpoints are typically used to debug recipes only when running them in a non-production environment, + # after which they are removed from those recipes before the parent cookbook is uploaded to the Chef server. + # + # @since 12.0 class Breakpoint < Chef::Resource provides :breakpoint resource_name :breakpoint |