[PATCH 25/25] Improve docstring for "morph generate-manifest"

Lars Wirzenius lars.wirzenius at codethink.co.uk
Thu Jul 4 18:04:33 BST 2013


---
 morphlib/plugins/artifact_inspection_plugin.py |   21 +++++++++++++++++++--
 1 files changed, 19 insertions(+), 2 deletions(-)

diff --git a/morphlib/plugins/artifact_inspection_plugin.py b/morphlib/plugins/artifact_inspection_plugin.py
index 6123e40..5da70da 100644
--- a/morphlib/plugins/artifact_inspection_plugin.py
+++ b/morphlib/plugins/artifact_inspection_plugin.py
@@ -257,7 +257,7 @@ class ArtifactInspectionPlugin(cliapp.Plugin):
                                 arg_synopsis='ARTIFACT CMD')
         self.app.add_subcommand('generate-manifest',
                                 self.generate_manifest,
-                                arg_synopsis='ROOTFS_ARTIFACT')
+                                arg_synopsis='SYSTEM-ARTIFACT')
 
     def disable(self):
         pass
@@ -292,7 +292,24 @@ class ArtifactInspectionPlugin(cliapp.Plugin):
         call_in_artifact_directory(self.app, artifact, run_command_in_dir)
 
     def generate_manifest(self, args):
-        '''Generate a content manifest for a system image.'''
+        '''Generate a content manifest for a system image.
+
+        Command line arguments:
+
+        * `SYSTEM-ARTIFACT` is a filename to the system artifact
+          (root filesystem) for the built system.
+
+        This command generates a manifest for a built system image.
+        The manifest includes the constituent artifacts,
+        a guess at the component version, the exact commit for
+        the component (commit SHA1, repository URL, git symbolic
+        ref), and the morphology filename.
+
+        Example:
+
+            morph generate-manifest /src/cache/artifacts/foo-rootfs
+
+        '''
 
         if len(args) != 1:
             raise cliapp.AppException('morph generate-manifest expects '
-- 
1.7.9-rc0




More information about the baserock-dev mailing list