summaryrefslogtreecommitdiff
path: root/lib/chef/resource/breakpoint.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/chef/resource/breakpoint.rb')
-rw-r--r--lib/chef/resource/breakpoint.rb6
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