nova/releasenotes/notes/reworked-nova-manage-db-commands-b958b0a41a4004a6.yaml
Stephen Finucane 59dd49978c nova-manage: Deprecate '--version' parameters
Both the 'api_db' and 'db' categories / commands define a 'sync'
(sub)command which takes an optional '--version' parameter. We want to
start using 'cliff' in Queens, but that framework does not support
command-level parameters with the exception of '--help' [1]. If you
think of something like the 'ls' command, you can run it without any
arguments and assume a default of the current directory, or you can
specify the argument. In the same way, these commands should really be
using optional parameters instead of positional arguments. We do this
and add aliases for the older parameters to ease with the transition.
These aliases are deprecated, raise warnings and will be removed in the
move to cliff.

[1] https://bugs.launchpad.net/python-cliff/+bug/1619708

Change-Id: I3fd9fe0317bcd1a59c366e60154b095e8df92327
Partially-Implements: bp move-nova-cmds-to-cliff
2017-08-03 19:43:29 +01:00

21 lines
676 B
YAML

---
upgrade:
- |
The ``nova-manage api_db sync`` and ``nova-manage db sync`` commands
previously took an optional ``--version`` parameter to determine which
version to sync to. For example::
$ nova-manage api_db sync --version some-version
This is now an optional positional argument. For example::
$ nova-manage api_db sync some-version
Aliases are provided but these are marked as deprecated and will be removed
in the next release of nova.
deprecations:
- |
The ``--version`` parameters of the ``nova-manage api_db sync`` and
``nova-manage db sync`` commands has been deprecated in favor of
positional arguments.