diff options
| author | Tim Smith <tsmith84@gmail.com> | 2019-08-08 14:45:01 -0700 |
|---|---|---|
| committer | Tim Smith <tsmith84@gmail.com> | 2019-08-08 15:34:00 -0700 |
| commit | e10231977b030e1bf42d32f3858c27346866d53d (patch) | |
| tree | b82c34d1e6c07dd716048a63c1ebfe01b4eb4764 /lib/chef/resource/service.rb | |
| parent | 6aeacddd7222d7fb5559787c6017b663d3292574 (diff) | |
| download | chef-e10231977b030e1bf42d32f3858c27346866d53d.tar.gz | |
Improve the auto-generated docs
Formatting fixes and updates to the text to make the generated text match what's currently on the site.
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/service.rb')
| -rw-r--r-- | lib/chef/resource/service.rb | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/lib/chef/resource/service.rb b/lib/chef/resource/service.rb index f04e7b3c9c..dec7209fd0 100644 --- a/lib/chef/resource/service.rb +++ b/lib/chef/resource/service.rb @@ -35,7 +35,7 @@ class Chef # this is a poor API please do not re-use this pattern property :supports, Hash, default: { restart: nil, reload: nil, status: nil }, - description: "A list of properties that controls how the #{Chef::Dist::CLIENT} is to attempt to manage a service: :restart, :reload, :status. For :restart, the init script or other service provider can use a restart command; if :restart is not specified, the #{Chef::Dist::CLIENT} attempts to stop and then start a service. For :reload, the init script or other service provider can use a reload command. For :status, the init script or other service provider can use a status command to determine if the service is running; if :status is not specified, the #{Chef::Dist::CLIENT} attempts to match the service_name against the process table as a regular expression, unless a pattern is specified as a parameter property. Default value: { restart: false, reload: false, status: false } for all platforms (except for the Red Hat platform family, which defaults to { restart: false, reload: false, status: true }.)", + description: "A list of properties that controls how #{Chef::Dist::PRODUCT} is to attempt to manage a service: :restart, :reload, :status. For :restart, the init script or other service provider can use a restart command; if :restart is not specified, the #{Chef::Dist::CLIENT} attempts to stop and then start a service. For :reload, the init script or other service provider can use a reload command. For :status, the init script or other service provider can use a status command to determine if the service is running; if :status is not specified, the #{Chef::Dist::CLIENT} attempts to match the service_name against the process table as a regular expression, unless a pattern is specified as a parameter property. Default value: { restart: false, reload: false, status: false } for all platforms (except for the Red Hat platform family, which defaults to { restart: false, reload: false, status: true }.)", coerce: proc { |x| x.is_a?(Array) ? x.each_with_object({}) { |i, m| m[i] = true } : x } property :service_name, String, |