summaryrefslogtreecommitdiffstats
path: root/scripts/lib/wic/plugins
diff options
context:
space:
mode:
authorEd Bartosh <ed.bartosh@linux.intel.com>2015-06-17 11:53:04 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-06-23 11:47:33 +0100
commitcfe64126c8d9afce907e51093e33c9805fa71b25 (patch)
treecda58fb123689d0564c5e4620e95caf1ff95b5ae /scripts/lib/wic/plugins
parent553f3322650235ff267627504bd49c3d04c1f39c (diff)
downloadpoky-cfe64126c8d9afce907e51093e33c9805fa71b25.tar.gz
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. (From OE-Core rev: d4414b45c81ab539f75a7bb16fc6412c30dfc45f) 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>
Diffstat (limited to 'scripts/lib/wic/plugins')
-rw-r--r--scripts/lib/wic/plugins/imager/direct_plugin.py9
-rw-r--r--scripts/lib/wic/plugins/source/bootimg-efi.py5
-rw-r--r--scripts/lib/wic/plugins/source/bootimg-partition.py5
-rw-r--r--scripts/lib/wic/plugins/source/bootimg-pcbios.py4
-rw-r--r--scripts/lib/wic/plugins/source/fsimage.py4
-rw-r--r--scripts/lib/wic/plugins/source/rawcopy.py4
-rw-r--r--scripts/lib/wic/plugins/source/rootfs.py4
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
33from wic.pluginbase import ImagerPlugin 33from wic.pluginbase import ImagerPlugin
34 34
35class DirectPlugin(ImagerPlugin): 35class DirectPlugin(ImagerPlugin):
36 """
37 Install a system into a file containing a partitioned disk image.
38
39 An image file is formatted with a partition table, each partition
40 created from a rootfs or other OpenEmbedded build artifact and dd'ed
41 into the virtual disk. The disk image can subsequently be dd'ed onto
42 media and used on actual hardware.
43 """
44
36 name = 'direct' 45 name = 'direct'
37 46
38 @classmethod 47 @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, \
34 BOOTDD_EXTRA_SPACE 34 BOOTDD_EXTRA_SPACE
35 35
36class BootimgEFIPlugin(SourcePlugin): 36class BootimgEFIPlugin(SourcePlugin):
37 """
38 Create EFI boot partition.
39 This plugin supports GRUB 2 and gummiboot bootloaders.
40 """
41
37 name = 'bootimg-efi' 42 name = 'bootimg-efi'
38 43
39 @classmethod 44 @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
32from glob import glob 32from glob import glob
33 33
34class BootimgPartitionPlugin(SourcePlugin): 34class BootimgPartitionPlugin(SourcePlugin):
35 """
36 Create an image of boot partition, copying over files
37 listed in IMAGE_BOOT_FILES bitbake variable.
38 """
39
35 name = 'bootimg-partition' 40 name = 'bootimg-partition'
36 41
37 @classmethod 42 @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, \
34 get_bitbake_var, BOOTDD_EXTRA_SPACE 34 get_bitbake_var, BOOTDD_EXTRA_SPACE
35 35
36class BootimgPcbiosPlugin(SourcePlugin): 36class BootimgPcbiosPlugin(SourcePlugin):
37 """
38 Create MBR boot partition and install syslinux on it.
39 """
40
37 name = 'bootimg-pcbios' 41 name = 'bootimg-pcbios'
38 42
39 @classmethod 43 @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
22from wic.utils.oe.misc import get_bitbake_var 22from wic.utils.oe.misc import get_bitbake_var
23 23
24class FSImagePlugin(SourcePlugin): 24class FSImagePlugin(SourcePlugin):
25 """
26 Add an already existing filesystem image to the partition layout.
27 """
28
25 name = 'fsimage' 29 name = 'fsimage'
26 30
27 @classmethod 31 @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
22from wic.utils.oe.misc import exec_cmd, get_bitbake_var 22from wic.utils.oe.misc import exec_cmd, get_bitbake_var
23 23
24class RawCopyPlugin(SourcePlugin): 24class RawCopyPlugin(SourcePlugin):
25 """
26 Populate partition content from raw image file.
27 """
28
25 name = 'rawcopy' 29 name = 'rawcopy'
26 30
27 @classmethod 31 @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
32from wic.utils.oe.misc import find_bitbake_env_lines, find_artifact 32from wic.utils.oe.misc import find_bitbake_env_lines, find_artifact
33 33
34class RootfsPlugin(SourcePlugin): 34class RootfsPlugin(SourcePlugin):
35 """
36 Populate partition content from a rootfs directory.
37 """
38
35 name = 'rootfs' 39 name = 'rootfs'
36 40
37 @staticmethod 41 @staticmethod