diff options
| author | Tom Zanussi <tom.zanussi@linux.intel.com> | 2014-07-28 10:01:37 -0500 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-08-02 09:26:13 +0100 |
| commit | 3e237b177b381c8f5c426432334249c64ceda589 (patch) | |
| tree | e1cae02b5af03c47f143f0971acf717baf4f317a /scripts/lib/image/help.py | |
| parent | e517b082425b45500952a5429f2df26b01304d6a (diff) | |
| download | poky-3e237b177b381c8f5c426432334249c64ceda589.tar.gz | |
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>
Diffstat (limited to 'scripts/lib/image/help.py')
| -rw-r--r-- | scripts/lib/image/help.py | 29 |
1 files changed, 16 insertions, 13 deletions
diff --git a/scripts/lib/image/help.py b/scripts/lib/image/help.py index 848aa9a27d..913947ca00 100644 --- a/scripts/lib/image/help.py +++ b/scripts/lib/image/help.py | |||
| @@ -389,9 +389,9 @@ DESCRIPTION | |||
| 389 | class (see the SourcePlugin source for details): | 389 | class (see the SourcePlugin source for details): |
| 390 | 390 | ||
| 391 | do_prepare_partition() | 391 | do_prepare_partition() |
| 392 | Called to do the actual content population for a partition | 392 | Called to do the actual content population for a |
| 393 | i.e. it 'prepares' the final partition image which will be | 393 | partition. In other words, it 'prepares' the final partition |
| 394 | incorporated into the disk image. | 394 | image which will be incorporated into the disk image. |
| 395 | 395 | ||
| 396 | do_configure_partition() | 396 | do_configure_partition() |
| 397 | Called before do_prepare_partition(), typically used to | 397 | Called before do_prepare_partition(), typically used to |
| @@ -401,23 +401,26 @@ DESCRIPTION | |||
| 401 | do_install_disk() | 401 | do_install_disk() |
| 402 | Called after all partitions have been prepared and assembled | 402 | Called after all partitions have been prepared and assembled |
| 403 | into a disk image. This provides a hook to allow | 403 | into a disk image. This provides a hook to allow |
| 404 | finalization of a disk image e.g. to write an MBR to it. | 404 | finalization of a disk image, for example to write an MBR to |
| 405 | it. | ||
| 405 | 406 | ||
| 406 | do_stage_partition() | 407 | do_stage_partition() |
| 407 | Special content staging hook called before | 408 | Special content-staging hook called before |
| 408 | do_prepare_partition(), normally empty. | 409 | do_prepare_partition(), normally empty. |
| 409 | 410 | ||
| 410 | Typically, a partition will just use the passed-in parame | 411 | Typically, a partition will just use the passed-in |
| 411 | e.g straight bootimg_dir, etc, but in some cases, things | 412 | parameters, for example the unmodified value of bootimg_dir. |
| 412 | need to be more tailored e.g. to use a deploy dir + /boot, | 413 | In some cases however, things may need to be more tailored. |
| 413 | etc. This hook allows those files to be staged in a | 414 | As an example, certain files may additionally need to be |
| 414 | customized fashion. Not that get_bitbake_var() allows you | 415 | take from bootimg_dir + /boot. This hook allows those files |
| 415 | to acces non-standard variables that you might want to use | 416 | to be staged in a customized fashion. Note that |
| 416 | for this. | 417 | get_bitbake_var() allows you to access non-standard |
| 418 | variables that you might want to use for these types of | ||
| 419 | situations. | ||
| 417 | 420 | ||
| 418 | This scheme is extensible - adding more hooks is a simple matter | 421 | This scheme is extensible - adding more hooks is a simple matter |
| 419 | of adding more plugin methods to SourcePlugin and derived classes. | 422 | of adding more plugin methods to SourcePlugin and derived classes. |
| 420 | The code that then needs to call the plugin methods the uses | 423 | The code that then needs to call the plugin methods uses |
| 421 | plugin.get_source_plugin_methods() to find the method(s) needed by | 424 | plugin.get_source_plugin_methods() to find the method(s) needed by |
| 422 | the call; this is done by filling up a dict with keys containing | 425 | the call; this is done by filling up a dict with keys containing |
| 423 | the method names of interest - on success, these will be filled in | 426 | the method names of interest - on success, these will be filled in |
