[pve-devel] [PATCH common v3 4/5] cli: allow to pass sub commands to help as array

Thomas Lamprecht t.lamprecht at proxmox.com
Tue Jan 9 13:25:32 CET 2018


Improves usabillity by allowing to pass a sub copmmand unquoted to
the help command, e.g.:

 # pveum help user delete

without this only a quoted version worked, e.g.:
 # pveum help "user delete"

Signed-off-by: Thomas Lamprecht <t.lamprecht at proxmox.com>
Acked-by: Wolfgang Bumiller <w.bumiller at proxmox.com>
---

changes v2 -> v3:
* added Wolfgangs ACK

 src/PVE/CLIHandler.pm | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index 9609181..1af9987 100644
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -158,12 +158,10 @@ __PACKAGE__->register_method ({
     parameters => {
 	additionalProperties => 0,
 	properties => {
-	    cmd => {
-		description => "Command name",
-		type => 'string',
-		optional => 1,
+	    'extra-args' => PVE::JSONSchema::get_standard_option('extra-args', {
+		description => 'Shows help for a specific command',
 		completion => $complete_command_names,
-	    },
+	    }),
 	    verbose => {
 		description => "Verbose output format.",
 		type => 'boolean',
@@ -178,9 +176,9 @@ __PACKAGE__->register_method ({
 
 	$assert_initialized->();
 
-	my $cmd = $param->{cmd};
+	my $cmd = $param->{'extra-args'};
 
-	my $verbose = defined($cmd) && $cmd; 
+	my $verbose = defined($cmd) && $cmd;
 	$verbose = $param->{verbose} if defined($param->{verbose});
 
 	if (!$cmd) {
@@ -438,7 +436,7 @@ sub setup_environment {
 my $handle_cmd  = sub {
     my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_;
 
-    $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
+    $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
 
     my $cmd_str = join(' ', @$args);
     my ($cmd, $def, $cmd_args) = resolve_cmd($args);
-- 
2.11.0





More information about the pve-devel mailing list