Fix nits in choices documentation

As noted in [1].

[1] https://review.openstack.org/#/c/530924/

Change-Id: Icbc82caf690c8708d6487ff11c0e925e3409ff68
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
This commit is contained in:
Stephen Finucane 2018-10-05 17:51:12 +01:00 committed by Eric Fried
parent a53a29ccf0
commit a755fd551f
5 changed files with 19 additions and 22 deletions

View File

@ -74,12 +74,12 @@ Possible values:
"""),
cfg.ListOpt('vendordata_providers',
item_type=cfg.types.String(choices=[
('StaticJSON', 'Loads a JSON file from the path configured by '
'``[DEFAULT] vendordata_jsonfile_path`` and use this as the '
'source for ``vendora_data.json`` and ``vendor_data2.json``.'),
('StaticJSON', 'Load a JSON file from the path configured by '
'``vendordata_jsonfile_path`` and use this as the source for '
'``vendora_data.json`` and ``vendor_data2.json``.'),
('DynamicJSON', 'Build a JSON file using values defined in '
'``vendordata_dynamic_targets``, which is documented separately '
'and uses this as the source for ``vendor_data2.json``.'),
'``vendordata_dynamic_targets`` and use this as the source '
'for ``vendor_data2.json``.'),
]),
default=['StaticJSON'],
deprecated_group="DEFAULT",
@ -264,15 +264,15 @@ small subset of those cells, this should be True.
cfg.StrOpt("instance_list_cells_batch_strategy",
default="distributed",
choices=[
("distributed", "``distributed`` will attempt to divide the "
("distributed", "Divide the "
"limit requested by the user by the number of cells in the "
"system. This requires counting the cells in the system "
"initially, which will not be refreshed until service restart "
"or SIGHUP. The actual batch size will be increased by 10% "
"over the result of ($limit / $num_cells)."),
("fixed", "``fixed`` will simply request fixed-size batches from "
"each cell, as defined by ``instance_list_cells_batch_fixed_"
"size``. If the limit is smaller than the batch size, the limit "
("fixed", "Request fixed-size batches from each cell, as defined "
"by ``instance_list_cells_batch_fixed_size``. "
"If the limit is smaller than the batch size, the limit "
"will be used instead. If you do not wish batching to be used "
"at all, setting the fixed size equal to the ``max_limit`` "
"value will cause only one request per cell database to be "

View File

@ -15,6 +15,11 @@
from oslo_config import cfg
config_drive_opts = [
# TODO(stephenfin): We should deprecate this, given that it was originally
# added to workaround [1] which was fixed in libvirt v1.2.17 [2]
#
# [1] https://bugs.launchpad.net/nova/+bug/1246201
# [2] https://bugzilla.redhat.com/show_bug.cgi?id=1203032
cfg.StrOpt('config_drive_format',
default='iso9660',
choices=[
@ -28,10 +33,6 @@ Configuration drive format
Configuration drive format that will contain metadata attached to the
instance when it boots.
Due to a `libvirt bug <https://bugs.launchpad.net/nova/+bug/1246201>`_, you
should use ``vfat`` if you wish to live migrate and are not using shared
storage.
Related options:
* This option is meaningful when one of the following alternatives occur:

View File

@ -112,10 +112,6 @@ use.
The choice of this type must match the underlying virtualization strategy
you have chosen for this host.
Possible values:
* See the predefined set of case-sensitive values.
Related options:
* ``connection_uri``: depends on this
@ -485,7 +481,7 @@ Related options:
' if instance does not shutdown within this window.'),
cfg.StrOpt('cpu_mode',
choices=[
('host-model', 'Clones the host CPU feature flags'),
('host-model', 'Clone the host CPU feature flags'),
('host-passthrough', 'Use the host CPU model exactly'),
('custom', 'Use the CPU model in ``[libvirt]cpu_model``'),
('none', "Don't set a specific CPU model. For instances with "
@ -869,7 +865,7 @@ libvirt_lvm_opts = [
default='zero',
choices=[
('zero', 'Overwrite volumes with zeroes'),
('shred', 'Overwrite volume repeatedly'),
('shred', 'Overwrite volumes repeatedly'),
('none', 'Do not wipe deleted volumes'),
],
help="""

View File

@ -31,11 +31,11 @@ ALL_OPTS = [
'notify_on_state_change',
choices=[
(None, 'no notifications'),
('vm_state', 'notifications are sent with VM state transition '
('vm_state', 'Notifications are sent with VM state transition '
'information in the ``old_state`` and ``state`` fields. The '
'``old_task_state`` and ``new_task_state`` fields will be set to '
'the current task_state of the instance'),
('vm_and_task_state', 'notifications are sent with VM and task '
('vm_and_task_state', 'Notifications are sent with VM and task '
'state transition information'),
],
deprecated_group='DEFAULT',

View File

@ -441,7 +441,7 @@ GlanceStore.
'when the host\'s SR type is file system based e.g. ext, nfs.'),
('vdi_local_dev', 'This plugin implements an image handler which '
'attaches the instance\'s VDI as a local disk to the VM where '
'the OpenStack Compute service runs in. It uploads the raw disk '
'the OpenStack Compute service runs. It uploads the raw disk '
'to glance when creating image; when booting an instance from a '
'glance image, it downloads the image and streams it into the '
'disk which is attached to the compute VM.'),