summaryrefslogtreecommitdiff
path: root/lib/chef/resource/apt_preference.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-03-16 13:46:45 -0700
committerTim Smith <tsmith@chef.io>2018-03-16 13:50:52 -0700
commitfc7e246cb008d4db3588165069de36cc02089f60 (patch)
tree7d085fe63ab767d19c6d17431504a317668d5807 /lib/chef/resource/apt_preference.rb
parentc928e064bfa907b3576df2c753a7a3de883ab2ad (diff)
downloadchef-fc7e246cb008d4db3588165069de36cc02089f60.tar.gz
More documentation updates for resources
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/apt_preference.rb')
-rw-r--r--lib/chef/resource/apt_preference.rb19
1 files changed, 15 insertions, 4 deletions
diff --git a/lib/chef/resource/apt_preference.rb b/lib/chef/resource/apt_preference.rb
index 442d85a78a..42e2c66aef 100644
--- a/lib/chef/resource/apt_preference.rb
+++ b/lib/chef/resource/apt_preference.rb
@@ -30,10 +30,21 @@ class Chef
" sources are prioritized during installation."
introduced "13.3"
- property :package_name, String, name_property: true, regex: [/^([a-z]|[A-Z]|[0-9]|_|-|\.|\*|\+)+$/]
- property :glob, String
- property :pin, String, required: true
- property :pin_priority, [String, Integer], required: true
+ property :package_name, String,
+ name_property: true,
+ description: "The name of the package.",
+ regex: [/^([a-z]|[A-Z]|[0-9]|_|-|\.|\*|\+)+$/]
+
+ property :glob, String,
+ description: "Pin by glob() expression or with regular expressions surrounded by /."
+
+ property :pin, String,
+ description: "The package version or repository to pin.",
+ required: true
+
+ property :pin_priority, [String, Integer],
+ description: "Sets the Pin-Priority for a package.",
+ required: true
default_action :add
allowed_actions :add, :remove