proxmox-mirrors/pve-common
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-common synced 2025-08-09 18:03:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

PVE::RESTHandler::generate_usage_str - new static method to generate usage from $info

Browse Source 
This is useful to generate usage information with pveclient, where we do not have
handler classes at all.

Signed-off-by: Dietmar Maurer <dietmar@proxmox.com>
This commit is contained in:
Dietmar Maurer 2018-07-06 09:30:07 +02:00 committed by Thomas Lamprecht
parent c850b99883
commit c03b750906
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/PVE/RESTHandler.pm
View File

@ -566,7 +566,7 @@ my $compute_param_mapping_hash = sub {
# generate usage information for command line tools # generate usage information for command line tools
# #
# $name ... the name of the method # $info ... method info
# $prefix ... usually something like "$exename $cmd" ('pvesm add') # $prefix ... usually something like "$exename $cmd" ('pvesm add')
# $arg_param ... list of parameters we want to get as ordered arguments # $arg_param ... list of parameters we want to get as ordered arguments
# on the command line (or single parameter name for lists) # on the command line (or single parameter name for lists)
@ -577,13 +577,13 @@ my $compute_param_mapping_hash = sub {
# 'full' ... text, include description # 'full' ... text, include description
# 'asciidoc' ... generate asciidoc for man pages (like 'full') # 'asciidoc' ... generate asciidoc for man pages (like 'full')
# $param_cb ... mapping for string parameters to file path parameters # $param_cb ... mapping for string parameters to file path parameters
sub usage_str { sub getopt_usage {
my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $param_cb) = @_; my ($info, $prefix, $arg_param, $fixed_param, $format, $param_cb) = @_;
$format = 'long' if !$format; $format = 'long' if !$format;
my $info = $self->map_method_by_name($name);
my $schema = $info->{parameters}; my $schema = $info->{parameters};
my $name = $info->{name};
my $prop = $schema->{properties}; my $prop = $schema->{properties};
my $out = ''; my $out = '';
@ -679,6 +679,14 @@ sub usage_str {
return $out; return $out;
} }
sub usage_str {
my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $param_cb) = @_;
my $info = $self->map_method_by_name($name);
return getopt_usage($info, $prefix, $arg_param, $fixed_param, $format, $param_cb);
}
# generate docs from JSON schema properties # generate docs from JSON schema properties
sub dump_properties { sub dump_properties {
my ($prop, $format, $style, $filterFn) = @_; my ($prop, $format, $style, $filterFn) = @_;