return $result;
}
+# format option, display type and description
+# $name: option name
+# $display_name: for example "-$name" of "<$name>", pass undef to use "$name:"
+# $phash: json schema property hash
+# $format: 'asciidoc', 'pod' or 'text'
+# $style: 'config', 'arg' or 'fixed'
+my $get_property_description = sub {
+ my ($name, $style, $phash, $format, $hidepw) = @_;
+
+ my $res = '';
+
+ $format = 'asciidoc' if !defined($format);
+
+ my $descr = $phash->{description} || "no description available";
+
+ chomp $descr;
+
+ my $type = PVE::PodParser::schema_get_type_text($phash);
+
+ if ($hidepw && $name eq 'password') {
+ $type = '';
+ }
+
+ if ($format eq 'asciidoc') {
+
+ if ($style eq 'config') {
+ $res .= "`$name`: ";
+ } elsif ($style eq 'arg') {
+ $res .= "`-$name` ";
+ } elsif ($style eq 'fixed') {
+ $res .= "`<$name>` ";
+ } else {
+ die "unknown style '$style'";
+ }
+
+ $res .= "`$type` " if $type;
+
+ if (defined(my $dv = $phash->{default})) {
+ $res .= "(default=`$dv`)";
+ }
+ $res .= "::\n\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 .= "+\nNOTE: Requires option(s): `$tmp`\n";
+ }
+ $res .= "\n";
+
+ } elsif ($format eq 'pod' || $format eq 'text') {
+
+ my $defaulttxt = '';
+ if (defined(my $dv = $phash->{default})) {
+ $defaulttxt = " (default=$dv)";
+ }
+
+ 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 = " ";
+
+ $res .= Text::Wrap::wrap('', $indend, ($tmp));
+ $res .= "\n",
+ $res .= Text::Wrap::wrap($indend, $indend, ($descr)) . "\n\n";
+
+ if (my $req = $phash->{requires}) {
+ my $tmp = "Requires option(s): ";
+ $tmp .= ref($req) ? join(', ', @$req) : $req;
+ $res .= Text::Wrap::wrap($indend, $indend, ($tmp)). "\n\n";
+ }
+
+ } else {
+ die "unknown format '$format'";
+ }
+
+ return $res;
+};
+
# generate usage information for command line tools
#
# $name ... the name of the method
# 'long' ... default (list all options)
# 'short' ... command line only (one line)
# '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)
sub usage_str {
my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $hidepw) = @_;
}
}
- my $get_prop_descr = sub {
- my ($k, $display_name) = @_;
-
- my $phash = $prop->{$k};
-
- my $res = '';
-
- my $descr = $phash->{description} || "no description available";
- chomp $descr;
-
- my $type = PVE::PodParser::schema_get_type_text($phash);
-
- if ($hidepw && $k eq 'password') {
- $type = '';
- }
-
- my $defaulttxt = '';
- if (defined(my $dv = $phash->{default})) {
- $defaulttxt = " (default=$dv)";
- }
- my $tmp = sprintf " %-10s %s$defaulttxt\n", $display_name, "$type";
- my $indend = " ";
-
- $res .= Text::Wrap::wrap('', $indend, ($tmp));
- $res .= "\n",
- $res .= Text::Wrap::wrap($indend, $indend, ($descr)) . "\n\n";
-
- if (my $req = $phash->{requires}) {
- my $tmp = "Requires option(s): ";
- $tmp .= ref($req) ? join(', ', @$req) : $req;
- $res .= Text::Wrap::wrap($indend, $indend, ($tmp)). "\n\n";
- }
-
- return $res;
- };
-
my $argdescr = '';
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_prop_descr($k, "<$k>");
+ $argdescr .= &$get_property_description($k, 'fixed', $prop->{$k}, 'text', 0);
}
my $idx_param = {}; # -vlan\d+ -scsi\d+
$base = "${name}[n]";
}
- $opts .= &$get_prop_descr($k, "-$base");
+ $opts .= &$get_property_description($base, 'arg', $prop->{$k}, 'text', $hidepw);
if (!$prop->{$k}->{optional}) {
$args .= " " if $args;
}
}
- $out .= "USAGE: " if $format ne 'short';
-
- $out .= "$prefix $args";
-
- $out .= $opts ? " [OPTIONS]\n" : "\n";
+ if ($format eq 'asciidoc') {
+ $out .= "*${prefix}*";
+ $out .= " `$args`" if $args;
+ $out .= $opts ? " `[OPTIONS]`\n" : "\n";
+ } else {
+ $out .= "USAGE: " if $format ne 'short';
+ $out .= "$prefix $args";
+ $out .= $opts ? " [OPTIONS]\n" : "\n";
+ }
return $out if $format eq 'short';
- if ($info->{description} && $format eq 'full') {
- my $desc = Text::Wrap::wrap(' ', ' ', ($info->{description}));
- $out .= "\n$desc\n\n";
+ if ($info->{description}) {
+ if ($format eq 'asciidoc') {
+ my $desc = Text::Wrap::wrap('', '', ($info->{description}));
+ $out .= "\n$desc\n\n";
+ } elsif ($format eq 'full') {
+ my $desc = Text::Wrap::wrap(' ', ' ', ($info->{description}));
+ $out .= "\n$desc\n\n";
+ }
}
$out .= $argdescr if $argdescr;
return $out;
}
+# generate docs from JSON schema properties
+sub dump_properties {
+ my ($prop, $format, $style, $filterFn) = @_;
+
+ my $raw = '';
+
+ $style //= 'config';
+
+ my $idx_param = {}; # -vlan\d+ -scsi\d+
+
+ foreach my $k (sort keys %$prop) {
+ my $phash = $prop->{$k};
+
+ next if defined($filterFn) && &$filterFn($k, $phash);
+
+ my $type = $phash->{type} || 'string';
+
+ my $base = $k;
+ if ($k =~ m/^([a-z]+)(\d+)$/) {
+ my $name = $1;
+ next if $idx_param->{$name};
+ $idx_param->{$name} = 1;
+ $base = "${name}[n]";
+ }
+
+ $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 = $@) {
projects / pve-common.git / blobdiff