diff options
author | Tim Smith <tsmith@chef.io> | 2018-07-25 10:40:35 -0700 |
---|---|---|
committer | Tim Smith <tsmith@chef.io> | 2018-07-25 10:40:35 -0700 |
commit | 0f374934172e2ec699c9891e8b136e1aa7ddde06 (patch) | |
tree | ec5d4174fb7e070d2608a8c7cd192c2f010cd3d7 | |
parent | 5c20fbb019d19453fae84f38f63cbd97a188ee81 (diff) | |
download | chef-0f374934172e2ec699c9891e8b136e1aa7ddde06.tar.gz |
Add descriptions and introduced dates to dsc_resource
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r-- | lib/chef/resource/dsc_resource.rb | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/lib/chef/resource/dsc_resource.rb b/lib/chef/resource/dsc_resource.rb index 9c703b81cc..8381698dc1 100644 --- a/lib/chef/resource/dsc_resource.rb +++ b/lib/chef/resource/dsc_resource.rb @@ -74,7 +74,9 @@ class Chef end end - property :module_version, String + property :module_version, String, + introduced: "12.21", + description: "The version number of the module to use. Powershell 5.0.10018.0 (or higher) supports having multiple versions of a module installed. This should be specified along with the module_name." def property(property_name, value = nil) if not property_name.is_a?(Symbol) @@ -99,9 +101,13 @@ class Chef # If the set method of the DSC resource indicate that a reboot # is necessary, reboot_action provides the mechanism for a reboot to # be requested. - property :reboot_action, Symbol, default: :nothing, equal_to: [:nothing, :reboot_now, :request_reboot] + property :reboot_action, Symbol, default: :nothing, equal_to: [:nothing, :reboot_now, :request_reboot], + introduced: "12.6", + description: "Use to request an immediate reboot or to queue a reboot using the :reboot_now (immediate reboot) or :request_reboot (queued reboot) actions built into the reboot resource." - property :timeout, Integer + property :timeout, Integer, + introduced: "12.6", + description: "The amount of time (in seconds) a command is to wait before timing out." private |