diff options
| author | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-04 15:24:03 +0000 |
|---|---|---|
| committer | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-05 14:35:46 +0000 |
| commit | 8a4dbd1c7911efb01f79e5e26201bc6523dbb172 (patch) | |
| tree | 1fd57a8b197546c37fbc1cb65e8ef85f50d5c2a4 | |
| parent | c50d2f6d42019a6aec6a4e3af7b1cf6bf4a48a3f (diff) | |
| download | definitions-8a4dbd1c7911efb01f79e5e26201bc6523dbb172.tar.gz | |
Improve docstring for "morph list-artifacts"
| -rw-r--r-- | morphlib/plugins/copy-artifacts_plugin.py | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/morphlib/plugins/copy-artifacts_plugin.py b/morphlib/plugins/copy-artifacts_plugin.py index ab51e522..583d5b0c 100644 --- a/morphlib/plugins/copy-artifacts_plugin.py +++ b/morphlib/plugins/copy-artifacts_plugin.py @@ -37,7 +37,7 @@ class CopyArtifactsPlugin(cliapp.Plugin): def enable(self): self.app.add_subcommand( 'list-artifacts', self.list_artifacts, - arg_synopsis='SYSTEM') + arg_synopsis='SYSTEM-ARTIFACT') self.app.add_subcommand( 'copy-artifacts', self.copy_artifacts, arg_synopsis='SYSTEM DESTINATION') @@ -46,7 +46,20 @@ class CopyArtifactsPlugin(cliapp.Plugin): pass def list_artifacts(self, args): - '''List every artifact that makes up a system''' + '''List every artifact that makes up a system artifact. + + Command line arguments: + + * `SYSTEM-ARTIFACT` is the filename for a build artifact for + a system (ending in `-rootfs`). + + list-artifacts reads the system artifact and writes out a list + of the filenames, in the local artifact cache, of all the + component artifacts included in the system. It does not include + build-dependencies of the system, unless they're included in + the system. + + ''' if len(args) != 1: raise cliapp.AppException( |