summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark McLoughlin <markmc@redhat.com>2014-07-08 18:56:27 +0100
committerMark McLoughlin <markmc@redhat.com>2014-07-08 18:57:41 +0100
commit35c28108a3f5680f942d4ba81531898c9cd214f8 (patch)
tree7f7cde8e17707ac12dea11e1bb52df1a6825eb96
parentb7b63bb71ef1dd4e92d21fd1d79d355725170735 (diff)
downloadoslo-config-35c28108a3f5680f942d4ba81531898c9cd214f8.tar.gz
Add release notes for 1.3.0 and 1.4.0.0a1/2
We appear to have stopped doing these since the 1.2.0 release, but I like to do them because it helps highlight new APIs, behavior changes, important bug fixes, new dependencies and also allows us to credit the contibutors in a nice and friendly way. Change-Id: I7dd6641a840dee0082c6c9e9216184f385869519
-rw-r--r--doc/source/index.rst188
1 files changed, 187 insertions, 1 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 9116e42..5e37886 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -25,6 +25,177 @@ Contents
Release Notes
=============
+1.4.0.0a2
+---------
+
+Dependency changes:
+
+* netaddr (0.7.6) is required.
+* stevedore (0.14) is required.
+
+New features/APIs:
+
+* A new oslo-config-generator_ utility for generating sample
+ configuration files.
+* A ConfigFilter_ wrapper class to allow controlling the visibilty of
+ private configuration options.
+* 1284684_: Add new cfg.IPOpt type.
+
+Bugfixes:
+
+* Add CLI option support to config fixture.
+
+Cleanups:
+
+* Replaced 'e.g.' with 'for example'.
+* Fix confusing logic in _Namespace._get_cli_value().
+
+Docs:
+
+* Fix typos some method parameter docs.
+
+.. _oslo-config-generator: http://docs.openstack.org/developer/oslo.config/generator.html
+.. _ConfigFilter: http://docs.openstack.org/developer/oslo.config/cfgfilter.html
+.. _1284684: https://code.launchpad.net/bugs/1284684
+
+Thanks to Christian Berendt, David Stanek, Jakub Libosvar, liu-sheng
+and Mark McLoughlin for their contributions to this release.
+
+1.4.0.0a1
+---------
+
+Dependency changes:
+
+* Newer six (1.7.0, previously 1.5.2)
+* Newer hacking (0.9.1, previously 0.8.0)
+* Newer versions of oslo.sphinx 1.2.x are supported.
+
+New features/APIs:
+
+* New `test fixture`_ for configuration options.
+
+Bug fixes:
+
+* Add warning about interpolating values from groups
+* 1284969_: Reject option names prefixed with '_'
+* 1284969_: Avoid using too generic names in _Namespace.
+* 1283960_: Fix deprecated_opts for cli options
+* 1329478_: Fix an issue with validating max integer values.
+
+Cleanups:
+
+* 1321274_: Log string format arguments changed to function parameters.
+* 1331449_: Remove print statement from types.Dict
+
+Python 3:
+
+* Fix test_version on Python 3.4
+
+Tests:
+
+* 1279973_: Add test case for hyphenated option names.
+* Add more tests for positional CLI opts.
+* Import run_cross_tests.sh from oslo-incubator.
+* Move py33 env before py2x
+
+Docs:
+
+* Add section titles and fix markup of docstring.
+* Add a doc sample for how to use the required field
+* Fix docstring for _Namespace._get_cli_value
+
+.. _test fixture: http://docs.openstack.org/developer/oslo.config/generator.html
+.. _1279973: https://code.launchpad.net/bugs/1279973
+.. _1283960: https://code.launchpad.net/bugs/1283960
+.. _1284969: https://code.launchpad.net/bugs/1284969
+.. _1321274: https://code.launchpad.net/bugs/1321274
+.. _1329478: https://code.launchpad.net/bugs/1329478
+.. _1331449: https://code.launchpad.net/bugs/1331449
+
+Thanks to Ben Nemec, Christian Berendt, Cyril Roelandt,
+Davanum Srinivas, David Stanek, Doug Hellmann, Mark McLoughlin,
+Matthew Treinish, Radomir Dopieralski and YAMAMOTO Takashi for their
+contributions to this release.
+
+1.3.0
+-----
+
+Dependency changes:
+
+* Newer six (1.5.2, previously unspecified version)
+* Newer hacking (0.8.0, previously 0.5.6)
+* oslotest (unspecified) and mock (1.0) are now required
+* Newer testtools (0.9.34, was 0.9.32), testrepository (0.0.18)
+ and python-subunit (0.0.18)
+* sphinx 1.2 or later is not supported
+* oslo.sphinx has been renamed to oslosphinx
+
+New features/APIs:
+
+* Support for `custom option types`_.
+* 1262148_: Added support of operator '==' to cfg.Opt.
+* Add the ability to validate default options value.
+
+Bugfixes:
+
+* 1282250_: Do substitution on overrides and defaults too.
+* 1255354_: Throw exception if --config-dir doesn't exist.
+* 1259729_: Fix for parsing error with Dollar Sign ($) in values.
+* 1244674_: Fix to make ConfigOpts no longer obscure IOErrors
+
+Python 3:
+
+* Support building wheels (PEP-427).
+
+Docs:
+
+* Fix docstring of parsing order.
+* 1277168_: Switch over to oslosphinx.
+* Add Style Guide for help of config options
+
+Tests:
+
+* Convert to oslo.test.
+
+Cleanups:
+
+* Include the 'meta' trove classifiers for python versions.
+* Follow style guide for help strings.
+* Add py33 trove classifier.
+* Fix a whitespace in a comment.
+* 1229324_: Remove extraneous vim configuration comments.
+* 1257295_: Fix some misspellings.
+* 1262424_: Remove copyright from empty files.
+* Fix spelling errors in docstrings and comments.
+* Utilizes assertIsNone and assertIsNotNone.
+* Replace assertEquals with assertEqual.
+
+.. _`custom option types`: http://docs.openstack.org/developer/oslo.config/types.html
+.. _1229324: https://code.launchpad.net/bugs/1229324
+.. _1244674: https://code.launchpad.net/bugs/1244674
+.. _1255354: https://code.launchpad.net/bugs/1255354
+.. _1257295: https://code.launchpad.net/bugs/1257295
+.. _1259729: https://code.launchpad.net/bugs/1259729
+.. _1262148: https://code.launchpad.net/bugs/1262148
+.. _1262424: https://code.launchpad.net/bugs/1262424
+.. _1277168: https://code.launchpad.net/bugs/1277168
+.. _1282250: https://code.launchpad.net/bugs/1282250
+
+Thanks to Alex Gaynor, Andreas Jaeger, Ben Nemec, Davanum Srinivas,
+Dirk Mueller, Doug Hellmann, Eric Guo, Jay S. Bryant, Jonathan LaCour,
+Julien Danjou, Lars Butler, Lianhao Lu, llg8212, Maxim Kulkin, Sascha
+Peilicke, Shane Wang, skudriashev, YAMAMOTO Takashi and Zhongyue Luo
+for their contributions to this release.
+
+1.2.1
+-----
+
+bf70519 Fix subparsers add_parser() regression
+3d59667 Expand DeprecatedOpt documentation
+
+Thanks to Ian Wienand and Mark McLoughlin for their contributions to
+this relase.
+
1.2.0
-----
@@ -36,6 +207,9 @@ Release Notes
.. _1223667: https://bugs.launchpad.net/oslo/+bug/1223667
.. _1228995: https://bugs.launchpad.net/oslo/+bug/1228995
+Thanks to Julien Danjou, Mark McLoughlin and Zhongyue Luo for their
+contributions to this release.
+
1.2.0a4
-------
@@ -48,7 +222,11 @@ Release Notes
.. _41865: https://review.openstack.org/41865
.. _1196601: https://bugs.launchpad.net/oslo/+bug/1196601
-.. _docs.openstack.org: http://docs.openstack.org/developer/oslo.config/
+.. _docs.openstack.org: http://docs.openstack.org/developer/oslo.config/
+
+Thanks to Davanum Srinivas, Doug Hellmann, Flavio Percoco, Julien
+Danjou, Luis A. Garcia, Mark McLoughlin, Sergey Lukjanov and Zhongyue
+Luo for their contributions to this release.
1.2.0a3
-------
@@ -69,6 +247,10 @@ Release Notes
.. _1194742: https://bugs.launchpad.net/oslo/+bug/1194742
.. _1185959: https://bugs.launchpad.net/oslo/+bug/1185959
+Thanks to Chuck Short, Davanum Srinivas, Dirk Mueller, Fengqian.Gao,
+Mark McLoughlin, Monty Taylor, Sergey Lukjanov and Zhongyue Luo for
+their contributions to this release.
+
1.2.0a2
-------
@@ -90,6 +272,10 @@ Release Notes
.. _testr: https://wiki.openstack.org/wiki/Testr
.. _hacking: https://pypi.python.org/pypi/hacking
+Thanks to Chuck Short, Davanum Srinivas, Dirk Mueller, James E. Blair,
+Mark McLoughlin, Monty Taylor, Steven Deaton and Zhongyue Luo for
+their contributions to this release.
+
1.1.1
-----