summaryrefslogtreecommitdiff
path: root/lib/chef/version.rb
diff options
context:
space:
mode:
authorLamont Granquist <lamont@scriptkiddie.org>2014-07-17 19:13:06 -0700
committerLamont Granquist <lamont@scriptkiddie.org>2014-07-17 19:13:06 -0700
commit5ccee40e72dd7df6ed72d910826d73dba1280a14 (patch)
treeb0c193a639de24c20f6d913a7f75937bb3e2a56f /lib/chef/version.rb
parentfa117a8ba978533e0bb1f4cfe6915d956623476a (diff)
downloadchef-5ccee40e72dd7df6ed72d910826d73dba1280a14.tar.gz
note on using Gem::Version instead of Chef::Version
Diffstat (limited to 'lib/chef/version.rb')
-rw-r--r--lib/chef/version.rb9
1 files changed, 4 insertions, 5 deletions
diff --git a/lib/chef/version.rb b/lib/chef/version.rb
index dd9fe264aa..ea1002ee37 100644
--- a/lib/chef/version.rb
+++ b/lib/chef/version.rb
@@ -23,9 +23,8 @@ end
#
# NOTE: the Chef::Version class is defined in version_class.rb
#
-# NOTE: to further confuse things, *NEVER* use the Chef::Version class
-# on a Chef::VERSION -- the class only applies to cookbook versions which
-# only have "X.Y.Z" versions with no alpha/rc/prerelease tags. A
-# simple Chef::VERSION.to_f coercion will likely work better, or else
-# you need to coerce the Chef::VERSION into exactly "X.Y.Z" yourself.
+# NOTE: DO NOT Use the Chef::Version class on Chef::VERSIONs. The
+# Chef::Version class is for _cookbooks_ only, and cannot handle
+# pre-release chef-client versions like "10.14.0.rc.2". Please
+# use Rubygem's Gem::Version class instead.
#