summaryrefslogtreecommitdiff
path: root/lib/chef/resource/archive_file.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/chef/resource/archive_file.rb')
-rw-r--r--lib/chef/resource/archive_file.rb9
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/chef/resource/archive_file.rb b/lib/chef/resource/archive_file.rb
index 958da23a1b..0cf74bf3e5 100644
--- a/lib/chef/resource/archive_file.rb
+++ b/lib/chef/resource/archive_file.rb
@@ -30,6 +30,15 @@ class Chef
introduced "15.0"
description "Use the archive_file resource to extract archive files to disk. This resource uses the libarchive library to extract multiple archive formats including tar, gzip, bzip, and zip formats."
+ examples <<~DOC
+ Extract a zip file to a specified directory
+ ```ruby
+ archive_file 'Precompiled.zip' do
+ path '/tmp/Precompiled.zip'
+ destination '/srv/files'
+ end
+ ```
+ DOC
property :path, String,
name_property: true,