summaryrefslogtreecommitdiff
path: root/lib/chef/resource/execute.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-07-25 13:21:28 -0700
committerTim Smith <tsmith@chef.io>2018-07-25 13:21:28 -0700
commit94882ad439bec7b2d7249efe58a5d80595a06856 (patch)
tree516c79bf4acb37dea0655fd290c82dd3324d896e /lib/chef/resource/execute.rb
parent2b1470b1d4dd1e67a5a03c036d358ff32e987c15 (diff)
downloadchef-94882ad439bec7b2d7249efe58a5d80595a06856.tar.gz
Remove some default values in descriptions
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/execute.rb')
-rw-r--r--lib/chef/resource/execute.rb6
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/chef/resource/execute.rb b/lib/chef/resource/execute.rb
index d1f7eaf729..93f8063d5d 100644
--- a/lib/chef/resource/execute.rb
+++ b/lib/chef/resource/execute.rb
@@ -87,15 +87,15 @@ class Chef
description: "The amount of time (in seconds) a command is to wait before timing out."
property :user, [ String, Integer ],
- description: "The user name of the user identity with which to launch the new process. Default value: nil. The user name may optionally be specifed with a domain, i.e. domainuser or user@my.dns.domain.com via Universal Principal Name (UPN)format. It can also be specified without a domain simply as user if the domain is instead specified using the domain attribute. On Windows only, if this property is specified, the password property must be specified."
+ description: "The user name of the user identity with which to launch the new process. The user name may optionally be specifed with a domain, i.e. domainuser or user@my.dns.domain.com via Universal Principal Name (UPN)format. It can also be specified without a domain simply as user if the domain is instead specified using the domain attribute. On Windows only, if this property is specified, the password property must be specified."
property :domain, String,
introduced: "12.21",
- description: "Windows only: The domain of the user user specified by the user property. Default value: nil. If not specified, the user name and password specified by the user and password properties will be used to resolve that user against the domain in which the system running Chef client is joined, or if that system is not joined to a domain it will resolve the user as a local account on that system. An alternative way to specify the domain is to leave this property unspecified and specify the domain as part of the user property."
+ description: "Windows only: The domain of the user user specified by the user property. If not specified, the user name and password specified by the user and password properties will be used to resolve that user against the domain in which the system running Chef client is joined, or if that system is not joined to a domain it will resolve the user as a local account on that system. An alternative way to specify the domain is to leave this property unspecified and specify the domain as part of the user property."
property :password, String, sensitive: true,
introduced: "12.21",
- description: "Windows only: The password of the user specified by the user property. Default value: nil. This property is mandatory if user is specified on Windows and may only be specified if user is specified. The sensitive property for this resource will automatically be set to true if password is specified."
+ description: "Windows only: The password of the user specified by the user property. This property is mandatory if user is specified on Windows and may only be specified if user is specified. The sensitive property for this resource will automatically be set to true if password is specified."
# lazy used to set default value of sensitive to true if password is set
property :sensitive, [ TrueClass, FalseClass ], default: lazy { |r| r.password ? true : false }