openstack/python-novaclient
Code Issues Proposed changes

Update nova boot help

Browse Source 
Actual help string for --block-device flag is not clear.
User doesn't know which parameters are required and which are not.
Change improves description of each parameter, so that user can
understand how the --block-device works.

Change-Id: If23cb2d64adb51dfb45e48511ca25988bc43b739
Implements: nova boot --block-device usage unclear
Partial-Bug: #1323775
This commit is contained in:
Pawel Koniszewski 2014-07-10 15:15:40 +02:00
parent 39d1d0156b
commit a06a6abca7
1 changed files with 17 additions and 8 deletions

25
novaclient/v1_1/shell.py

@ -394,16 +394,25 @@ def _boot(cs, args):
action='append',
default=[],
help=_("Block device mapping with the keys: "
"id=image_id, snapshot_id or volume_id, "
"id=UUID (image_id, snapshot_id or volume_id only if using source "
"image, snapshot or volume) "
"source=source type (image, snapshot, volume or blank), "
"dest=destination type of the block device (volume or local), "
"bus=device's bus, "
"device=name of the device (e.g. vda, xda, ...), "
"size=size of the block device in GB, "
"format=device will be formatted (e.g. swap, ext3, ntfs, ...), "
"bootindex=integer used for ordering the boot disks, "
"type=device type (e.g. disk, cdrom, ...) and "
"shutdown=shutdown behaviour (either preserve or remove)."))
"bus=device's bus (e.g. uml, lxc, virtio, ...; if omitted, "
"hypervisor driver chooses a suitable default, "
"honoured only if device type is supplied) "
"type=device type (e.g. disk, cdrom, ...; defaults to 'disk') "
"device=name of the device (e.g. vda, xda, ...; "
"if omitted, hypervisor driver chooses suitable device "
"depending on selected bus), "
"size=size of the block device in GB (if omitted, "
"hypervisor driver calculates size), "
"format=device will be formatted (e.g. swap, ntfs, ...; optional), "
"bootindex=integer used for ordering the boot disks "
"(for image backed instances it is equal to 0, "
"for others need to be specified) and "
"shutdown=shutdown behaviour (either preserve or remove, "
"for local destination set to remove)."))
@utils.arg('--swap',
metavar="<swap_size>",
default=None,