From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id EA668A0C50; Sat, 24 Jul 2021 14:07:20 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D81E340DDE; Sat, 24 Jul 2021 14:07:20 +0200 (CEST) Received: from shelob.oktetlabs.ru (shelob.oktetlabs.ru [91.220.146.113]) by mails.dpdk.org (Postfix) with ESMTP id 80BC44067A; Sat, 24 Jul 2021 14:07:19 +0200 (CEST) Received: from [192.168.100.116] (unknown [37.139.99.76]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by shelob.oktetlabs.ru (Postfix) with ESMTPSA id C16807F4FD; Sat, 24 Jul 2021 15:07:18 +0300 (MSK) DKIM-Filter: OpenDKIM Filter v2.11.0 shelob.oktetlabs.ru C16807F4FD DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=oktetlabs.ru; s=default; t=1627128439; bh=aX4Jt528wRRYuFpC1mKSu5QlTdl4bZxd0Igoaws5pvY=; h=Subject:To:Cc:References:From:Date:In-Reply-To; b=Q3C9lgwG4t7BJgG9vdSct0dMNEBp77hFEP7/apCOm2z8cun9jm3Rmuhkd8eX1dToI qbrO8kfj9Sq4Hfp+klktAcCQVb0pbsQk72j6I3ptjesJwC27i1g2/3P9QTjITwXDQY EbK8k8eJgm1x0h40UuvXLUO7IW1R2k9BAWEk6vk8= To: Ferruh Yigit , dev@dpdk.org, Thomas Monjalon , Kuba Kozak Cc: David Marchand , Ivan Ilchenko , stable@dpdk.org, Andy Moreton References: <20210604144225.287678-1-andrew.rybchenko@oktetlabs.ru> <20210723131515.2317168-1-andrew.rybchenko@oktetlabs.ru> <20210723131515.2317168-4-andrew.rybchenko@oktetlabs.ru> From: Andrew Rybchenko Message-ID: Date: Sat, 24 Jul 2021 15:07:18 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.12.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Subject: Re: [dpdk-dev] [PATCH v3 03/11] ethdev: fix docs of functions getting xstats by IDs X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On 7/23/21 5:42 PM, Ferruh Yigit wrote: > On 7/23/2021 2:15 PM, Andrew Rybchenko wrote: >> From: Ivan Ilchenko >> >> 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 >> Signed-off-by: Andrew Rybchenko >> Reviewed-by: Andy Moreton >> --- >> lib/ethdev/rte_ethdev.h | 23 ++++++++++++++--------- >> 1 file changed, 14 insertions(+), 9 deletions(-) >> >> diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h >> index d2b27c351f..28440c46d3 100644 >> --- a/lib/ethdev/rte_ethdev.h >> +++ b/lib/ethdev/rte_ethdev.h >> @@ -2873,12 +2873,15 @@ int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats, >> * The port identifier of the Ethernet device. >> * @param xstats_names >> * An rte_eth_xstat_name array of at least *size* elements to >> - * be filled. If set to NULL, the function returns the required number >> - * of elements. >> + * be filled. Must not be NULL if @p ids are specified (not NULL). >> * @param ids >> - * IDs array given by app to retrieve specific statistics >> + * IDs array given by app to retrieve specific statistics. May be NULL >> + * to retrieve all available statistics. >> * @param size >> - * The size of the xstats_names array (number of elements). >> + * If @p ids is not NULL, number of elements in the array with requested IDs >> + * and number of elements in @p xstats_names to put names in. If @p ids is >> + * NULL, number of elements in @p xstats_names to put all available statistics >> + * names in. >> * @return >> * - A positive value lower or equal to size: success. The return value >> * is the number of entries filled in the stats table. >> @@ -2886,7 +2889,7 @@ int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats, >> * is too small. The return value corresponds to the size that should >> * be given to succeed. The entries in the table are not valid and >> * shall not be used by the caller. >> - * - A negative value on error (invalid port id). >> + * - A negative value on error. >> */ >> int >> rte_eth_xstats_get_names_by_id(uint16_t port_id, >> @@ -2900,13 +2903,15 @@ rte_eth_xstats_get_names_by_id(uint16_t 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 >> + * statistics values function should retrieve. May be NULL to retrieve >> * all available statistics. > > 'ids' parameter in 'rte_eth_xstats_get_names_by_id()' & > 'rte_eth_xstats_get_by_id()' are exactly same thing, and description is same but > wording is different. > > Do you think does it make sense to use exact same wording, to clarify that there > is no difference in this parameter within APIs? I thought that I've fixed it, but it looks like I've lost it on the way. Will fix in v4. IMHO, it looks awkward if description is absolutely the same, but description structure should be definitely the same. >> * @param values >> * A pointer to a table to be filled with device statistics values. >> + * Must not be NULL if ids are specified (not NULL). > > Similar comment on this one, two different API get 'name' and 'value' part of > key-value pair. The description between APIs can be almost same. Will fix in v4 similar to above. >> * @param size >> - * The size of the ids array (number of elements). >> + * If @p ids is not NULL, number of elements in the array with requested IDs >> + * and number of elements in values to put statistics in. If @p ids is NULL, >> + * number of elements in values to put all available statistics in. > > And same comment again on using exact same comment on two APIs. It is almost the same since it refers to other parameters which differ. Other than that the description is equal. >> * @return >> * - A positive value lower or equal to size: success. The return value >> * is the number of entries filled in the stats table. >> @@ -2914,7 +2919,7 @@ rte_eth_xstats_get_names_by_id(uint16_t port_id, >> * is too small. The return value corresponds to the size that should >> * be given to succeed. The entries in the table are not valid and >> * shall not be used by the caller. >> - * - A negative value on error (invalid port id). >> + * - A negative value on error. >> */ >> int rte_eth_xstats_get_by_id(uint16_t port_id, const uint64_t *ids, >> uint64_t *values, unsigned int size); >>