diff options
author | Chee Yang Lee <chee.yang.lee@intel.com> | 2019-11-08 11:41:19 +0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2019-11-14 13:20:59 +0000 |
commit | 621b10f0075bc5d499a2151661c6e1a414f12953 (patch) | |
tree | 48e42f143e81d824112a77e42ae99d9b016b8ed4 /scripts/lib | |
parent | 70573f66ecf7b591f2d1329dcd4267c9d71ca6ce (diff) | |
download | poky-621b10f0075bc5d499a2151661c6e1a414f12953.tar.gz |
wic: beautify 'wic help'
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>
Diffstat (limited to 'scripts/lib')
-rw-r--r-- | scripts/lib/wic/help.py | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/scripts/lib/wic/help.py b/scripts/lib/wic/help.py index af7d0576e2..968cc0ed6f 100644 --- a/scripts/lib/wic/help.py +++ b/scripts/lib/wic/help.py | |||
@@ -1046,3 +1046,59 @@ NAME | |||
1046 | DESCRIPTION | 1046 | DESCRIPTION |
1047 | Specify a help topic to display it. Topics are shown above. | 1047 | Specify a help topic to display it. Topics are shown above. |
1048 | """ | 1048 | """ |
1049 | |||
1050 | |||
1051 | wic_help = """ | ||
1052 | Creates a customized OpenEmbedded image. | ||
1053 | |||
1054 | Usage: wic [--version] | ||
1055 | wic help [COMMAND or TOPIC] | ||
1056 | wic COMMAND [ARGS] | ||
1057 | |||
1058 | usage 1: Returns the current version of Wic | ||
1059 | usage 2: Returns detailed help for a COMMAND or TOPIC | ||
1060 | usage 3: Executes COMMAND | ||
1061 | |||
1062 | |||
1063 | COMMAND: | ||
1064 | |||
1065 | list - List available canned images and source plugins | ||
1066 | ls - List contents of partitioned image or partition | ||
1067 | rm - Remove files or directories from the vfat or ext* partitions | ||
1068 | help - Show help for a wic COMMAND or TOPIC | ||
1069 | write - Write an image to a device | ||
1070 | cp - Copy files and directories to the vfat or ext* partitions | ||
1071 | create - Create a new OpenEmbedded image | ||
1072 | |||
1073 | |||
1074 | TOPIC: | ||
1075 | overview - Presents an overall overview of Wic | ||
1076 | plugins - Presents an overview and API for Wic plugins | ||
1077 | kickstart - Presents a Wic kicstart file reference | ||
1078 | |||
1079 | |||
1080 | Examples: | ||
1081 | |||
1082 | $ wic --version | ||
1083 | |||
1084 | Returns the current version of Wic | ||
1085 | |||
1086 | |||
1087 | $ wic help cp | ||
1088 | |||
1089 | Returns the SYNOPSIS and DESCRIPTION for the Wic "cp" command. | ||
1090 | |||
1091 | |||
1092 | $ wic list images | ||
1093 | |||
1094 | Returns the list of canned images (i.e. *.wks files located in | ||
1095 | the /scripts/lib/wic/canned-wks directory. | ||
1096 | |||
1097 | |||
1098 | $ wic create mkefidisk -e core-image-minimal | ||
1099 | |||
1100 | Creates an EFI disk image from artifacts used in a previous | ||
1101 | core-image-minimal build in standard BitBake locations | ||
1102 | (e.g. Cooked Mode). | ||
1103 | |||
1104 | """ | ||