summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPete Higgins <pete@peterhiggins.org>2020-03-16 17:42:51 -0700
committerPete Higgins <pete@peterhiggins.org>2020-03-23 13:55:01 -0700
commite2e6d596da76d9eb85fb2ce9449732936ded1dc7 (patch)
treec041d850bc608203a694e800fd1ab206eceb8caf
parent292be14eaaba828f74214ddcff9348f0a164aaae (diff)
downloadchef-e2e6d596da76d9eb85fb2ce9449732936ded1dc7.tar.gz
Add documentation for new magic clear_sources behavior.
Signed-off-by: Pete Higgins <pete@peterhiggins.org>
-rw-r--r--lib/chef/provider/package/rubygems.rb4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/chef/provider/package/rubygems.rb b/lib/chef/provider/package/rubygems.rb
index a8d8fefb15..731c68df98 100644
--- a/lib/chef/provider/package/rubygems.rb
+++ b/lib/chef/provider/package/rubygems.rb
@@ -550,6 +550,10 @@ class Chef
new_resource.gem_binary || "gem"
end
+ ##
+ # If `clear_sources` is nil, clearing sources is implied if a `source`
+ # was added. If `clear_sources` is not nil, it has been set explicitly
+ # on the resource and its value should be used.
def clear_sources?
if new_resource.clear_sources.nil?
!!new_resource.source