}
# format option, display type and description
-# $k: option name
-# $display_name: for example "-$k" of "<$k>", pass undef to use "$k:"
+# $name: option name
+# $display_name: for example "-$name" of "<$name>", pass undef to use "$name:"
# $phash: json schema property hash
-# $format: 'asciidoc' or 'pod'
+# $format: 'asciidoc', 'pod' or 'text'
+# $style: 'config', 'arg' or 'fixed'
my $get_property_description = sub {
- my ($k, $display_name, $phash, $format, $hidepw) = @_;
+ my ($name, $style, $phash, $format, $hidepw) = @_;
my $res = '';
my $type = PVE::PodParser::schema_get_type_text($phash);
- if ($hidepw && $k eq 'password') {
+ if ($hidepw && $name eq 'password') {
$type = '';
}
if ($format eq 'asciidoc') {
- if (defined($display_name)) {
- $res .= "`$display_name` ";
+ if ($style eq 'config') {
+ $res .= "`$name`: ";
+ } elsif ($style eq 'arg') {
+ $res .= "`-$name` ";
+ } elsif ($style eq 'fixed') {
+ $res .= "`<$name>` ";
} else {
- $res .= "`$k:` ";
+ die "unknown style '$style'";
}
$res .= "`$type` " if $type;
$res .= "(default=`$dv`)";
}
$res .= "::\n\n";
- $res .= Text::Wrap::wrap('', '', ($descr)) . "\n";
+
+ my $wdescr = Text::Wrap::wrap('', '', ($descr));
+ chomp $wdescr;
+ $wdescr =~ s/^$/+/mg;
+
+ $res .= $wdescr . "\n";
if (my $req = $phash->{requires}) {
my $tmp .= ref($req) ? join(', ', @$req) : $req;
}
$res .= "\n";
- } elsif ($format eq 'pod') {
+ } elsif ($format eq 'pod' || $format eq 'text') {
my $defaulttxt = '';
if (defined(my $dv = $phash->{default})) {
$defaulttxt = " (default=$dv)";
}
- $display_name = "$k:" if !defined($display_name);
+ my $display_name;
+ if ($style eq 'config') {
+ $display_name = "$name:";
+ } elsif ($style eq 'arg') {
+ $display_name = "-$name";
+ } elsif ($style eq 'fixed') {
+ $display_name = "<$name>";
+ } else {
+ die "unknown style '$style'";
+ }
my $tmp = sprintf " %-10s %s$defaulttxt\n", $display_name, "$type";
my $indend = " ";
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, "<$k>", $prop->{$k}, $format, 0);
+ $argdescr .= &$get_property_description($k, 'fixed', $prop->{$k}, 'text', 0);
}
my $idx_param = {}; # -vlan\d+ -scsi\d+
$base = "${name}[n]";
}
- $opts .= &$get_property_description($k, "-$base", $prop->{$k}, $format, $hidepw);
+ $opts .= &$get_property_description($base, 'arg', $prop->{$k}, 'text', $hidepw);
if (!$prop->{$k}->{optional}) {
$args .= " " if $args;
# generate docs from JSON schema properties
sub dump_properties {
- my ($prop, $format, $filterFn) = @_;
+ my ($prop, $format, $style, $filterFn) = @_;
my $raw = '';
+ $style //= 'config';
+
my $idx_param = {}; # -vlan\d+ -scsi\d+
foreach my $k (sort keys %$prop) {
$base = "${name}[n]";
}
- $raw .= &$get_property_description($k, undef, $phash, $format, 0);
+ $raw .= &$get_property_description($base, $style, $phash, $format, 0);
}
return $raw;
}
+my $replace_file_names_with_contents = sub {
+ my ($param, $mapping) = @_;
+
+ if ($mapping) {
+ foreach my $elem ( @$mapping ) {
+ $param->{$elem} = PVE::Tools::file_get_contents($param->{$elem})
+ if defined($param->{$elem});
+ }
+ }
+
+ return $param;
+};
+
sub cli_handler {
- my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $pwcallback) = @_;
+ my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $pwcallback, $stringfilemap) = @_;
my $info = $self->map_method_by_name($name);
my $res;
eval {
my $param = PVE::JSONSchema::get_options($info->{parameters}, $args, $arg_param, $fixed_param, $pwcallback);
+ &$replace_file_names_with_contents($param, &$stringfilemap($name))
+ if defined($stringfilemap);
$res = $self->handle($info, $param);
};
if (my $err = $@) {