[pve-devel] [RFC common 9/9] cli: document $cmddef structure

[Dominik Csapak]

an example for an alias would be nice, but could be done in a follow up
Reviewed-by: Dominik Csapak <d.csapak at proxmox.com>

On 11/06/2017 02:54 PM, Thomas Lamprecht wrote:
> ---
>   src/PVE/CLIHandler.pm | 22 ++++++++++++++++++++++
>   1 file changed, 22 insertions(+)
> 
> diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
> index 5111b7a..a771e40 100644
> --- a/src/PVE/CLIHandler.pm
> +++ b/src/PVE/CLIHandler.pm
> @@ -10,6 +10,28 @@ use PVE::INotify;
>   
>   use base qw(PVE::RESTHandler);
>   
> +# $cmddef defines which (sub)commands are available in a specific CLI class.
> +# A real command is always an array consisting of its class, name, array of
> +# position fixed (required) parameters and hash of predefined parameters when
> +# mapping a CLI command t o an API call. Optionally an output method can be
> +# passed at the end, e.g., for formatting or transformation purpose.
> +#
> +# [class, name, fixed_params, API_pre-set params, output_sub ]
> +#
> +# In case of so called 'simple commands', the $cmddef can be also just an
> +# array.
> +#
> +# Examples:
> +# $cmddef = {
> +#     command => [ 'PVE::API2::Class', 'command', [ 'arg1', 'arg2' ], { node => $nodename } ],
> +#     do => {
> +#	  this => [ 'PVE::API2::OtherClass', 'method', [ 'arg1' ], undef, sub {
> +#	      my ($res) = @_;
> +#	      print "$res\n";
> +#	  }],
> +#	  that => [ 'PVE::API2::OtherClass', 'subroutine' [] ],
> +#     },
> +# }
>   my $cmddef;
>   my $exename;
>   my $cli_handler_class;
>