From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 36E25A046B for ; Wed, 24 Jul 2019 11:17:23 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 9DD641C1A1; Wed, 24 Jul 2019 11:17:21 +0200 (CEST) Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com [67.231.156.173]) by dpdk.org (Postfix) with ESMTP id 146961C19C for ; Wed, 24 Jul 2019 11:17:19 +0200 (CEST) Received: from pps.filterd (m0045851.ppops.net [127.0.0.1]) by mx0b-0016f401.pphosted.com (8.16.0.42/8.16.0.42) with SMTP id x6O99kew010161; Wed, 24 Jul 2019 02:17:19 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=from : to : cc : subject : date : message-id : references : in-reply-to : content-type : content-transfer-encoding : mime-version; s=pfpt0818; bh=IovyTgg1k3KZ85fwvGvcx1ZP2A+SIYzw9nZyXtBMX9c=; b=C0KIUvMrtQKvadbydWntDzQT5OcmiEIJneN25Oi+9aSjOSCKl6MAluARrhdxj32J4wTB nGKkfJ1Ng58c4lA8QSwic4zm+bxcHH6qCFzTIwYMyVC2xqMFkehipNEPxlN9uO5xTq77 YoJh2AXEckcKV9LwlubPBzSwIaam7QqK5K3XKJOXKiEapDHrq1S+lUIWxKhATucXsvw7 13/5guqDsQVQuzEf5nuyF551r+fvFpGOWtmBANChYprKEgAxx0VNvwHGC8DbzAV23bLo TRqP7DqObIRelbfZP98ZkqrcW0LcuydgJVCiRhj1J/R0iMZFT5br75ea7F+IJQjCZQ39 3w== Received: from sc-exch01.marvell.com ([199.233.58.181]) by mx0b-0016f401.pphosted.com with ESMTP id 2tx624u7ks-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Wed, 24 Jul 2019 02:17:19 -0700 Received: from SC-EXCH01.marvell.com (10.93.176.81) by SC-EXCH01.marvell.com (10.93.176.81) with Microsoft SMTP Server (TLS) id 15.0.1367.3; Wed, 24 Jul 2019 02:17:17 -0700 Received: from NAM04-CO1-obe.outbound.protection.outlook.com (104.47.45.50) by SC-EXCH01.marvell.com (10.93.176.81) with Microsoft SMTP Server (TLS) id 15.0.1367.3 via Frontend Transport; Wed, 24 Jul 2019 02:17:17 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=MRTl9sQ9gMYw4UOHPsfcODGxZhf3JpQ+W1Bu78BawhSS6YaW2geA2sP48a7z4USaJ4UWkzfLycsTlhcp6hIdMUb/vNtpFWWrb/dkAEHB9G2ycFEXl3bj2+LlaMRo4kpjt9v0CArGgHZDq0kaeLILvp73j7ZcZLRw46cCqFnbcLEOtWbLgJqkT43zesxrJEt3sW4/k67XNkIki1P5eVYL2UPgtzQyuK6purRdiz2SAe1cMGez8pwmD6tHa4L8zI6Doz361EAXA1dQ/83NdhGoK9vimNEDBMjmFfbrU3r/Bj5sQZv8UzEYfUwYetSetHZiTgJNPUCDxtFp1WOXS3QC7w== 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-SenderADCheck; bh=IovyTgg1k3KZ85fwvGvcx1ZP2A+SIYzw9nZyXtBMX9c=; b=kMqt06xrCpx3FLfGo56utuU1VKOsEdj9MpF6IAOFO0wDK/Kpo6BmLbH3Yx5DlZgBBMOHgponhZVD7QvgssTXhU1Pbn2sEojT7TedXRHpvo8z88hjRvqshrLyfV7WZ6H3CuYXUp4Mxz2BCSgzgaJSehZs4aEKegCdvC+GvugyjjKL1i8OKpjGvQgiTaDiR/oaijZVC/xBPv8QIb2j8B6KkZbU+ncEmCDc15uH2D0kZvxLa+/4zGAAYixuhlceTiDBtQv7D4jHdRg1u1Jyb5iL0WWOq56DRWOG9k3vUkIsR6+DUt+dLgvGDoz9jRv5983AccmFxUdaFxMmPMMsNaiNHg== ARC-Authentication-Results: i=1; mx.microsoft.com 1;spf=pass smtp.mailfrom=marvell.com;dmarc=pass action=none header.from=marvell.com;dkim=pass header.d=marvell.com;arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.onmicrosoft.com; s=selector2-marvell-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=IovyTgg1k3KZ85fwvGvcx1ZP2A+SIYzw9nZyXtBMX9c=; b=AFbd9N8GIbSMmLhjFVb3KLOaDqrhxgfLD7VLB0s7NGj2WHvlts61tvmPoVbzjm7MYvFizcewZcNASZ0sMzNPNeGwvQ+uY41dJFAuGh6XLPD7LOtFxuqR0OYfOh7x19nLBF31Jidjwu3I1qY8rIVJ47vxWG9VZQmejeoBKe3EGPo= Received: from BYAPR18MB2424.namprd18.prod.outlook.com (20.179.91.149) by BYAPR18MB2677.namprd18.prod.outlook.com (20.179.94.88) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.2115.10; Wed, 24 Jul 2019 09:17:16 +0000 Received: from BYAPR18MB2424.namprd18.prod.outlook.com ([fe80::2d42:12b6:aa2e:2862]) by BYAPR18MB2424.namprd18.prod.outlook.com ([fe80::2d42:12b6:aa2e:2862%4]) with mapi id 15.20.2094.013; Wed, 24 Jul 2019 09:17:15 +0000 From: Jerin Jacob Kollanukkaran To: Andrew Rybchenko , Thomas Monjalon , Ferruh Yigit CC: "dev@dpdk.org" Thread-Topic: [dpdk-dev] [PATCH] doc: add deprecation notice to fix ethdev API returning void Thread-Index: AQHVQWAUx3IQ0oR280ucBxocj9PuRabZfWbg Date: Wed, 24 Jul 2019 09:17:15 +0000 Message-ID: References: <1563890871-26901-1-git-send-email-arybchenko@solarflare.com> In-Reply-To: <1563890871-26901-1-git-send-email-arybchenko@solarflare.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [106.200.248.176] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 81d7d063-2d8a-4b17-0f95-08d71017b85f x-microsoft-antispam: BCL:0; PCL:0; RULEID:(2390118)(7020095)(4652040)(8989299)(4534185)(4627221)(201703031133081)(201702281549075)(8990200)(5600148)(711020)(4605104)(1401327)(2017052603328)(7193020); SRVR:BYAPR18MB2677; x-ms-traffictypediagnostic: BYAPR18MB2677: x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:7691; x-forefront-prvs: 0108A997B2 x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(4636009)(346002)(376002)(366004)(136003)(39860400002)(396003)(13464003)(199004)(189003)(71190400001)(71200400001)(74316002)(55016002)(305945005)(7736002)(53546011)(6506007)(186003)(6246003)(15650500001)(4326008)(446003)(3846002)(6116002)(229853002)(9686003)(14444005)(256004)(476003)(11346002)(486006)(52536014)(110136005)(68736007)(76176011)(478600001)(81156014)(81166006)(8936002)(86362001)(76116006)(25786009)(5660300002)(316002)(99286004)(66946007)(66476007)(66556008)(64756008)(66446008)(26005)(6436002)(2906002)(102836004)(53936002)(14454004)(7696005)(66066001)(33656002); DIR:OUT; SFP:1101; SCL:1; SRVR:BYAPR18MB2677; H:BYAPR18MB2424.namprd18.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; received-spf: None (protection.outlook.com: marvell.com does not designate permitted sender hosts) x-ms-exchange-senderadcheck: 1 x-microsoft-antispam-message-info: 6UEcZO5KWAGoRLzTXwWodl8T6Pv+H98IVm78mpslGN5vk68kck4Hkuq2Wq4AQ2hDp45uQFUkdGqFwXHnPs6AZ224sVH4V7kfp5Q8fOTQM5ywiZS4BwLAC2q4W98oZeNCTDYX3wQpJbQR63VS4BWKL6nkIft04bxcWUz4//F75n06Rd1eHLLRkHvkiD2qLpHnkrt05a5gL+Dd2krRCE+WbPEj/fjYreqK19nTiAxOuUrU+RbBzqZ+aVvLy7AE+1kjdtrGLJOkgiYrpI5Pgpzwi3cL0imZ9YVDKWerFmokBkQk0MyXLrexTvwtQA8FOHb+ddC+WZxCTGEYWH/3FszYDvM1wTRzBP4UohMzvSxZCOi5P3RBceDIRzhcSKBWMgHHv8GQDEa5NlpEuqAmS5IUPWmvsXWUUQyJBE+Z3bqVT+M= Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-MS-Exchange-CrossTenant-Network-Message-Id: 81d7d063-2d8a-4b17-0f95-08d71017b85f X-MS-Exchange-CrossTenant-originalarrivaltime: 24 Jul 2019 09:17:15.8065 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 70e1fb47-1155-421d-87fc-2e58f638b6e0 X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: jerinj@marvell.com X-MS-Exchange-Transport-CrossTenantHeadersStamped: BYAPR18MB2677 X-OriginatorOrg: marvell.com X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:5.22.84,1.0.8 definitions=2019-07-24_03:2019-07-23,2019-07-24 signatures=0 Subject: Re: [dpdk-dev] [PATCH] doc: add deprecation notice to fix ethdev API returning void X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 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" > -----Original Message----- > From: dev On Behalf Of Andrew Rybchenko > Sent: Tuesday, July 23, 2019 7:38 PM > To: Thomas Monjalon ; Ferruh Yigit > > Cc: dev@dpdk.org > Subject: [dpdk-dev] [PATCH] doc: add deprecation notice to fix ethdev API > returning void >=20 > void return value is bad for get API (like rte_eth_dev_info-get()) since = caller > does not know if the function does its job or not and output value is fil= led in. >=20 > void return value is bad for state changing API (like > rte_eth_promiscuous_enable()) since caller should use get API to > understand if state is really changed. >=20 > Signed-off-by: Andrew Rybchenko Acked-by: Jerin Jacob > --- > doc/guides/rel_notes/deprecation.rst | 14 ++++++++++++++ > 1 file changed, 14 insertions(+) >=20 > diff --git a/doc/guides/rel_notes/deprecation.rst > b/doc/guides/rel_notes/deprecation.rst > index 37b8592b6..79689f136 100644 > --- a/doc/guides/rel_notes/deprecation.rst > +++ b/doc/guides/rel_notes/deprecation.rst > @@ -59,6 +59,20 @@ Deprecation Notices > Target release for removal of the legacy API will be defined once most > PMDs have switched to rte_flow. >=20 > +* ethdev: update API functions returning ``void`` to return ``int`` > +with > + negative errno values to indicate various error conditions (e.g. > + invalid port ID, unsupported operation, failed operation): > + > + - ``rte_eth_dev_info_get`` > + - ``rte_eth_promiscuous_enable`` and ``rte_eth_promiscuous_disable`` > + - ``rte_eth_allmulticast_enable`` and > + ``rte_eth_allmulticast_disable`` > + - ``rte_eth_link_get`` and ``rte_eth_link_get_nowait`` > + - ``rte_eth_dev_stop`` > + - ``rte_eth_dev_close`` > + - ``rte_eth_xstats_reset`` > + - ``rte_eth_macaddr_get`` > + - ``rte_eth_dev_owner_delete`` > + > * cryptodev: support for using IV with all sizes is added, J0 still can > be used but only when IV length in following structs > ``rte_crypto_auth_xform``, > ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or= equal > -- > 2.17.1