wic: Integrated plugin docstrings into 'wic help plugins' output

Added mechanism to show docstrings of plugin classes as a part of
plugins help page.
For missing plugins the following warning message is shown:
<class '<plugin class spec>'> is missing docstring.

[YOCTO #7118]

Signed-off-by: Ed Bartosh <ed.bartosh@linux.intel.com>
Signed-off-by: Ross Burton <ross.burton@intel.com>

diff --git a/scripts/lib/image/help.py b/scripts/lib/image/help.py
index adfe9767166da0979a39b563bb0ebee68536abbf..ce42627cdb16997104683162d9e1f3131279e1b1 100644 (file)
--- a/scripts/lib/image/help.py
+++ b/scripts/lib/image/help.py
@@ -28,6 +28,7 @@
 import subprocess
 import logging
 
+from wic.plugin import pluginmgr, PLUGIN_TYPES
 
 def subcommand_error(args):
     logging.info("invalid subcommand %s" % args[0])
@@ -55,6 +56,23 @@ def wic_help(args, usage_str, subcommands):
         print(usage_str)
 
 
+def get_wic_plugins_help():
+    """
+    Combine wic_plugins_help with the help for every known
+    source plugin.
+    """
+    result = wic_plugins_help
+    for plugin_type in PLUGIN_TYPES:
+        result += '\n\n%s PLUGINS\n\n' % plugin_type.upper()
+        for name, plugin in pluginmgr.get_plugins(plugin_type).iteritems():
+            result += "\n %s plugin:\n" % name
+            if plugin.__doc__:
+                result += plugin.__doc__
+            else:
+                result += "\n    %s is missing docstring\n" % plugin
+    return result
+
+
 def invoke_subcommand(args, parser, main_command_usage, subcommands):
     """
     Dispatch to subcommand handler borrowed from combo-layer.

diff --git a/scripts/wic b/scripts/wic
index cf968591e26f134d934ed4abe72420636d533dad..dda72a9c2775567524e34fc59de0a199a7337ffa 100755 (executable)
--- a/scripts/wic
+++ b/scripts/wic
@@ -277,7 +277,7 @@ subcommands = {
                   hlp.wic_list_help],
     "plugins":   [wic_help_topic_subcommand,
                   wic_help_topic_usage,
-                  hlp.wic_plugins_help],
+                  hlp.get_wic_plugins_help()],
     "overview":  [wic_help_topic_subcommand,
                   wic_help_topic_usage,
                   hlp.wic_overview_help],