summaryrefslogtreecommitdiff
path: root/lib/chef/resource/build_essential.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/chef/resource/build_essential.rb')
-rw-r--r--lib/chef/resource/build_essential.rb12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/chef/resource/build_essential.rb b/lib/chef/resource/build_essential.rb
index b38ec6b24a..c4b4bdb161 100644
--- a/lib/chef/resource/build_essential.rb
+++ b/lib/chef/resource/build_essential.rb
@@ -24,6 +24,18 @@ class Chef
description "Use the build_essential resource to install packages required for compiling C software from source."
introduced "14.0"
+ examples <<~DOC
+ Install compilation packages
+ ```ruby
+ build_essential
+ ```
+ Install compilation packages during the compilation phase
+ ```ruby
+ build_essential 'Install compilation tools' do
+ compile_time true
+ end
+ ```
+ DOC
# this allows us to use build_essential without setting a name
property :name, String, default: ""