summaryrefslogtreecommitdiff
path: root/DOC_CHANGES.md
diff options
context:
space:
mode:
authorJohn Keiser <john@johnkeiser.com>2015-05-12 21:14:29 -0700
committerJohn Keiser <john@johnkeiser.com>2015-05-13 13:43:15 -0700
commitb6336c9de74095cc087463d5c6a3b28aac44e688 (patch)
tree5ddd250a8a3b20218a9d535376312437d4d5b033 /DOC_CHANGES.md
parent90285d129fabb82af097829a9bd92785a45f10c9 (diff)
downloadchef-b6336c9de74095cc087463d5c6a3b28aac44e688.tar.gz
Clarify doc changes per @lamont-granquist's suggestions
Diffstat (limited to 'DOC_CHANGES.md')
-rw-r--r--DOC_CHANGES.md13
1 files changed, 4 insertions, 9 deletions
diff --git a/DOC_CHANGES.md b/DOC_CHANGES.md
index b9602909d1..31ea79f3d9 100644
--- a/DOC_CHANGES.md
+++ b/DOC_CHANGES.md
@@ -19,18 +19,13 @@ module MyModule
end
```
-Users are encouraged to declare resources in their own namespaces instead of putting them in the special `Chef::Resource` namespace.
+Authors of HWRPs need to be aware that in the future all resources and providers will be required to include a provides line. Starting with Chef 12.4.0 any HWRPs in the `Chef::Resource` or `Chef::Provider` namespaces that do not have provides lines will trigger deprecation warning messages when called. The LWRPBase code does `provides` automatically so LWRP authors and users who write classes that inherit from LWRPBase do not need to explicitly include provides lines.
-The `Chef::Resource` namespace will no longer get automatic DSL in a future Chef, and will emit a deprecation warning in Chef 12.
+Users are encouraged to declare resources in their own namespaces instead of putting them in the special `Chef::Resource` namespace.
-### LWRPs are no longer placed in the `Chef::Resource` namespace
+### LWRPs are no longer automatically placed in the `Chef::Resource` namespace
-Additionally, resources declared as LWRPs are no longer placed in the
-`Chef::Resource` namespace. This means that if your cookbook includes the LWRP
-`mycookbook/resources/myresource.rb`, you will no longer be able to extend or
-reference `Chef::Resource::MycookbookMyresource` in Ruby code. LWRP recipe DSL
-does not change: the LWRP will still be available to recipes as
-`mycookbook_myresource`.
+Starting with Chef 12.4.0, accessing an LWRP class by name from the `Chef::Resource` namespace will trigger a deprecation warning message. This means that if your cookbook includes the LWRP `mycookbook/resources/myresource.rb`, you will no longer be able to extend or reference `Chef::Resource::MycookbookMyresource` in Ruby code. LWRP recipe DSL does not change: the LWRP will still be available to recipes as `mycookbook_myresource`.
You can still get the LWRP class by calling `Chef::Resource.resource_matching_short_name(:mycookbook_myresource)`.