openstack/cinder
Code Issues Proposed changes

Fix cinder-manage args --max_count in docs

Browse Source 
--max_count was added in [0]

[0] https://review.openstack.org/#/c/330391/

Change-Id: If3780b4ec799ff244f02182b636a7afe4037445b
This commit is contained in:
Xing Zhang 2019-04-12 12:15:07 +08:00
parent 8c9a2fa272
commit 5ead630429
No known key found for this signature in database
GPG Key ID: 43F80E57B910E3B0
4 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cinder/cmd/manage.py
View File

@ -381,7 +381,7 @@ class DbCommands(object):
if max_count is not None: if max_count is not None:
unlimited = False unlimited = False
if max_count < 1: if max_count < 1:
print(_('Must supply a positive value for max_number.')) print(_('Must supply a positive value for max_count.'))
sys.exit(127) sys.exit(127)
else: else:
unlimited = True unlimited = True

2
cinder/tests/unit/test_cmd.py
View File

@ -503,7 +503,7 @@ Running batches of 50 until complete.
command.online_data_migrations, max_count=50) command.online_data_migrations, max_count=50)
self.assertEqual(2, exit.code) self.assertEqual(2, exit.code)
# When --max-count is not used, we should get 2 if all possible # When --max_count is not used, we should get 2 if all possible
# migrations completed but some raise exceptions # migrations completed but some raise exceptions
good_remaining = [50] good_remaining = [50]
exit = self.assertRaises(SystemExit, exit = self.assertRaises(SystemExit,

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

@ -73,7 +73,7 @@ version Database version
Purge database entries that are marked as deleted, that are older than the Purge database entries that are marked as deleted, that are older than the
number of days specified. number of days specified.
``cinder-manage db online_data_migrations [--max-count <n>]`` ``cinder-manage db online_data_migrations [--max_count <n>]``
Perform online data migrations for database upgrade between releases in Perform online data migrations for database upgrade between releases in
batches. batches.
@ -82,12 +82,12 @@ This command interprets the following options when it is invoked:
.. code-block:: console .. code-block:: console
--max-count Maximum number of objects to migrate. If not specified, all --max_count Maximum number of objects to migrate. If not specified, all
possible migrations will be completed, in batches of 50 at a possible migrations will be completed, in batches of 50 at a
time. time.
Returns exit status 0 if no (further) updates are possible, 1 if the Returns exit status 0 if no (further) updates are possible, 1 if the
``--max-count`` option was used and some updates were completed successfully ``--max_count`` option was used and some updates were completed successfully
(even if others generated errors), 2 if some updates generated errors and no (even if others generated errors), 2 if some updates generated errors and no
other migrations were able to take effect in the last batch attempted, or 127 other migrations were able to take effect in the last batch attempted, or 127
if invalid input is provided (e.g. non-numeric max-count). if invalid input is provided (e.g. non-numeric max-count).

2
doc/source/upgrade.rst
View File

@ -239,7 +239,7 @@ After maintenance window
* Since Ocata, you also need to run ``cinder-manage db online_data_migrations`` * Since Ocata, you also need to run ``cinder-manage db online_data_migrations``
command to make sure data migrations are applied. The tool lets you limit command to make sure data migrations are applied. The tool lets you limit
the impact of the data migrations by using ``--max-count`` option to limit the impact of the data migrations by using ``--max_count`` option to limit
number of migrations executed in one run. If this option is used, the number of migrations executed in one run. If this option is used, the
exit status will be 1 if any migrations were successful (even if others exit status will be 1 if any migrations were successful (even if others
generated errors, which could be due to dependencies between migrations). generated errors, which could be due to dependencies between migrations).