[pve-devel] applied: [PATCH common] SysFSTools: add return format comments

[Thomas Lamprecht]

On 11/23/18 2:50 PM, Dominik Csapak wrote:
> for lspci and get_mdev_types
> 
> Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
> ---
>  src/PVE/SysFSTools.pm | 33 +++++++++++++++++++++++++++++++++
>  1 file changed, 33 insertions(+)
> 
> diff --git a/src/PVE/SysFSTools.pm b/src/PVE/SysFSTools.pm
> index 2e7d028..2da3a38 100644
> --- a/src/PVE/SysFSTools.pm
> +++ b/src/PVE/SysFSTools.pm
> @@ -40,6 +40,28 @@ my $parse_pci_ids = sub {
>  #
>  # verbose also returns iommu groups, subvendor/device and the
>  # human readable names from /usr/share/misc/pci.ids
> +#
> +# return format:
> +# [
> +#     {
> +#         id => '00:00.0',
> +#         vendor => '0xabab',
> +#         device => '0xefef',
> +#         class => '0x012345',
> +#
> +#         # optional
> +#         iommugroup => '14',
> +#         mdev => 1,
> +#         vendor_name => 'Foo Inc.',
> +#         device_name => 'Bar 9000AF',
> +#         subsystem_vendor => '0xacac',
> +#         subsystem_device => '0xfefe',
> +#         subsystem_vendor_name => 'Foo Europe GmbH',
> +#         subsystem_device_name => 'Bar 9001AF OC',
> +#     },
> +#     ...
> +# ]
> +#
>  sub lspci {
>      my ($filter, $verbose) = @_;
>  
> @@ -112,6 +134,17 @@ sub lspci {
>      return $devices;
>  }
>  
> +#
> +# return format:
> +# [
> +#     {
> +#         type => 'FooType_1',
> +#         description => "a longer description with custom format\nand newlines",
> +#         available => 5,
> +#     },
> +#     ...
> +# ]
> +#
>  sub get_mdev_types {
>      my ($id) = @_;
>  
> 

applied, thanks!