summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2020-05-28 11:21:45 -0700
committerTim Smith <tsmith84@gmail.com>2020-05-28 11:21:45 -0700
commit91497028ff3cd50b74dcc334c19db9b4675f5f53 (patch)
treeef77b4518e828d1fc8d59ac318b60735ce0d843a
parent008f083d470cf747ae4b56dea77bf75ad8599263 (diff)
downloadchef-91497028ff3cd50b74dcc334c19db9b4675f5f53.tar.gz
Add example to plist
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/resource/plist.rb11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/chef/resource/plist.rb b/lib/chef/resource/plist.rb
index e880ce70a4..06811ea8b6 100644
--- a/lib/chef/resource/plist.rb
+++ b/lib/chef/resource/plist.rb
@@ -28,6 +28,17 @@ class Chef
description "Use the **plist** resource to set config values in plist files on macOS systems."
introduced "16.0"
+ examples <<~DOC
+ **Show hidden files in finder**:
+
+ ```ruby
+ plist 'show hidden files' do
+ path '/Users/vagrant/Library/Preferences/com.apple.finder.plist'
+ entry 'AppleShowAllFiles'
+ value true
+ end
+ ```
+ DOC
property :path, String, name_property: true,
description: "The path on disk to the plist file."