summaryrefslogtreecommitdiff
path: root/lib/chef/resource/build_essential.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-03-04 16:18:52 -0800
committerTim Smith <tsmith@chef.io>2018-03-04 16:39:15 -0800
commite0a14935df0c0dd34fdaa8d3228d5d83e4a7cfbd (patch)
tree95dd4d1b0e3e1aecdf44e9dee45e885296fd4a10 /lib/chef/resource/build_essential.rb
parent599f0dfec0c8c2b0d6d6eaf2a594abeebf40ff66 (diff)
downloadchef-e0a14935df0c0dd34fdaa8d3228d5d83e4a7cfbd.tar.gz
Add more description fields, style fixes, add missing requires
Make sure to require chef/resource everywhere. It would work without it but only because some other resource had already required it. Put the type on the same line as the property, which we discussed in slack Put introduced after description which makes differing simpler Convert some yard into description fields Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/build_essential.rb')
-rw-r--r--lib/chef/resource/build_essential.rb7
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/chef/resource/build_essential.rb b/lib/chef/resource/build_essential.rb
index 881f932b30..1885471cb8 100644
--- a/lib/chef/resource/build_essential.rb
+++ b/lib/chef/resource/build_essential.rb
@@ -22,7 +22,12 @@ class Chef
resource_name :build_essential
provides :build_essential
- property :compile_time, [true, false], default: false
+ description "Use the build_essential resource to install packages required for compiling C software from source"
+ introduced "14.0"
+
+ property :compile_time, [true, false],
+ description: "Install build essential packages at compile time.",
+ default: false
action :install do
case node["platform_family"]