summaryrefslogtreecommitdiffstats
path: root/scripts/lib/image/help.py
Commit message (Collapse)AuthorAgeFilesLines
* wic: get rid of scripts/lib/imageEd Bartosh2015-09-031-826/+0
| | | | | | | | | | | Moved content of scripts/lib/image/ to scripts/lib/wic as one directory with the same name as a tool is self-explanatory and less confusing than two. (From OE-Core rev: 5dc02d572794298b3362378cea3d7da654456c44) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: deferred call of hlp.get_wic_plugins_help()Ed Bartosh2015-08-301-0/+2
| | | | | | | | | | | | | | | | | | If get_wic_plugins_help is called from wic main module it calls git_bitbake_var at some point. This fails when wic is called from bitbake as 'bitbake -e' can't be run. Moved call of this method to help.py in order to call it later, when BitbakeVariables singleton is properly initialized to get variables from .env files. (From OE-Core rev: d401a8518fb4b0e8adeb34be8948fa780299870c) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: rename variableEd Bartosh2015-08-301-2/+2
| | | | | | | | | | | | Renamed variable help -> hlp as 'help' is a name of Python built-in function. (From OE-Core rev: 94c85fdaec36bfda509be4a66082a0156bf76695) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Improve 'wic help overview' contentEd Bartosh2015-08-091-9/+24
| | | | | | | | | | | | | | | Included full console output and example of the .wks file into the 'wic help overview' content. Used qemux86-64 machine instead of crownbay to make example working without cloning additional layers. [YOCTO #7940] (From OE-Core rev: 68d391eaf4fe9fc37e3278255d5da170f98b8763) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: improved usage textEd Bartosh2015-08-091-7/+5
| | | | | | | | | | | | Made command line specification less confusing. Reformatted usage output. [YOCTO #7938] (From OE-Core rev: c4a44ad4c5aa65657b69b811e793f98418159348) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Add --uuid partition optionEd Bartosh2015-07-021-0/+5
| | | | | | | | | | | | Added --uuid option to the configuration of wks parser. This option specifies partition UUID. The code to process it is already in place. It was implemented for --use-uuid option. (From OE-Core rev: c7ffe3785e61f3c57aeeebc34ec573685f0ea6a8) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Add --compress-with command line optionEd Bartosh2015-06-271-0/+4
| | | | | | | | | | | | Added -c/--compress-with command line option to 'wic create' subcommand. This option is used to specify compressor utility to compress the image produced by wic. gzip, bzip2 and xz compressors are supported in this implementation. (From OE-Core rev: 8425ef0a67aa5ca7b2dbf4c461004af555aa0c96) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: removed unused command line optionEd Bartosh2015-06-231-7/+0
| | | | | | | | | | | Removed -i/--infile wic command line option. Removed properties_file and properties arguments of wic_create function. (From OE-Core rev: 6b81c89878236b2ef8d8b8217f2e33286b49dab6) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: code cleanup: superfluous-parensEd Bartosh2015-06-231-1/+1
| | | | | | | | | | Removed unncecessary parents after 'if' 'del' and 'print' keywords. Fixed pyling warning: Unnecessary parens after 'xxx' keyword (From OE-Core rev: a64604d11f75973b4c2347fa2669da9889e44013) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Return error code when wic fails to invoke commandEd Bartosh2015-06-231-0/+2
| | | | | | | | | | | | | | | | | Return 1 if command doesn't exist or wic is called without any commmand. Return result of invoke_command as wic return code. Added tests for unsupported command and no command. Fixed typo in test case test02_createhelp spotted by this fix. [YOCTO #7856] (From OE-Core rev: ebd9f7b1da8ed556e98aab4d5f4e81707ac44b27) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Integrated plugin docstrings into 'wic help plugins' outputEd Bartosh2015-06-231-0/+18
| | | | | | | | | | | | | | | Added mechanism to show docstrings of plugin classes as a part of plugins help page. For missing plugins the following warning message is shown: <class '<plugin class spec>'> is missing docstring. [YOCTO #7118] (From OE-Core rev: 0997208266686473d23aed0fab58a1fd7c5d8cae) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Document creation of empty partitionEd Bartosh2015-06-231-0/+4
| | | | | | | | | | | | | Added short explanation of how to create empty pattition to the 'wic help kickstart' output. [YOCTO #7131] (From OE-Core rev: d92cda72ef605bf2f45437667c1fc36c76629d47) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Add help for --part-type and --use-uuid optionsEd Bartosh2015-06-111-0/+9
| | | | | | | | | | | Added help for two wks partition options specific to GUID partition table and globally unique identificators (GUID). (From OE-Core rev: e21e31b48b20bf2f8a7733c52b436a65c27de8aa) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Implement --build-rootfs command line optionEd Bartosh2015-04-091-4/+6
| | | | | | | | | | | -f/--build-rootfs option makes wic to run bitbake <image> to produce rootfs. This option requires image name to be specified with -e/--image-name. (From OE-Core rev: 75ae0b7cf3863eb2857a2b6a7073beea626f751d) Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: allow to configure overhead factor per partitionAlexandre Belloni2015-02-141-0/+6
| | | | | | | | | | | Introduce a new option --overhead-factor to replace IMAGE_OVERHEAD_FACTOR. (From OE-Core rev: 20fe0c7202724187dbe80eb2101d8ef69e86b94e) Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com> Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: allow to configure extra space per partitionAlexandre Belloni2015-02-141-0/+6
| | | | | | | | | | | | Introduce a new option --extra-space instead of using IMAGE_EXTRA_SPACE. This is useful for boot partitions where the extra space is often useless or for huge partition where 10MiB may not be enough. (From OE-Core rev: 9f7fe71a10bcdd1864d2f838f3510e96810ef42e) Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com> Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: allow creation of partitions not in tableAlexandre Belloni2015-02-141-0/+6
| | | | | | | | | | | | | | | | For some architectures it is necessary to reserve space on disk without it being present in the partition table. For example, u-boot on i.mx is placed at an offset of 1kB on the sdcard. While it would be possible to create a partition at that offset and place u-boot there, it would then be necessary to update the default u-boot environment to use partition 2 on the mmc instead of partition 1. (From OE-Core rev: 233b631ece5ee14d057932c146327065064b5196) Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com> Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: use kB for the partitions sizeAlexandre Belloni2015-02-081-4/+4
| | | | | | | | | | | | | | | | | | Use kB instead of MB for the partition size to get a better granularity. This is needed on some SoC (i.mx, omap) where it is necessary to create partitions as small as 64kB. Keep the backward compatibility by assuming MB when no unit is provided. (From OE-Core rev: 3d4da9186016d54b76ad2fa710646de253f0f063) Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com> Tested-by: Maciej Borzecki <maciej.borzecki@open-rnd.pl> Acked-by: Tom Zanussi <tom.zanussi@linux.intel.com> Tested-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Remove special-case bootimg_dirTom Zanussi2014-10-301-1/+1
| | | | | | | | | | | | | | | | | | | | The first iterations of wic very shortsightedly catered to two specific use-cases and added special-purpose params for those cases so that they could be directly given their corresponding boot artifacts. (hdddir and staging_data_dir). As more use-cases are added, it becomes rather obvious that such a scheme doens't scale, and additionally causes confusion for plugin writers. This removes those special cases and states explicitly in the help text that plugins are responsible for locating their own boot artifacts. (From OE-Core rev: 6ba3eb5ff7c47aee6b3419fb3a348a634fe74ac9) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Update the help text to include -D (--debug)Tom Zanussi2014-10-301-6/+15
| | | | | | | | | | The --debug option is missing from the wic help text; this adds it and at the same time rearranges the usage into a more logical arrangement. (From OE-Core rev: cf5144ef241d8f4ccaa3461ae5c9f89c2cf2f8d1) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Rename /mic to /wicTom Zanussi2014-08-111-4/+4
| | | | | | | | | | | | | As well as any other stray instances of mic in the codebase that can be removed. We don't really need to carry around legacy naming, and the history is in git. (From OE-Core rev: 598b120406dc1d2b7e377bd1ab6f0acbef034b22) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Update 'Background and Motivation' help sectionTom Zanussi2014-08-111-13/+1
| | | | | | | | | | | Remove help text regarding the source and future intentions of the wic codebase, since the code prompting those comments has now been mostly removed. (From OE-Core rev: dfa8626700269141f8d2f5be12c8758db7ca6473) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Various typo/grammar fixes to wic help textTom Zanussi2014-08-021-3/+3
| | | | | | | | | | | This is a set of miscellaneous help text updates noticed while transcribing wic help for the dev manual. (From OE-Core rev: d4b350fcdedf29692673e09a0c1850cdbbe29739) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Saul Wold <sgw@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Add squashfs to --fstypes documentationTom Zanussi2014-08-021-0/+1
| | | | | | | | | | squashfs support was recently added to wic, so document it. (From OE-Core rev: c04043e143932fe2ea38f87d2faa8beed007671b) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Saul Wold <sgw@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Add documentation for --fsoptionsTom Zanussi2014-08-021-0/+7
| | | | | | | | | | --fsoptions support was recently added to wic, so document it. (From OE-Core rev: e2d87ad57f8aa74e748ba95f6a801a2ca665ecc4) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Saul Wold <sgw@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Fix plugin help textTom Zanussi2014-08-021-13/+16
| | | | | | | | | | | Fix various typoes and grammar problems noticed while transcribing for the dev manual. (From OE-Core rev: 79fb7d9b5a28810e3adfaf5cba0c2298810253e9) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Saul Wold <sgw@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Add help entry for wic kickstartTom Zanussi2014-07-231-0/+1
| | | | | | | | | | | Previous patches added help for 'wic kickstart' but forgot to add an entry in the main help page showing its availability. Add an entry for it. (From OE-Core rev: 5aa212f990c3d9b90a4f06cea346b82fc5d376ba) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Add kickstart reference to help systemTom Zanussi2014-07-161-0/+114
| | | | | | | | | | | Add a 'wic kickstart' help section to make it easy for users to access the kickstart reference without having to go to an external website. (From OE-Core rev: 136137ec1c124aee89d2120abded60a5cf0562b0) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Saul Wold <sgw@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Add wic overview to help systemTom Zanussi2014-07-161-0/+209
| | | | | | | | | | | Add a general overview of wic to the help system as 'wic overview', along with some introductory examples. (From OE-Core rev: fa108caaa53878152e4856d32ce1ab7fe3802287) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Saul Wold <sgw@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Add general 'plugins' help topicTom Zanussi2014-07-101-1/+100
| | | | | | | | | | | Add a category for help topics with an initial help topic discussing source plugins. (From OE-Core rev: a3dbe46dd28a6fd9e6c21f6bbb6a12578df9dff3) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Saul Wold <sgw@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Add help text for 'wic list source-plugins'Tom Zanussi2014-07-101-3/+17
| | | | | | | | | | | Add both short and long text for the new 'wic list source-plugins' command. (From OE-Core rev: 4f20acc10b18c7353bd73f253943372dacd957ca) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Saul Wold <sgw@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* wic: Initial code for wic (OpenEmbedded Image Creator)Tom Zanussi2013-10-011-0/+311
Initial implementation of the 'wic' command. The 'wic' command generates partitioned images from existing OpenEmbedded build artifacts. Image generation is driven by partitioning commands contained in an 'Openembedded kickstart' (.wks) file specified either directly on the command-line or as one of a selection of canned .wks files (see 'wic list images'). When applied to a given set of build artifacts, the result is an image or set of images that can be directly written onto media and used on a particular system. 'wic' is based loosely on the 'mic' (Meego Image Creator) framework, but heavily modified to make direct use of OpenEmbedded build artifacts instead of package installation and configuration, things already incorporated int the OE artifacts. The name 'wic' comes from 'oeic' with the 'oe' diphthong promoted to the letter 'w', because 'oeic' is impossible to remember or pronounce. This covers the mechanics of invoking and providing help for the command and sub-commands; it contains hooks for future commits to connect with the actual functionality, once implemented. Help is integrated into the 'wic' command - see that for details on usage. (From OE-Core rev: 95455ae4251e06d66e60945092b784d2d9ef165c) Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com> Signed-off-by: Saul Wold <sgw@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-05-25 03:41:55 +0000