From cfe64126c8d9afce907e51093e33c9805fa71b25 Mon Sep 17 00:00:00 2001 From: Ed Bartosh Date: Wed, 17 Jun 2015 11:53:04 +0300 Subject: 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 Signed-off-by: Ross Burton Signed-off-by: Richard Purdie --- scripts/lib/wic/plugins/imager/direct_plugin.py | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'scripts/lib/wic/plugins/imager/direct_plugin.py') 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 -- cgit v1.2.3-54-g00ecf