mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-09-13 09:49:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

wic: beautify 'wic help'

Browse Source 
The Wic help returned to the user is unreadable.

Use a custom ArgumentParser to override argparse help message.

change help message as suggest in
https://bugzilla.yoctoproject.org/show_bug.cgi?id=12205
[YOCTO #12205]

changes applies to 'wic help', 'wic -h', 'wic --h' and 'wic --help'

(From OE-Core rev: d29d553cc096f4e1208c44dc595e1cf365c3dff3)

Signed-off-by: Chee Yang Lee <chee.yang.lee@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Chee Yang Lee
2019-11-08 11:41:19 +08:00
committed by Richard Purdie
parent 70573f66ec
commit 621b10f007
2 changed files with 61 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
scripts/lib/wic/help.py
View File

@@ -1046,3 +1046,59 @@ NAME
DESCRIPTION
Specify a help topic to display it. Topics are shown above.
"""
wic_help = """
Creates a customized OpenEmbedded image.
Usage: wic [--version]
wic help [COMMAND or TOPIC]
wic COMMAND [ARGS]
usage 1: Returns the current version of Wic
usage 2: Returns detailed help for a COMMAND or TOPIC
usage 3: Executes COMMAND
COMMAND:
list - List available canned images and source plugins
ls - List contents of partitioned image or partition
rm - Remove files or directories from the vfat or ext* partitions
help - Show help for a wic COMMAND or TOPIC
write - Write an image to a device
cp - Copy files and directories to the vfat or ext* partitions
create - Create a new OpenEmbedded image
TOPIC:
overview - Presents an overall overview of Wic
plugins - Presents an overview and API for Wic plugins
kickstart - Presents a Wic kicstart file reference
Examples:
$ wic --version
Returns the current version of Wic
$ wic help cp
Returns the SYNOPSIS and DESCRIPTION for the Wic "cp" command.
$ wic list images
Returns the list of canned images (i.e. *.wks files located in
the /scripts/lib/wic/canned-wks directory.
$ wic create mkefidisk -e core-image-minimal
Creates an EFI disk image from artifacts used in a previous
core-image-minimal build in standard BitBake locations
(e.g. Cooked Mode).
"""