openstack/nova
Code Issues Proposed changes

docs: Correct 'nova-manage db sync' documentation

Browse Source 
In change I3fd9fe0317bcd1a59c366e60154b095e8df92327, we deprecated the
'--version' option in favour of a 'VERSION' positional. This was later
removed in change I7795e308497de66329f288b43ecfbf978d67ad75. Update the
docs to reflect this. 'nova-manage api_db sync' were already corrected
in change Ibc49f93b8bd51d9a050acde5ef3dc8aad91321ca and does not need
the same fix, though a minor tweak is included.

Change-Id: I2c0fb04fbc3f6d2074596894782ed3143b0c2338
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Closes-Bug: #1840807
This commit is contained in:
Stephen Finucane 2019-08-20 16:59:05 +01:00
parent de0cd7503e
commit 62ca2e7ed2
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/cli/nova-manage.rst
View File

@ -48,9 +48,9 @@ Nova Database
``nova-manage db version`` ``nova-manage db version``
Print the current main database version. Print the current main database version.
``nova-manage db sync [--version <version>] [--local_cell]`` ``nova-manage db sync [--local_cell] [VERSION]``
Upgrade the main database schema up to the most recent version or Upgrade the main database schema up to the most recent version or
``--version`` if specified. By default, this command will also attempt to ``VERSION`` if specified. By default, this command will also attempt to
upgrade the schema for the cell0 database if it is mapped (see the upgrade the schema for the cell0 database if it is mapped (see the
``map_cell0`` or ``simple_cell_setup`` commands for more details on mapping ``map_cell0`` or ``simple_cell_setup`` commands for more details on mapping
the cell0 database). If ``--local_cell`` is specified, then only the main the cell0 database). If ``--local_cell`` is specified, then only the main
@ -222,7 +222,7 @@ Nova API Database
``nova-manage api_db sync [VERSION]`` ``nova-manage api_db sync [VERSION]``
Upgrade the API database schema up to the most recent version or Upgrade the API database schema up to the most recent version or
``[VERSION]`` if specified. This command does not create the API ``VERSION`` if specified. This command does not create the API
database, it runs schema migration scripts. The API database connection is database, it runs schema migration scripts. The API database connection is
determined by :oslo.config:option:`api_database.connection` in the determined by :oslo.config:option:`api_database.connection` in the
configuration file passed to nova-manage. configuration file passed to nova-manage.