Patchwork [2/5] wic: Add help text for 'wic list source-plugins'

login
register
mail settings
Submitter tom.zanussi@linux.intel.com
Date July 8, 2014, 2:51 p.m.
Message ID <dc30586ac2011d6a57f72843d1e2b134168678c2.1404830754.git.tom.zanussi@linux.intel.com>
Download mbox | patch
Permalink /patch/75191/
State Accepted
Commit 1908751b3283d7e14d3a9f68b0926a384cafe9ca
Headers show

Comments

tom.zanussi@linux.intel.com - July 8, 2014, 2:51 p.m.
Add both short and long text for the new 'wic list source-plugins'
command.

Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com>
---
 scripts/lib/image/help.py | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

Patch

diff --git a/scripts/lib/image/help.py b/scripts/lib/image/help.py
index cb3112c..6de7ab0 100644
--- a/scripts/lib/image/help.py
+++ b/scripts/lib/image/help.py
@@ -199,6 +199,7 @@  wic_list_usage = """
 
  usage: wic list images
         wic list <image> help
+        wic list source-plugins
         wic list properties
         wic list properties <wks file>
         wic list property <property>
@@ -214,11 +215,14 @@  wic_list_usage = """
  The second form lists the detailed help information for a specific
  'canned' image.
 
- The third form enumerates all the possible values that exist and can
+ The third form enumerates all the available --sources (source
+ plugins).
+
+ The fourth form enumerates all the possible values that exist and can
  be specified in an OE kickstart (wks) file.
 
- The fourth form enumerates all the possible options that exist for
- the set of properties specified in a given OE kickstart (ks) file.
+ The fifth form enumerates all the possible options that exist for the
+ set of properties specified in a given OE kickstart (ks) file.
 
  The final form enumerates all the possible values that exist and can
  be specified for any given OE kickstart (wks) property.
@@ -234,6 +238,7 @@  NAME
 SYNOPSIS
     wic list images
     wic list <image> help
+    wic list source-plugins
     wic list properties
     wic list properties <wks file>
     wic list property <property>
@@ -255,6 +260,15 @@  DESCRIPTION
     The second form lists the detailed help information for a specific
     'canned' image.
 
+    The third form enumerates all the available --sources (source
+    plugins).  The contents of a given partition are driven by code
+    defined in 'source plugins'.  Users specify a specific plugin via
+    the --source parameter of the partition .wks command.  Normally
+    this is the 'rootfs' plugin but can be any of the more specialized
+    sources listed by the 'list source-plugins' command.  Users can
+    also add their own source plugins - see 'wic help plugins' for
+    details.
+
     The third form enumerates all the possible values that exist and
     can be specified in a OE kickstart (wks) file.  The output of this
     can be used by the third form to print the description and