pass correct format to $get_property_description()

[pve-common.git] / src / PVE / RESTHandler.pm

diff --git a/src/PVE/RESTHandler.pm b/src/PVE/RESTHandler.pm
index 9e0980e9832ded60bae76730a14377f28b1c2b93..60e915ba840d0df75688e7193f8ecca54fb8a723 100644 (file)
--- a/src/PVE/RESTHandler.pm
+++ b/src/PVE/RESTHandler.pm
@@ -410,7 +410,7 @@ sub handle {
 # $format: 'asciidoc', 'pod' or 'text'
 # $style: 'config', 'arg' or 'fixed'
 my $get_property_description = sub {
-    my ($name, $style, $phash, $format, $hidepw) = @_;
+    my ($name, $style, $phash, $format, $hidepw, $fileparams) = @_;
 
     my $res = '';
 
@@ -426,6 +426,15 @@ my $get_property_description = sub {
        $type = '';
     }
 
+    if ($fileparams && $type eq 'string') {
+       foreach my $elem (@$fileparams) {
+           if ($name eq $elem) {
+               $type = 'filepath';
+               last;
+           }
+       }
+    }
+
     if ($format eq 'asciidoc') {
 
        if ($style eq 'config') {
@@ -508,8 +517,9 @@ my $get_property_description = sub {
 #   'full'     ... also include description
 #   'asciidoc' ... generate asciidoc for man pages (like 'full')
 # $hidepw      ... hide password option (use this if you provide a read passwork callback)
+# $stringfilemap ... mapping for string parameters to file path parameters
 sub usage_str {
-    my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $hidepw) = @_;
+    my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $hidepw, $stringfilemap) = @_;
 
     $format = 'long' if !$format;
 
@@ -542,7 +552,7 @@ sub usage_str {
     foreach my $k (@$arg_param) {
        next if defined($fixed_param->{$k}); # just to be sure
        next if !$prop->{$k}; # just to be sure
-       $argdescr .= &$get_property_description($k, 'fixed', $prop->{$k}, 'text', 0);
+       $argdescr .= &$get_property_description($k, 'fixed', $prop->{$k}, $format, 0);
     }
 
     my $idx_param = {}; # -vlan\d+ -scsi\d+
@@ -564,7 +574,9 @@ sub usage_str {
            $base = "${name}[n]";
        }
 
-       $opts .= &$get_property_description($base, 'arg', $prop->{$k}, 'text', $hidepw);
+       my $mapping = defined($stringfilemap) ? &$stringfilemap($name) : undef;
+       $opts .= &$get_property_description($base, 'arg', $prop->{$k}, $format,
+                                           $hidepw, $mapping);
 
        if (!$prop->{$k}->{optional}) {
            $args .= " " if $args;
@@ -661,7 +673,7 @@ sub cli_handler {
 
        die $err if !$ec || $ec ne "PVE::Exception" || !$err->is_param_exc();
        
-       $err->{usage} = $self->usage_str($name, $prefix, $arg_param, $fixed_param, 'short', $pwcallback);
+       $err->{usage} = $self->usage_str($name, $prefix, $arg_param, $fixed_param, 'short', $pwcallback, $stringfilemap);
 
        die $err;
     }