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 2B40942FB3; Wed, 2 Aug 2023 04:20:33 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id B1FA6410DC; Wed, 2 Aug 2023 04:20:32 +0200 (CEST) Received: from APC01-PSA-obe.outbound.protection.outlook.com (mail-psaapc01on2084.outbound.protection.outlook.com [40.107.255.84]) by mails.dpdk.org (Postfix) with ESMTP id CFC3A40DDB for ; Wed, 2 Aug 2023 04:20:30 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=VDm5VMZdMrx/7+mv599PhACdDiDErYIEbOO5xecIctMAsPNO6/d3KhNyFfkqzvGS3+HiWav5X0eLJCDXLntTX80qgUKTUeE22AkGUstPyvwzm03nyX1yILVkIHC1ncAnUahfky4svpDAfqK/QNEqGdJv9f7ZmSyfGIvWT9Q1gDfrvS+Cf8t45ik+BJYAaANAxfYjiIECxaFnw7niWixocMx4jS2K+IIHEfie4Ro/NLTuyWtc9t9B143md354EkVX4F2qs4KyNZzg2Rg3WcC2ROzFhIjQqdAjIfz0s/Il4FCHcTmhLc4ui7rqoKvYWsmmNzCwH4dIDPtosDhn3huwrw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=kxwGMb8svtaAYR6wRc6UhlsPHL9bpICNssRytIH4MpA=; b=IL9VC20lN+CjuoA4LHmLnTNXzJzoiN6yT9uiUk+8/wUQy05s59zs6zxCmLCV798rJ4czMionoqP2pWW4EJV+T0EVG55rV/zbjH/bL/ZkzqYshJT2vgMQRUlTcHiIwqg/z3KMt/pfTa9KFGbaiUJCak3MdMJKyIkTnaUx6bQ3SphihtBgFdujKfrmbkuHENiTP6iSux+TOVSRqScZ2o9btCm89GpR8fdeFr+gpY2yNho3IpueeKi+xD9Bs8jFOH3xi6cCp6MfbcwYnuHN1Sr53dxCn8bFdnm+ZNfYcM8sm/I7pharYqJwmVd/W4eX7jiSDmt9WAcDIE21uUPOX+qkGw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=jaguarmicro.com; dmarc=pass action=none header.from=jaguarmicro.com; dkim=pass header.d=jaguarmicro.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jaguarmicro.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=kxwGMb8svtaAYR6wRc6UhlsPHL9bpICNssRytIH4MpA=; b=NNh7ZfOQN6PdR3rnqOnaR24qJ/ft/VXns66IK7XJsmE8g6C4JtBCfDrubfXcpoKqNIolkehgZdYYaRhhGhY82M07506qhIGqNP8hGI7X68/KiXqyRrEg03I9zo60RKXehn3P+MPQwk2gaNs4C5QxwEO0Y6VWJN/dnDj6YxzP9iykIe5YziGgKQL+UxIr38wUmSJ1jr5DgFsE2hWZ1bctUNOzk36sqLQA1Z7Y2X4gl3JqPK7XWSkfiRvv/TUFG2COPK+YayvTmx69SEskJwqqZOOXAMcHX/2KXeyBe8sAQArbGNe5KCMyHJrfxi1ow5HvmA4o4m2PAKWIYbJvyHZ6dQ== Received: from SI2PR06MB4752.apcprd06.prod.outlook.com (2603:1096:4:14c::14) by TY0PR06MB5032.apcprd06.prod.outlook.com (2603:1096:400:1bc::12) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6631.44; Wed, 2 Aug 2023 02:20:27 +0000 Received: from SI2PR06MB4752.apcprd06.prod.outlook.com ([fe80::15e:6c71:d71:e1a9]) by SI2PR06MB4752.apcprd06.prod.outlook.com ([fe80::15e:6c71:d71:e1a9%7]) with mapi id 15.20.6631.045; Wed, 2 Aug 2023 02:20:27 +0000 From: Rma Ma To: dpdk-dev CC: Olivier Matz , Andrew Rybchenko Subject: Re: [PATCH v1] mempool: fix some errors in html api Thread-Topic: [PATCH v1] mempool: fix some errors in html api Thread-Index: AQHZrXYd3ONlG9FKB0O1cZZ31QgOeq/WczeO Date: Wed, 2 Aug 2023 02:20:27 +0000 Message-ID: References: <20230703061743.10576-1-rma.ma@jaguarmicro.com> In-Reply-To: <20230703061743.10576-1-rma.ma@jaguarmicro.com> Accept-Language: en-US, en-GB, en-VI, zh-CN, en-AS Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: msip_labels: authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=jaguarmicro.com; x-ms-publictraffictype: Email x-ms-traffictypediagnostic: SI2PR06MB4752:EE_|TY0PR06MB5032:EE_ x-ms-office365-filtering-correlation-id: 79611d90-5e77-4528-0454-08db92ff0923 x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: yzoN1xNVvQLkT2/fBcTuqgQDZER15ghSbQDgFczv3+ty4oNvFZVBgFYbVpEjLNe91BQSfBJJO3PgFHiCHTmB5iZa4evp3XlwjnDCXVoTudP7B+CuVyqLxRXGTcZ+sjuLMT8gm26HPT6EX2SbWOGMK4WJkc71l+OLG/T/eVE2rex0vb/O5QtYgDe45R65Axx2gbVA9Ulg6q8W3wHugZdZeULWDt3TwKJU5PMWeQlUZJsUm/wR+LbUUfAQsdb5P5nDvgNv13nP8862Ye16AdH7m5RySymaHbwpLvK9KBy+d1zE5XspnefZweul1Ri10hRC0q+vZ0w7XjmOPKF9FGJFqnsI3QgHnafUim7b1s90ilP8GhlTpUtzzEEQ7HFk/lNZWfPcDfgL3cXn+DhgzX7HHHtZZgphA/evySW3QkURQUdcXO0IKZYxNzEjKPjxaOk4X/y09vj6LAcYExF2kqrF1jPMC2JiOApwhUaLYIEhMTZT/WhH3YqX+3R/a+dG7ItwB0mSjlWspCYsNAH8cav6ESyE3+glZSkWB7zpSjCCf6abmVOr+IT8B4OKdMSCg4o43VcpG16q8Zd5dicNbdCMG94x0J/0srAeTzYMPL6hVY4= x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:SI2PR06MB4752.apcprd06.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230028)(346002)(136003)(396003)(39830400003)(376002)(366004)(451199021)(5660300002)(52536014)(86362001)(19627405001)(8936002)(8676002)(44832011)(38070700005)(41300700001)(91956017)(6916009)(66446008)(76116006)(66556008)(66946007)(66476007)(64756008)(2906002)(122000001)(4326008)(38100700002)(166002)(54906003)(478600001)(33656002)(9686003)(71200400001)(7696005)(966005)(316002)(55016003)(83380400001)(53546011)(6506007)(186003)(26005); DIR:OUT; SFP:1101; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?5lOs7XKnvxgHqKldNvsNKx9HpvhsJzIHxeoxHG9P4qy5C2SxtAsuawSQN5zp?= =?us-ascii?Q?xtMPeYe1apr7k3rxkIuSrGusKJAXhrOYVu1mtXPjcBMyvtBeSxjTZYDErYpk?= =?us-ascii?Q?OFjUY31NxcNCZWTKg43AY4E3uKC8v3qmYyaIFmMsgua0wJAucvNBDGlpW1lK?= =?us-ascii?Q?fUAhd1ShlkM448a6uVC44Uvsh8kH/WICWgse6NryAIr+51bUhBoGohBTHVaA?= =?us-ascii?Q?tn0M6drWkAlEIumzIEvAZlkrPz8pILmNoODqQfY71kduVeeN1pLnaKPBvPWK?= =?us-ascii?Q?/oHwRqO2ZByMF8OcKHs8oKzxMNGkyYCpWg6F7DnIKLURPXYjEY7IZiRxA/73?= =?us-ascii?Q?ynvuu3oE6YJT1B6BzWMK+T9j+sw75+nniQlkANsqlCmn74fqxeoHVWe9E8dG?= =?us-ascii?Q?rX6G35C5YzK4w7syDiyeHhWxBJfIx84LQK/zmjS+dLmju/4Ys5ExeoUfCJcH?= =?us-ascii?Q?JQBWggFUR/sv/1MUx9Vo445ADzuZSa+UuYFN+uzn02gNb34O/aK4aZxSP3hN?= =?us-ascii?Q?6EJmxO0ZsM9zFOrYqcqEJ4SMd59jEVgzqow+jUCTdntzm2K2Yin1efN3LjXB?= =?us-ascii?Q?UeNvucstWyWwAKTgpaSQPWjisk1YzWDszvCk7XDm543lTUFQzhVBz8Zx2esb?= =?us-ascii?Q?nwfkRfeBk6UlsHRVj8fO5DJogrr/8oKITe8kKlUDQl1T4IYVrvbEyqcLu69O?= =?us-ascii?Q?bTwqTGUkF5PwyVWR6gyeHUKA/zn9Ebe5ivdAJx5M6vY3wbc3Ne1n88qevUmb?= =?us-ascii?Q?w9G8riGwJZtqfU3HA1UvoaEvCVn2BjyXxjUw1IzeOd23bkjFzOmeuWZ4ZMFV?= =?us-ascii?Q?Y9LlKNUYNjQiW7X631JIgG+hHmjsStJj14c8NacmDDWBjcBPd49PJNQ3WDB5?= =?us-ascii?Q?IDh/W9hG9WJRo6ntTri/S+UM71/CSJ790KyKDLC7knlYJDl1XESmSa9Pe+7m?= =?us-ascii?Q?8MxIfBY+w6IDAMGD4MVPZFojRCyRHke5clCyAXpL5O2wFnEBpHNgsrDuCnDZ?= =?us-ascii?Q?YsCYtLqMKjIX8ZRa8H3iPgcL0EDJS/AxNji4hDnHeR1I+KglwJV754q3EuYn?= =?us-ascii?Q?sEVEopxCxLx3tII3KS2NNbmXHpDG7Znqb6pgafUW+bRFDLpSd64unOzLKJRU?= =?us-ascii?Q?nbPI4im3b0tElELu6qAq7JfTGOn2grH+SwBEOh3gTfG1s3Gmat1DKd5PNEEF?= =?us-ascii?Q?cyqN+suDyekWT58LG9kVi5gQB74u7RlMKqiJbQ5yMWB6RCQbjgA2dzeysSxn?= =?us-ascii?Q?GFAjz1ZsfnpqkkJoh8dk+zULuK8AAspgO7X5apubCgRdC4CKatUqY520q9j8?= =?us-ascii?Q?PjsCs+/ul6gnY5WmliYI8nkCZ7+Ze6OCO+AoCwh3gCDRGihEzpD0KodgSKe3?= =?us-ascii?Q?F5++ANqjSdCd6hU8r21LBIyGpRRytvJqL4wRKhimK70/Pkw1tSuocBzol9Qw?= =?us-ascii?Q?y8rhTrKIylo15tCV8yCfptL2Lt75cOkLwgS7QmqWrd2W7BeCUvi2q7HUxeDy?= =?us-ascii?Q?8gNtF0HJ1WXcozJPPL+9HJaRH/uAjwh3EHbILmXoo5Vi7BDQLdOOP23M/oMH?= =?us-ascii?Q?tRUygGgEqnMrnhe05YCyTG6Lllmzaiu4i40MYSPZ?= Content-Type: multipart/alternative; boundary="_000_SI2PR06MB4752B6F16A78702C95552E14990BASI2PR06MB4752apcp_" MIME-Version: 1.0 X-OriginatorOrg: jaguarmicro.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: SI2PR06MB4752.apcprd06.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 79611d90-5e77-4528-0454-08db92ff0923 X-MS-Exchange-CrossTenant-originalarrivaltime: 02 Aug 2023 02:20:27.0196 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 1e45a5c2-d3e1-46b3-a0e6-c5ebf6d8ba7b X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: /8YQHwMZQ6CorSnu9El/IRG0aXv+178+UxYYv9VsYyABJ7yYsLoB54ojGW0vAhHaPMZt+xzU0342QSp7T1AYVA== X-MS-Exchange-Transport-CrossTenantHeadersStamped: TY0PR06MB5032 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 --_000_SI2PR06MB4752B6F16A78702C95552E14990BASI2PR06MB4752apcp_ Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Hi, I know, it's a simple, no-impact patch for dpdk functionality. However, this can be misleading for app programs. When the return value of the interface is judged against -ENOENT, this will= cause the program to error out. It also affects the presentation of the api documentation: https://doc.dpdk.org/api/rte__mempool_8h.html#a0d326354d53ef5068d86a8b7d9ec= 2d61 I'm not sure if this needs to be fixed or not. > Subject: [PATCH v1] mempool: fix some errors in html api > > This patch fix some error descriptions of return value in mempool api whi= ch > affect in html api. > > Signed-off-by: Rma Ma > > --- > lib/mempool/rte_mempool.h | 12 ++++++------ > 1 file changed, 6 insertions(+), 6 deletions(-) > Best wishes, Rma ________________________________ From: Rma Ma Sent: Monday, July 3, 2023 14:18 To: dpdk-dev Cc: Olivier Matz ; Andrew Rybchenko ; Rma Ma Subject: [PATCH v1] mempool: fix some errors in html api This patch fix some error descriptions of return value in mempool api which affect in html api. Signed-off-by: Rma Ma --- lib/mempool/rte_mempool.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/mempool/rte_mempool.h b/lib/mempool/rte_mempool.h index 160975a7e7..d4d707533a 100644 --- a/lib/mempool/rte_mempool.h +++ b/lib/mempool/rte_mempool.h @@ -1610,7 +1610,7 @@ rte_mempool_do_generic_get(struct rte_mempool *mp, vo= id **obj_table, * Get several objects from the mempool. * * If cache is enabled, objects will be retrieved first from cache, - * subsequently from the common pool. Note that it can return -ENOENT when + * subsequently from the common pool. Note that it can return -ENOBUFS whe= n * the local cache and common pool are empty, even if cache from other * lcores are full. * @@ -1624,7 +1624,7 @@ rte_mempool_do_generic_get(struct rte_mempool *mp, vo= id **obj_table, * A pointer to a mempool cache structure. May be NULL if not needed. * @return * - 0: Success; objects taken. - * - -ENOENT: Not enough entries in the mempool; no object is retrieved. + * - -ENOBUFS: Not enough entries in the mempool; no object is retrieved= . */ static __rte_always_inline int rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table, @@ -1646,7 +1646,7 @@ rte_mempool_generic_get(struct rte_mempool *mp, void = **obj_table, * mempool creation time (see flags). * * If cache is enabled, objects will be retrieved first from cache, - * subsequently from the common pool. Note that it can return -ENOENT when + * subsequently from the common pool. Note that it can return -ENOBUFS whe= n * the local cache and common pool are empty, even if cache from other * lcores are full. * @@ -1658,7 +1658,7 @@ rte_mempool_generic_get(struct rte_mempool *mp, void = **obj_table, * The number of objects to get from the mempool to obj_table. * @return * - 0: Success; objects taken - * - -ENOENT: Not enough entries in the mempool; no object is retrieved. + * - -ENOBUFS: Not enough entries in the mempool; no object is retrieved= . */ static __rte_always_inline int rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsigned in= t n) @@ -1677,7 +1677,7 @@ rte_mempool_get_bulk(struct rte_mempool *mp, void **o= bj_table, unsigned int n) * mempool creation (see flags). * * If cache is enabled, objects will be retrieved first from cache, - * subsequently from the common pool. Note that it can return -ENOENT when + * subsequently from the common pool. Note that it can return -ENOBUFS whe= n * the local cache and common pool are empty, even if cache from other * lcores are full. * @@ -1687,7 +1687,7 @@ rte_mempool_get_bulk(struct rte_mempool *mp, void **o= bj_table, unsigned int n) * A pointer to a void * pointer (object) that will be filled. * @return * - 0: Success; objects taken. - * - -ENOENT: Not enough entries in the mempool; no object is retrieved. + * - -ENOBUFS: Not enough entries in the mempool; no object is retrieved= . */ static __rte_always_inline int rte_mempool_get(struct rte_mempool *mp, void **obj_p) -- 2.17.1 --_000_SI2PR06MB4752B6F16A78702C95552E14990BASI2PR06MB4752apcp_ Content-Type: text/html; charset="us-ascii" Content-Transfer-Encoding: quoted-printable
Hi,

I know, it's a simple, no-impact patch for dpdk functionality.
However, this can be misleading for app progr= ams.
When the return value of the interface is jud= ged against -ENOENT, this will cause the program to error out.
It also affects the presentation of the api d= ocumentation:
https://doc.dpdk.org/api/rte__mempool_8h.html#a0d326354d53ef5068d86a8= b7d9ec2d61

I'm not sure if this needs to be fixed or not.


> Subject: [PATCH v1] mempool: fix some errors in html api 

>  

> This patch fix some error descriptions of return value in mempool api = which 

> affect in html api. 

>  

> Signed-off-by: Rma Ma <rma.ma@jaguarmicro.com> 

> --- 

>  lib/mempool/rte_mempool.h | 12 ++++++------&= nbsp;

>  1 file changed, 6 insertions(+), 6 deletions(-) 

>  




Best wis= hes,

Rma

From: Rma Ma
Sent: Monday, July 3, 2023 14:18
To: dpdk-dev <dev@dpdk.org>
Cc: Olivier Matz <olivier.matz@6wind.com>; Andrew Rybchenko &l= t;andrew.rybchenko@oktetlabs.ru>; Rma Ma <rma.ma@jaguarmicro.com><= br> Subject: [PATCH v1] mempool: fix some errors in html api
 
This patch fix some error descriptions of
return value in mempool api which affect in html api.

Signed-off-by: Rma Ma <rma.ma@jaguarmicro.com>
---
 lib/mempool/rte_mempool.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/lib/mempool/rte_mempool.h b/lib/mempool/rte_mempool.h
index 160975a7e7..d4d707533a 100644
--- a/lib/mempool/rte_mempool.h
+++ b/lib/mempool/rte_mempool.h
@@ -1610,7 +1610,7 @@ rte_mempool_do_generic_get(struct rte_mempool *mp, vo= id **obj_table,
  * Get several objects from the mempool.
  *
  * If cache is enabled, objects will be retrieved first from cache, - * subsequently from the common pool. Note that it can return -ENOENT when=
+ * subsequently from the common pool. Note that it can return -ENOBUFS whe= n
  * the local cache and common pool are empty, even if cache from othe= r
  * lcores are full.
  *
@@ -1624,7 +1624,7 @@ rte_mempool_do_generic_get(struct rte_mempool *mp, vo= id **obj_table,
  *   A pointer to a mempool cache structure. May be NULL if= not needed.
  * @return
  *   - 0: Success; objects taken.
- *   - -ENOENT: Not enough entries in the mempool; no object is = retrieved.
+ *   - -ENOBUFS: Not enough entries in the mempool; no object is= retrieved.
  */
 static __rte_always_inline int
 rte_mempool_generic_get(struct rte_mempool *mp, void **obj_table,
@@ -1646,7 +1646,7 @@ rte_mempool_generic_get(struct rte_mempool *mp, void = **obj_table,
  * mempool creation time (see flags).
  *
  * If cache is enabled, objects will be retrieved first from cache, - * subsequently from the common pool. Note that it can return -ENOENT when=
+ * subsequently from the common pool. Note that it can return -ENOBUFS whe= n
  * the local cache and common pool are empty, even if cache from othe= r
  * lcores are full.
  *
@@ -1658,7 +1658,7 @@ rte_mempool_generic_get(struct rte_mempool *mp, void = **obj_table,
  *   The number of objects to get from the mempool to obj_t= able.
  * @return
  *   - 0: Success; objects taken
- *   - -ENOENT: Not enough entries in the mempool; no object is = retrieved.
+ *   - -ENOBUFS: Not enough entries in the mempool; no object is= retrieved.
  */
 static __rte_always_inline int
 rte_mempool_get_bulk(struct rte_mempool *mp, void **obj_table, unsign= ed int n)
@@ -1677,7 +1677,7 @@ rte_mempool_get_bulk(struct rte_mempool *mp, void **o= bj_table, unsigned int n)
  * mempool creation (see flags).
  *
  * If cache is enabled, objects will be retrieved first from cache, - * subsequently from the common pool. Note that it can return -ENOENT when=
+ * subsequently from the common pool. Note that it can return -ENOBUFS whe= n
  * the local cache and common pool are empty, even if cache from othe= r
  * lcores are full.
  *
@@ -1687,7 +1687,7 @@ rte_mempool_get_bulk(struct rte_mempool *mp, void **o= bj_table, unsigned int n)
  *   A pointer to a void * pointer (object) that will be fi= lled.
  * @return
  *   - 0: Success; objects taken.
- *   - -ENOENT: Not enough entries in the mempool; no object is = retrieved.
+ *   - -ENOBUFS: Not enough entries in the mempool; no object is= retrieved.
  */
 static __rte_always_inline int
 rte_mempool_get(struct rte_mempool *mp, void **obj_p)
--
2.17.1

--_000_SI2PR06MB4752B6F16A78702C95552E14990BASI2PR06MB4752apcp_--