]> code.ossystems Code Review - openembedded-core.git/commitdiff
wic: Add missing docstrings to plugin classes
authorEd Bartosh <ed.bartosh@linux.intel.com>
Wed, 17 Jun 2015 08:53:04 +0000 (11:53 +0300)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Tue, 23 Jun 2015 10:38:16 +0000 (11:38 +0100)
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>
scripts/lib/wic/plugins/imager/direct_plugin.py
scripts/lib/wic/plugins/source/bootimg-efi.py
scripts/lib/wic/plugins/source/bootimg-partition.py
scripts/lib/wic/plugins/source/bootimg-pcbios.py
scripts/lib/wic/plugins/source/fsimage.py
scripts/lib/wic/plugins/source/rawcopy.py
scripts/lib/wic/plugins/source/rootfs.py

index 1720f7bb201a52c3902b40b8d9395da6ae5157f5..07811bd26d1b50948bba411904a3ff9d81578d34 100644 (file)
@@ -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
index f50f631313f96e1bc7b519216a2cf8387f8970d2..903b478fe862abe9dd1c846b862aab44608e8dd2 100644 (file)
@@ -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
index 2ffce6b3b386c2e15e1befabb705a58c465c4878..bc2ca0f6fae3d956cee4378393d22c595c2a8051 100644 (file)
@@ -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
index ae5fc0ca2ab266381060e9fde015346a865588cb..6ca68f6e7e6ff3be245d851449166b01e054d2d1 100644 (file)
@@ -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
index cd59c6e87ed1e93452b55cd62f2636f0adf188d1..98f02a1e097a743f44a1d7b34c97a1ecbf0fb78d 100644 (file)
@@ -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
index df0785175124b1a2bcfdb7bef3a769aa35dcd414..071b2d2032748626a53f16620e5c1740efe27f21 100644 (file)
@@ -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
index 0ee383efb7f9d19f9fb0c647795749bcac83b369..12fbf67a6e7649343bf9ec8edf1c44045f8a04c7 100644 (file)
@@ -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