summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPete Higgins <pete@peterhiggins.org>2020-06-16 17:20:06 -0700
committerPete Higgins <pete@peterhiggins.org>2020-06-16 17:20:06 -0700
commitd32ce3fbe39639c9050f0f349ebf588b08844c9c (patch)
tree20858810e813ba7a8e0f97e9754cc486e986067a
parentc48ad8fe6e319ca407e7d8fc5dcce7ea2e625105 (diff)
downloadchef-resource-umask-property.tar.gz
Add a doc comment.resource-umask-property
Signed-off-by: Pete Higgins <pete@peterhiggins.org>
-rw-r--r--lib/chef/resource.rb7
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/chef/resource.rb b/lib/chef/resource.rb
index ec99017b6d..99cba4b90c 100644
--- a/lib/chef/resource.rb
+++ b/lib/chef/resource.rb
@@ -451,7 +451,12 @@ class Chef
description: "Determines whether or not the resource is executed during the compile time phase.",
default: false, desired_state: false
- # TODO: fill in doc info
+ # Set a umask to be used for the duration of converging the resource.
+ # Defaults to `nil`, which means to use the system umask.
+ #
+ # @param arg [String] The umask to apply while converging the resource.
+ # @return [Boolean] The umask to apply while converging the resource.
+ #
property :umask, String, desired_state: false
# The time it took (in seconds) to run the most recently-run action. Not