10:49 a.m.
From: Ric Holland <richard.holland(a)codethink.co.uk>
repo: git://git.baserock.org/baserock/baserock/morph
branch: baserock/richardholland/arg-error-deploy
commit: 79598fdffefe848382c2f43c06d4cf516101e79c
Ric Holland (1):
Changed error message when morph deploy is given too few arguments
morphlib/plugins/deploy_plugin.py | 5 ++++-
1 files changed, 4 insertions(+), 1 deletions(-)
--
1.7.9.rc0.27.ge0b3e
10:49 a.m.
New subject: [PATCH] Changed error message when morph deploy is given too few arguments
From: Ric Holland <richard.holland(a)codethink.co.uk>
Error message now gives short description of each required argument
rather than pointing to non-existent help text.
---
morphlib/plugins/deploy_plugin.py | 5 ++++-
1 files changed, 4 insertions(+), 1 deletions(-)
diff --git a/morphlib/plugins/deploy_plugin.py b/morphlib/plugins/deploy_plugin.py
index 5bb2d9e..88610ca 100644
--- a/morphlib/plugins/deploy_plugin.py
+++ b/morphlib/plugins/deploy_plugin.py
@@ -51,7 +51,10 @@ class DeployPlugin(cliapp.Plugin):
if len(args) < 3:
raise cliapp.AppException(
- 'Too few arguments to deploy command (see help)')
+ 'Command requires a minimum of three arguments.\n\tmorph '
+ 'deploy TYPE SYSTEM LOCATION\nTYPE is type of deployment. '
+ 'SYSTEM is name of the system morphology to deploy. LOCATION '
+ 'is the destination of the deployed system.')
deployment_type = args[0]
system_name = args[1]
--
1.7.9.rc0.27.ge0b3e
11:37 a.m.
New subject: [PATCH] Changed error message when morph deploy is given too few arguments
On 2013-03-21 09:49, Richard Holland wrote:
From: Ric Holland <richard.holland(a)codethink.co.uk>
Error message now gives short description of each required argument
rather than pointing to non-existent help text.
---
morphlib/plugins/deploy_plugin.py | 5 ++++-
1 files changed, 4 insertions(+), 1 deletions(-)
diff --git a/morphlib/plugins/deploy_plugin.py
b/morphlib/plugins/deploy_plugin.py
index 5bb2d9e..88610ca 100644
--- a/morphlib/plugins/deploy_plugin.py
+++ b/morphlib/plugins/deploy_plugin.py
@@ -51,7 +51,10 @@ class DeployPlugin(cliapp.Plugin):
if len(args) < 3:
raise cliapp.AppException(
- 'Too few arguments to deploy command (see help)')
+ 'Command requires a minimum of three
arguments.\n\tmorph '
+ 'deploy TYPE SYSTEM LOCATION\nTYPE is type of
deployment. '
+ 'SYSTEM is name of the system morphology to deploy.
LOCATION '
+ 'is the destination of the deployed system.')
deployment_type = args[0]
system_name = args[1]
I wonder if it would be better to just tell them to check the
command-line from
`morph --help`, and make that help information more informative.
Currently the
help for deploy just says "Deploy a built system image" without
explaining what
TYPE, SYSTEM and LOCATION are. Either way, LOCATION is currently
under-documented and may require talking to the spirits to get the
correct text.
7:09 p.m.
On Thu, Mar 21, 2013 at 09:49:23AM +0000, Richard Holland wrote:
From: Ric Holland <richard.holland(a)codethink.co.uk>
repo: git://git.baserock.org/baserock/baserock/morph
branch: baserock/richardholland/arg-error-deploy
commit: 79598fdffefe848382c2f43c06d4cf516101e79c
I don't see that branch on git.baserock.org. Did you push it?
--
http://www.codethink.co.uk/ http://wiki.baserock.org/ http://www.baserock.com/
7:12 p.m.
New subject: [PATCH] Changed error message when morph deploy is given too few arguments
On Thu, Mar 21, 2013 at 10:37:02AM +0000, Jonathan Maw wrote:
I wonder if it would be better to just tell them to check the
command-line from
`morph --help`, and make that help information more informative.
Currently the
help for deploy just says "Deploy a built system image" without
explaining what
TYPE, SYSTEM and LOCATION are. Either way, LOCATION is currently
under-documented and may require talking to the spirits to get the
correct text.
I think Jonathan is right: the right place for this is in the
subcommand's help. This is easy to do: add to the docstring to the
"deploy" method in DeployPlugin. It currently says just
"Deploy a built system image", and should include the extra text
you added to the error message. Could you prepare a new patch that
does that, please, Ric?
--
http://www.codethink.co.uk/ http://wiki.baserock.org/ http://www.baserock.com/
3901
days inactive
3905
days old
4 comments
3 participants
participants (3)
-
Jonathan Maw -
Lars Wirzenius -
Richard Holland