diff options
author | Ed Bartosh <ed.bartosh@linux.intel.com> | 2015-06-17 11:53:04 +0300 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2015-06-23 11:38:16 +0100 |
commit | d4414b45c81ab539f75a7bb16fc6412c30dfc45f (patch) | |
tree | 833b392eb55cf5be70d3b1e71857e561d434cbeb /scripts/lib/wic | |
parent | cd7c72d6d5a5110173d0d3f60f2991b1dc30fc26 (diff) | |
download | openembedded-core-d4414b45c81ab539f75a7bb16fc6412c30dfc45f.tar.gz openembedded-core-d4414b45c81ab539f75a7bb16fc6412c30dfc45f.tar.bz2 openembedded-core-d4414b45c81ab539f75a7bb16fc6412c30dfc45f.zip |
wic: Add missing docstrings to plugin classes
Docstings from plugin classes are used as part of
output of 'wic help plugins'. Adding them makes help page
more informative.
Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com>
Signed-off-by: Ross Burton <ross.burton@intel.com>
Diffstat (limited to 'scripts/lib/wic')
-rw-r--r-- | scripts/lib/wic/plugins/imager/direct_plugin.py | 9 | ||||
-rw-r--r-- | scripts/lib/wic/plugins/source/bootimg-efi.py | 5 | ||||
-rw-r--r-- | scripts/lib/wic/plugins/source/bootimg-partition.py | 5 | ||||
-rw-r--r-- | scripts/lib/wic/plugins/source/bootimg-pcbios.py | 4 | ||||
-rw-r--r-- | scripts/lib/wic/plugins/source/fsimage.py | 4 | ||||
-rw-r--r-- | scripts/lib/wic/plugins/source/rawcopy.py | 4 | ||||
-rw-r--r-- | scripts/lib/wic/plugins/source/rootfs.py | 4 |
7 files changed, 35 insertions, 0 deletions
diff --git a/scripts/lib/wic/plugins/imager/direct_plugin.py b/scripts/lib/wic/plugins/imager/direct_plugin.py index 1720f7bb20..07811bd26d 100644 --- a/scripts/lib/wic/plugins/imager/direct_plugin.py +++ b/scripts/lib/wic/plugins/imager/direct_plugin.py @@ -33,6 +33,15 @@ import wic.imager.direct as direct from wic.pluginbase import ImagerPlugin class DirectPlugin(ImagerPlugin): + """ + Install a system into a file containing a partitioned disk image. + + An image file is formatted with a partition table, each partition + created from a rootfs or other OpenEmbedded build artifact and dd'ed + into the virtual disk. The disk image can subsequently be dd'ed onto + media and used on actual hardware. + """ + name = 'direct' @classmethod diff --git a/scripts/lib/wic/plugins/source/bootimg-efi.py b/scripts/lib/wic/plugins/source/bootimg-efi.py index f50f631313..903b478fe8 100644 --- a/scripts/lib/wic/plugins/source/bootimg-efi.py +++ b/scripts/lib/wic/plugins/source/bootimg-efi.py @@ -34,6 +34,11 @@ from wic.utils.oe.misc import exec_cmd, exec_native_cmd, get_bitbake_var, \ BOOTDD_EXTRA_SPACE class BootimgEFIPlugin(SourcePlugin): + """ + Create EFI boot partition. + This plugin supports GRUB 2 and gummiboot bootloaders. + """ + name = 'bootimg-efi' @classmethod diff --git a/scripts/lib/wic/plugins/source/bootimg-partition.py b/scripts/lib/wic/plugins/source/bootimg-partition.py index 2ffce6b3b3..bc2ca0f6fa 100644 --- a/scripts/lib/wic/plugins/source/bootimg-partition.py +++ b/scripts/lib/wic/plugins/source/bootimg-partition.py @@ -32,6 +32,11 @@ from wic.utils.oe.misc import exec_cmd, get_bitbake_var from glob import glob class BootimgPartitionPlugin(SourcePlugin): + """ + Create an image of boot partition, copying over files + listed in IMAGE_BOOT_FILES bitbake variable. + """ + name = 'bootimg-partition' @classmethod diff --git a/scripts/lib/wic/plugins/source/bootimg-pcbios.py b/scripts/lib/wic/plugins/source/bootimg-pcbios.py index ae5fc0ca2a..6ca68f6e7e 100644 --- a/scripts/lib/wic/plugins/source/bootimg-pcbios.py +++ b/scripts/lib/wic/plugins/source/bootimg-pcbios.py @@ -34,6 +34,10 @@ from wic.utils.oe.misc import exec_cmd, exec_native_cmd, \ get_bitbake_var, BOOTDD_EXTRA_SPACE class BootimgPcbiosPlugin(SourcePlugin): + """ + Create MBR boot partition and install syslinux on it. + """ + name = 'bootimg-pcbios' @classmethod diff --git a/scripts/lib/wic/plugins/source/fsimage.py b/scripts/lib/wic/plugins/source/fsimage.py index cd59c6e87e..98f02a1e09 100644 --- a/scripts/lib/wic/plugins/source/fsimage.py +++ b/scripts/lib/wic/plugins/source/fsimage.py @@ -22,6 +22,10 @@ from wic.pluginbase import SourcePlugin from wic.utils.oe.misc import get_bitbake_var class FSImagePlugin(SourcePlugin): + """ + Add an already existing filesystem image to the partition layout. + """ + name = 'fsimage' @classmethod diff --git a/scripts/lib/wic/plugins/source/rawcopy.py b/scripts/lib/wic/plugins/source/rawcopy.py index df07851751..071b2d2032 100644 --- a/scripts/lib/wic/plugins/source/rawcopy.py +++ b/scripts/lib/wic/plugins/source/rawcopy.py @@ -22,6 +22,10 @@ from wic.pluginbase import SourcePlugin from wic.utils.oe.misc import exec_cmd, get_bitbake_var class RawCopyPlugin(SourcePlugin): + """ + Populate partition content from raw image file. + """ + name = 'rawcopy' @classmethod diff --git a/scripts/lib/wic/plugins/source/rootfs.py b/scripts/lib/wic/plugins/source/rootfs.py index 0ee383efb7..12fbf67a6e 100644 --- a/scripts/lib/wic/plugins/source/rootfs.py +++ b/scripts/lib/wic/plugins/source/rootfs.py @@ -32,6 +32,10 @@ from wic.pluginbase import SourcePlugin from wic.utils.oe.misc import find_bitbake_env_lines, find_artifact class RootfsPlugin(SourcePlugin): + """ + Populate partition content from a rootfs directory. + """ + name = 'rootfs' @staticmethod |