Re: [dpdk-dev] [PATCH v5 1/2] ethdev: fix docs of functions getting xstats by IDs
From: Ferruh Yigit <hidden>
Date: 2021-09-28 16:46:43
On 9/28/2021 1:05 PM, Andrew Rybchenko wrote:
From: Ivan Ilchenko <redacted>
Document valid combinations of input arguments in accordance with
current implementation in ethdev.
Fixes: 79c913a42f0 ("ethdev: retrieve xstats by ID")
Cc: stable@dpdk.org
Signed-off-by: Ivan Ilchenko <redacted>
Signed-off-by: Andrew Rybchenko <redacted>
Reviewed-by: Andy Moreton <redacted>Reviewed-by: Ferruh Yigit <redacted> Only minor issue below.
quoted hunk ↗ jump to hunk
@@ -2926,22 +2928,23 @@ rte_eth_xstats_get_names_by_id(uint16_t port_id, * @param port_id * The port identifier of the Ethernet device. * @param ids - * A pointer to an ids array passed by application. This tells which - * statistics values function should retrieve. This parameter - * can be set to NULL if size is 0. In this case function will retrieve - * all available statistics. + * IDs array given by app to retrieve specific statistics. May be NULL to + * retrieve all available statistics or, if @p values is NULL as well, + * just the number of available statistics. * @param values - * A pointer to a table to be filled with device statistics values. + * Array to be filled in with requested device statistics. + * Must not be NULL if ids are specified (not NULL).
Minor issue, @p marker is missed before 'ids', comparing the 'rte_eth_xstats_get_names_by_id()' comment.