summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLamont Granquist <lamont@scriptkiddie.org>2017-03-16 16:08:47 -0700
committerLamont Granquist <lamont@scriptkiddie.org>2017-03-17 09:05:14 -0700
commit7ae99fe1c5e47fe306965393528c619b822322d3 (patch)
tree5e813b093d95960d5f55dfe7f6ecc65df95a57fa
parent99d808cc95fbb72133e11d7f87a83a8afc2ba98e (diff)
downloadchef-7ae99fe1c5e47fe306965393528c619b822322d3.tar.gz
add RELEASE_NOTES
Signed-off-by: Lamont Granquist <lamont@scriptkiddie.org>
-rw-r--r--RELEASE_NOTES.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
index 28468a1667..6ebd586b7b 100644
--- a/RELEASE_NOTES.md
+++ b/RELEASE_NOTES.md
@@ -92,3 +92,11 @@ now correctly use the `node.dup` or `node.to_hash` methods, or you should mutate
### The Chef::REST API has been removed
It has been fully replaced with `Chef::ServerAPI` in chef-client code.
+
+### Properties overriding methods now raise an error
+
+Defining a property that overrides methods defined on the base ruby `Object` or on `Chef::Resource` itself can cause large amounts of
+confusion. A simple example is `property :hash` which overrides the Object#hash method which will confuse ruby when the Custom Resource
+is placed into the Chef::ResourceCollection which uses a Hash internally which expects to call Object#hash to get a unique id for the
+object. Attempting to create `property :action` would also override the Chef::Resource#action method which is unlikely to end well for
+the user. Overriding inherited properties is still supported.