summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordanielsdeleo <dan@getchef.com>2014-09-03 12:37:06 -0700
committerdanielsdeleo <dan@getchef.com>2014-09-03 12:44:47 -0700
commit789462db340758a205e19f0339a7b2e7361d11d6 (patch)
tree9e604c4addd201246863e401defbe303a75f00f5
parentb6f52b35e77e733c627455e368a5dd30bc22daf5 (diff)
downloadchef-789462db340758a205e19f0339a7b2e7361d11d6.tar.gz
Update doc files for knife `config.rb` support.
-rw-r--r--CHANGELOG.md2
-rw-r--r--DOC_CHANGES.md13
-rw-r--r--RELEASE_NOTES.md13
3 files changed, 28 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 016bde47f1..c160fae749 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -69,6 +69,8 @@
### Chef Contributions
+* `knife` now prefers to load `config.rb` in preference to `knife.rb`;
+`knife.rb` will be used if `config.rb` is not found.
* Fixed Config[:cache_path] to use path_join()
* Updated chef-zero to 3.0.
* knife cookbook site download/list/search/share/show/unshare now uses
diff --git a/DOC_CHANGES.md b/DOC_CHANGES.md
index 1ef0a7830c..c08ab0097a 100644
--- a/DOC_CHANGES.md
+++ b/DOC_CHANGES.md
@@ -6,6 +6,19 @@ Example Doc Change:
Description of the required change.
-->
+### Knife now prefers to use `config.rb` rather than `knife.rb`
+
+Knife will now look for `config.rb` in preference to `knife.rb` for its
+configuration file. The syntax and configuration options available in
+`config.rb` are identical to `knife.rb`. Also, the search path for
+configuration files is unchanged.
+
+At this time, it is _recommended_ that users use `config.rb` instead of
+`knife.rb`, but `knife.rb` is not deprecated; no warning will be emitted
+when using `knife.rb`. Once third-party application developers have had
+sufficient time to adapt to the change, `knife.rb` will become
+deprecated and config.rb will be preferred.
+
### value_for_platform Method
- where <code>"platform"</code> can be a comma-separated list, each specifying a platform, such as Red Hat, openSUSE, or Fedora, <code>version</code> specifies the version of that platform, and <code>value</code> specifies the value that will be used if the node's platform matches the <code>value_for_platform</code> method. If each value only has a single platform, then the syntax is like the following:
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
index 33e405d273..30c5d0893e 100644
--- a/RELEASE_NOTES.md
+++ b/RELEASE_NOTES.md
@@ -1,5 +1,18 @@
# Chef Client Release Notes 12.0.0:
+## Knife Prefers `config.rb` to `knife.rb`.
+
+Knife will now look for `config.rb` in preference to `knife.rb` for its
+configuration file. The syntax and configuration options available in
+`config.rb` are identical to `knife.rb`. Also, the search path for
+configuration files is unchanged.
+
+At this time, it is _recommended_ that users use `config.rb` instead of
+`knife.rb`, but `knife.rb` is not deprecated; no warning will be emitted
+when using `knife.rb`. Once third-party application developers have had
+sufficient time to adapt to the change, `knife.rb` will become
+deprecated and config.rb will be preferred.
+
## Boostrap Changes
Chef Client 12 introduces a set of changes to `knife bootstrap`. Here is the list of changes: