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.rb5
1 files changed, 3 insertions, 2 deletions
diff --git a/lib/chef/resource/archive_file.rb b/lib/chef/resource/archive_file.rb
index b288cb4885..58e106d9bc 100644
--- a/lib/chef/resource/archive_file.rb
+++ b/lib/chef/resource/archive_file.rb
@@ -29,9 +29,10 @@ class Chef
provides :libarchive_file # legacy cookbook name
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."
+ 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
+ **Extract a zip file to a specified directory**:
+
```ruby
archive_file 'Precompiled.zip' do
path '/tmp/Precompiled.zip'