wic help updates
cover wic help updates
This patchset fixes a few things noticed while updating the dev manual.
The following changes since commit 2d1660112e54653f7bb763939d0416472c49fe01:
populate_sdk_base: Fix grep command usage on old hosts (2014-07-29 09:58:27 +0100)
are available in the git repository at:
git://git.yoctoproject.org/poky-contrib.git tzanussi/wic-help-updates
http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=tzanussi/wic-help-updates
Tom Zanussi (4):
wic: Fix plugin help text
wic: Add documentation for --fsoptions
wic: Add squashfs to --fstypes documentation
wic: Various typo/grammar fixes to wic help text
scripts/lib/image/help.py | 43 +++++++++++++++++++++++++++---------------- 1 file changed, 27 insertions(+), 16 deletions(-)
Signature · 1 line
1.8.3.1
PATCH 1/4 wic: Fix plugin help text
Fix various typoes and grammar problems noticed while transcribing for the dev manual.
--- scripts/lib/image/help.py | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-)
scripts/lib/image/help.py +16 -13
@@ -389,9 +389,9 @@ DESCRIPTION class (see the SourcePlugin source for details): do_prepare_partition() - Called to do the actual content population for a partition - i.e. it 'prepares' the final partition image which will be - incorporated into the disk image. + Called to do the actual content population for a + partition. In other words, it 'prepares' the final partition + image which will be incorporated into the disk image. do_configure_partition() Called before do_prepare_partition(), typically used to
@@ -401,23 +401,26 @@ DESCRIPTION do_install_disk() Called after all partitions have been prepared and assembled into a disk image. This provides a hook to allow - finalization of a disk image e.g. to write an MBR to it. + finalization of a disk image, for example to write an MBR to + it. do_stage_partition() - Special content staging hook called before + Special content-staging hook called before do_prepare_partition(), normally empty. - Typically, a partition will just use the passed-in parame - e.g straight bootimg_dir, etc, but in some cases, things - need to be more tailored e.g. to use a deploy dir + /boot, - etc. This hook allows those files to be staged in a - customized fashion. Not that get_bitbake_var() allows you - to acces non-standard variables that you might want to use - for this. + Typically, a partition will just use the passed-in + parameters, for example the unmodified value of bootimg_dir. + In some cases however, things may need to be more tailored. + As an example, certain files may additionally need to be + take from bootimg_dir + /boot. This hook allows those files + to be staged in a customized fashion. Note that + get_bitbake_var() allows you to access non-standard + variables that you might want to use for these types of + situations. This scheme is extensible - adding more hooks is a simple matter of adding more plugin methods to SourcePlugin and derived classes. - The code that then needs to call the plugin methods the uses + The code that then needs to call the plugin methods uses plugin.get_source_plugin_methods() to find the method(s) needed by the call; this is done by filling up a dict with keys containing the method names of interest - on success, these will be filled in
Signature · 1 line
1.8.3.1
PATCH 2/4 wic: Add documentation for --fsoptions
--fsoptions support was recently added to wic, so document it.
--- scripts/lib/image/help.py | 7 +++++++ 1 file changed, 7 insertions(+)
scripts/lib/image/help.py +7 -0
@@ -721,6 +721,13 @@ DESCRIPTION btrfs swap + --fsoptions: Specifies a free-form string of options to be + used when mounting the filesystem. This string + will be copied into the /etc/fstab file of the + installed system and should be enclosed in + quotes. If not specified, the default string is + "defaults". + --label label: Specifies the label to give to the filesystem to be made on the partition. If the given label is already in use by another filesystem,
Signature · 1 line
1.8.3.1
PATCH 3/4 wic: Add squashfs to --fstypes documentation
In reply to Tom Zanussisquashfs support was recently added to wic, so document it.
--- scripts/lib/image/help.py | 1 + 1 file changed, 1 insertion(+)
scripts/lib/image/help.py +1 -0
@@ -719,6 +719,7 @@ DESCRIPTION ext3 ext4 btrfs + squashfs swap --fsoptions: Specifies a free-form string of options to be
Signature · 1 line
1.8.3.1
PATCH 4/4 wic: Various typo/grammar fixes to wic help text
In reply to Tom ZanussiThis is a set of miscellaneous help text updates noticed while transcribing wic help for the dev manual.
--- scripts/lib/image/help.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
scripts/lib/image/help.py +3 -3
@@ -443,8 +443,8 @@ DESCRIPTION artifacts, the result is an image or set of images that can be directly written onto media and used on a particular system. - The 'wic' command and the infrastructure it's based is by - definition incomplete - it's designed to allow the generation of + The 'wic' command and the infrastructure it's based on is by + definition incomplete - its purpose is to allow the generation of customized images, and as such was designed to be completely extensible via a plugin interface (see 'wic help plugins').
@@ -705,7 +705,7 @@ DESCRIPTION wic command-line option (or the equivalent rootfs derived from the '-e' command-line option). Exactly what those contents and filesystem type end - up being are depend on the given plugin + up being are dependent on the given plugin implementation. --ondisk or --ondrive: Forces the partition to be created on
Signature · 1 line
1.8.3.1