diff options
| author | Claire McQuin <claire@getchef.com> | 2015-07-17 15:51:05 -0700 |
|---|---|---|
| committer | Claire McQuin <claire@getchef.com> | 2015-07-21 09:47:50 -0700 |
| commit | 5deb38b14396e3b6d498f460888f20310938f1d3 (patch) | |
| tree | 266c39fc22c716147e8a46147a8223cb3d97bfff | |
| parent | 68506520e8962ae685a551bfb3594272c68d31f0 (diff) | |
| download | ohai-mcquin/ohai-config/deprecate-config.tar.gz | |
Update CHANGELOG and DOC_CHANGES for config deprecation.mcquin/ohai-config/deprecate-config
| -rw-r--r-- | CHANGELOG.md | 2 | ||||
| -rw-r--r-- | DOC_CHANGES.md | 13 |
2 files changed, 15 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 73c010bf..2bf6d901 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,8 @@ Detect Parallels host and guest virtualisation * [**Phil Dibowitz**](https://github.com/jymzh): Fix Darwin filesystem plugin on newer MacOSX +* [**Claire McQuin**](https://github.com/mcquin): + Deprecate Ohai::Config in favor of Ohai::Config.ohai. ## Release 8.5.0 diff --git a/DOC_CHANGES.md b/DOC_CHANGES.md index c473f9d3..7b832d75 100644 --- a/DOC_CHANGES.md +++ b/DOC_CHANGES.md @@ -7,3 +7,16 @@ Description of the required change. --> # Ohai Doc Changes: + +## Ohai::Config[:configurable] is deprecated, use Ohai::Config.ohai +`Ohai::Config` is deprecated in favor of `Ohai::Config.ohai`. Configuring ohai +using `Ohai::Config` is deprecated and will be removed in future releases of +ohai. + +The [Ohai Settings](https://docs.chef.io/config_rb_client.html#ohai-settings) +subsection of the `client.rb` documentation should be updated to use +`ohai.option` instead of `Ohai::Config[:option]`. + +If there is any mention of the ability to access configuration options via +`Ohai::Config`, it should be updated to `Ohai::Config.ohai`. Additionally, it +should be mentioned that `Ohai.config` is an alias for `Ohai::Config.ohai`. |