summaryrefslogtreecommitdiff
path: root/lib/chef/resource/breakpoint.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-02-13 16:34:47 +0000
committerTim Smith <tsmith@chef.io>2018-02-14 11:37:36 -0800
commit5c2b9e201f65d04252a86b1ad89d756f3e73792f (patch)
tree7eaa3b8131eef7afa79422a79b0219021a5972b6 /lib/chef/resource/breakpoint.rb
parentc563a379b2ac9a47f5bd5c9e0c40bebed86aae8c (diff)
downloadchef-5c2b9e201f65d04252a86b1ad89d756f3e73792f.tar.gz
Add new introduced and description resource properties to many resource
Not all of them, but a good chunk. Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/breakpoint.rb')
-rw-r--r--lib/chef/resource/breakpoint.rb15
1 files changed, 9 insertions, 6 deletions
diff --git a/lib/chef/resource/breakpoint.rb b/lib/chef/resource/breakpoint.rb
index 5d2c5555be..1ccc4311b3 100644
--- a/lib/chef/resource/breakpoint.rb
+++ b/lib/chef/resource/breakpoint.rb
@@ -20,16 +20,19 @@ 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
+ description "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."
+ introduced "12.0"
+
default_action :break
def initialize(action = "break", *args)