diff options
Diffstat (limited to 'scripts/lib/wic/help.py')
-rw-r--r-- | scripts/lib/wic/help.py | 93 |
1 files changed, 7 insertions, 86 deletions
diff --git a/scripts/lib/wic/help.py b/scripts/lib/wic/help.py index cd2176d151..9a778b69da 100644 --- a/scripts/lib/wic/help.py +++ b/scripts/lib/wic/help.py | |||
@@ -108,7 +108,7 @@ wic_usage = """ | |||
108 | Current 'wic' commands are: | 108 | Current 'wic' commands are: |
109 | help Show help for command or one of the topics (see below) | 109 | help Show help for command or one of the topics (see below) |
110 | create Create a new OpenEmbedded image | 110 | create Create a new OpenEmbedded image |
111 | list List available values for options and image properties | 111 | list List available canned images and source plugins |
112 | 112 | ||
113 | Help topics: | 113 | Help topics: |
114 | overview wic overview - General overview of wic | 114 | overview wic overview - General overview of wic |
@@ -221,27 +221,19 @@ DESCRIPTION | |||
221 | 221 | ||
222 | The -c option is used to specify compressor utility to compress | 222 | The -c option is used to specify compressor utility to compress |
223 | an image. gzip, bzip2 and xz compressors are supported. | 223 | an image. gzip, bzip2 and xz compressors are supported. |
224 | |||
225 | The set of properties available for a given image type can be | ||
226 | listed using the 'wic list' command. | ||
227 | """ | 224 | """ |
228 | 225 | ||
229 | wic_list_usage = """ | 226 | wic_list_usage = """ |
230 | 227 | ||
231 | List available OpenEmbedded image properties and values | 228 | List available OpenEmbedded images and source plugins |
232 | 229 | ||
233 | usage: wic list images | 230 | usage: wic list images |
234 | wic list <image> help | 231 | wic list <image> help |
235 | wic list source-plugins | 232 | wic list source-plugins |
236 | wic list properties | ||
237 | wic list properties <wks file> | ||
238 | wic list property <property> | ||
239 | [-o <JSON PROPERTY FILE> | --outfile <JSON PROPERTY_FILE>] | ||
240 | 233 | ||
241 | This command enumerates the set of available canned images as well as | 234 | This command enumerates the set of available canned images as well as |
242 | help for those images. It also can be used to enumerate the complete | 235 | help for those images. It also can be used to list of available source |
243 | set of possible values for a specified option or property needed by | 236 | plugins. |
244 | the image creation process. | ||
245 | 237 | ||
246 | The first form enumerates all the available 'canned' images. | 238 | The first form enumerates all the available 'canned' images. |
247 | 239 | ||
@@ -251,40 +243,23 @@ wic_list_usage = """ | |||
251 | The third form enumerates all the available --sources (source | 243 | The third form enumerates all the available --sources (source |
252 | plugins). | 244 | plugins). |
253 | 245 | ||
254 | The fourth form enumerates all the possible values that exist and can | ||
255 | be specified in an OE kickstart (wks) file. | ||
256 | |||
257 | The fifth form enumerates all the possible options that exist for the | ||
258 | set of properties specified in a given OE kickstart (ks) file. | ||
259 | |||
260 | The final form enumerates all the possible values that exist and can | ||
261 | be specified for any given OE kickstart (wks) property. | ||
262 | |||
263 | See 'wic help list' for more details. | 246 | See 'wic help list' for more details. |
264 | """ | 247 | """ |
265 | 248 | ||
266 | wic_list_help = """ | 249 | wic_list_help = """ |
267 | 250 | ||
268 | NAME | 251 | NAME |
269 | wic list - List available OpenEmbedded image properties and values | 252 | wic list - List available OpenEmbedded images and source plugins |
270 | 253 | ||
271 | SYNOPSIS | 254 | SYNOPSIS |
272 | wic list images | 255 | wic list images |
273 | wic list <image> help | 256 | wic list <image> help |
274 | wic list source-plugins | 257 | wic list source-plugins |
275 | wic list properties | ||
276 | wic list properties <wks file> | ||
277 | wic list property <property> | ||
278 | [-o <JSON PROPERTY FILE> | --outfile <JSON PROPERTY_FILE>] | ||
279 | 258 | ||
280 | DESCRIPTION | 259 | DESCRIPTION |
281 | This command enumerates the complete set of possible values for a | ||
282 | specified option or property needed by the image creation process. | ||
283 | |||
284 | This command enumerates the set of available canned images as well | 260 | This command enumerates the set of available canned images as well |
285 | as help for those images. It also can be used to enumerate the | 261 | as help for those images. It also can be used to list available |
286 | complete set of possible values for a specified option or property | 262 | source plugins. |
287 | needed by the image creation process. | ||
288 | 263 | ||
289 | The first form enumerates all the available 'canned' images. | 264 | The first form enumerates all the available 'canned' images. |
290 | These are actually just the set of .wks files that have been moved | 265 | These are actually just the set of .wks files that have been moved |
@@ -301,60 +276,6 @@ DESCRIPTION | |||
301 | sources listed by the 'list source-plugins' command. Users can | 276 | sources listed by the 'list source-plugins' command. Users can |
302 | also add their own source plugins - see 'wic help plugins' for | 277 | also add their own source plugins - see 'wic help plugins' for |
303 | details. | 278 | details. |
304 | |||
305 | The third form enumerates all the possible values that exist and | ||
306 | can be specified in a OE kickstart (wks) file. The output of this | ||
307 | can be used by the third form to print the description and | ||
308 | possible values of a specific property. | ||
309 | |||
310 | The fourth form enumerates all the possible options that exist for | ||
311 | the set of properties specified in a given OE kickstart (wks) | ||
312 | file. If the -o option is specified, the list of properties, in | ||
313 | addition to being displayed, will be written to the specified file | ||
314 | as a JSON object. In this case, the object will consist of the | ||
315 | set of name:value pairs corresponding to the (possibly nested) | ||
316 | dictionary of properties defined by the input statements used by | ||
317 | the image. Some example output for the 'list <wks file>' command: | ||
318 | |||
319 | $ wic list test.ks | ||
320 | "part" : { | ||
321 | "mountpoint" : "/" | ||
322 | "fstype" : "ext3" | ||
323 | } | ||
324 | "part" : { | ||
325 | "mountpoint" : "/home" | ||
326 | "fstype" : "ext3" | ||
327 | "offset" : "10000" | ||
328 | } | ||
329 | "bootloader" : { | ||
330 | "type" : "efi" | ||
331 | } | ||
332 | . | ||
333 | . | ||
334 | . | ||
335 | |||
336 | Each entry in the output consists of the name of the input element | ||
337 | e.g. "part", followed by the properties defined for that | ||
338 | element enclosed in braces. This information should provide | ||
339 | sufficient information to create a complete user interface with. | ||
340 | |||
341 | The final form enumerates all the possible values that exist and | ||
342 | can be specified for any given OE kickstart (wks) property. If | ||
343 | the -o option is specified, the list of values for the given | ||
344 | property, in addition to being displayed, will be written to the | ||
345 | specified file as a JSON object. In this case, the object will | ||
346 | consist of the set of name:value pairs corresponding to the array | ||
347 | of property values associated with the property. | ||
348 | |||
349 | $ wic list property part | ||
350 | ["mountpoint", "where the partition should be mounted"] | ||
351 | ["fstype", "filesytem type of the partition"] | ||
352 | ["ext3"] | ||
353 | ["ext4"] | ||
354 | ["btrfs"] | ||
355 | ["swap"] | ||
356 | ["offset", "offset of the partition within the image"] | ||
357 | |||
358 | """ | 279 | """ |
359 | 280 | ||
360 | wic_plugins_help = """ | 281 | wic_plugins_help = """ |