summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2020-09-10 15:14:57 -0700
committerGitHub <noreply@github.com>2020-09-10 15:14:57 -0700
commita745f10bcd5287deb96aaf8c40cad3025912671c (patch)
tree010badf57413b3170984ed15f3aeb505e120cd09
parent6e0e0be6eb588434751ab4dcae86cca872858e8b (diff)
parent47ddcef8441031e2bd9c71538f0b32098c72772c (diff)
downloadchef-a745f10bcd5287deb96aaf8c40cad3025912671c.tar.gz
Merge pull request #10416 from chef/docs
Update sysctl resource description to match reality
-rw-r--r--lib/chef/resource/sysctl.rb6
1 files changed, 1 insertions, 5 deletions
diff --git a/lib/chef/resource/sysctl.rb b/lib/chef/resource/sysctl.rb
index 8b745f709e..bf9424f35f 100644
--- a/lib/chef/resource/sysctl.rb
+++ b/lib/chef/resource/sysctl.rb
@@ -25,11 +25,7 @@ class Chef
provides(:sysctl) { true }
provides(:sysctl_param) { true }
- description "Use the **sysctl** resource to set or remove kernel parameters using the sysctl"\
- " command line tool and configuration files in the system's sysctl.d directory. "\
- "Configuration files managed by this resource are named 99-chef-KEYNAME.conf. If"\
- " an existing value was already set for the value it will be backed up to the node"\
- " and restored if the :remove action is used later."
+ description "Use the **sysctl** resource to set or remove kernel parameters using the `sysctl` command line tool and configuration files in the system's `sysctl.d` directory. Configuration files managed by this resource are named `99-chef-KEYNAME.conf`."
examples <<~DOC
**Set vm.swappiness**: