wic: Fix plugin help text

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>
This commit is contained in:
Tom Zanussi
2014-07-28 10:01:37 -05:00
committed by Richard Purdie
parent e517b08242
commit 3e237b177b

View File

@@ -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