diff options
| author | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-04 15:37:49 +0000 |
|---|---|---|
| committer | Lars Wirzenius <lars.wirzenius@codethink.co.uk> | 2013-07-05 14:35:46 +0000 |
| commit | 715d1edd29e8c4920d181080a709557fb4223c18 (patch) | |
| tree | 34aa57bd394322087a2632c53661b9882f67cb72 /morphlib/plugins/artifact_inspection_plugin.py | |
| parent | 89754d01d178d4f120c6b8a4b765c7175cc8dee5 (diff) | |
| download | morph-715d1edd29e8c4920d181080a709557fb4223c18.tar.gz | |
Improve docstring for "morph run-in-artifact"
Diffstat (limited to 'morphlib/plugins/artifact_inspection_plugin.py')
| -rw-r--r-- | morphlib/plugins/artifact_inspection_plugin.py | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/morphlib/plugins/artifact_inspection_plugin.py b/morphlib/plugins/artifact_inspection_plugin.py index f3417058..be91044a 100644 --- a/morphlib/plugins/artifact_inspection_plugin.py +++ b/morphlib/plugins/artifact_inspection_plugin.py @@ -263,7 +263,20 @@ class ArtifactInspectionPlugin(cliapp.Plugin): pass def run_in_artifact(self, args): - '''Run a command inside an extracted/mounted chunk or system.''' + '''Run a command inside an extracted/mounted chunk or system. + + Command line arguments: + + * `ARTIFACT` is a filename for the artifact. + * `CMD` is the command to run. + + run-in-artifact unpacks an artifact, and runs a command in + the temporary directory it was unpacked to. + + The command must be given to Morph as a single argument, so + use shell quoting appropriately. + + ''' if len(args) < 2: raise cliapp.AppException( |