summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordanielsdeleo <dan@opscode.com>2012-12-21 11:56:56 -0800
committerdanielsdeleo <dan@opscode.com>2012-12-21 12:15:18 -0800
commitd9208f7572e028244f3007ff8dbf0be7c9380593 (patch)
tree0b561692cb09ebd24662914bb76905b53aefa59d
parent4638b8e0a0f7edc0a760313cb4acd2db4f11a383 (diff)
downloadchef-d9208f7572e028244f3007ff8dbf0be7c9380593.tar.gz
[CHEF-3715] document PersistentSet's config logic
-rw-r--r--lib/chef/cookbook/syntax_check.rb7
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/chef/cookbook/syntax_check.rb b/lib/chef/cookbook/syntax_check.rb
index d656f96ebd..40ba070796 100644
--- a/lib/chef/cookbook/syntax_check.rb
+++ b/lib/chef/cookbook/syntax_check.rb
@@ -42,6 +42,13 @@ class Chef
# value of Chef::Config[:syntax_check_cache_path] is used; if that
# value is not configured, the value of
# Chef::Config[:cache_options][:path] is used.
+ #--
+ # history: prior to Chef 11, the cache implementation was based on
+ # moneta and configured via cache_options[:path]. Knife configs
+ # generated with Chef 11 will have `syntax_check_cache_path`, but older
+ # configs will have `cache_options[:path]`. `cache_options` is marked
+ # deprecated in chef/config.rb but doesn't currently trigger a warning.
+ # See also: CHEF-3715
def initialize(cache_path=nil)
@cache_path = cache_path || Chef::Config[:syntax_check_cache_path] || Chef::Config[:cache_options][:path]
@cache_path_created = false