From patchwork Tue Oct 25 13:32:38 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ali Alnubani X-Patchwork-Id: 119106 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 194F0A054A; Tue, 25 Oct 2022 15:33:07 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BD10342847; Tue, 25 Oct 2022 15:33:06 +0200 (CEST) Received: from NAM04-BN8-obe.outbound.protection.outlook.com (mail-bn8nam04on2083.outbound.protection.outlook.com [40.107.100.83]) by mails.dpdk.org (Postfix) with ESMTP id 3BDD6427FF for ; Tue, 25 Oct 2022 15:33:05 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=aab/UVOVPkwlntW/zCvYHq96+ADgP/xSCZygu5YhhyIoWQk7am7VzeXAUJsNoD8NfsJvz/EV25606rjhRPpBXiWKpvud+gEfxtoCOVb2wJ0/txO1fi+zmymsdqjB/ZAAFCAoH/E1CJyyMmfSFMkuKs+Hfst6zvEiyVk52fIMa1DURLNYTvbz5Z+BJtrZdjQ3IYOZTd4gDggvT6KKnQ0+ogSs6ek8J/NUlLwGziHEc7OMCoBaHGt3bHmhleiznAy0/ajZ5a9qAV7MDNzGobKdVwpGkPPIdi3yGa0kdvHa0rO/zi8rSzYhYirGPra4LBVjiG0erubojyCWQuBwv3Kd6Q== 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=cnHlqfOZBV8ZOupNPRjp5hbshD9Gj4nAAdk9HyXRI7A=; b=WEck4Xn/vcsvor9JIkDytoYytDSJCaZ3LLbuAWvNuZON5B1bK8HYDErc7x16dTsLhiZ0ilxrho7kLXO9750Y45eetiwCT/DCImVblbezb3Ts86ZNJjSm4kMHMVS/QCrrAXhGSPEXt4bWLNA2QS8qa3GdX5e0sVbJ5W9dDdxxGPo1Ow3e82arxkrv0E/jgGHXZ8hT/NI72zReKo8XR9m7IVI+SUJVULSv9FP8GRBJn3t4SYaibA4mCoQ7QShTDMFrx12QBHeJFA+uZOlIdl3p6wnXGpECX4yiHY+0qRdxnYcgtb6SOMU0aXmEQxfkz8nXKfJ8LpYZwrcq/AcTR5PKog== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.117.160) smtp.rcpttodomain=dpdk.org smtp.mailfrom=nvidia.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=nvidia.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=cnHlqfOZBV8ZOupNPRjp5hbshD9Gj4nAAdk9HyXRI7A=; b=MpDR6FKp1/x5oeACpizN9F7l62jL0qNrjSvsPXB/P4277UEcYvRw8pWwlcWKklafeLGWtOuhbeUOE0xyqU2Gz8Hi4JN1uhTlDOGFRRzt8Bk2k/XvP2xJ62pRprkXwVlsc0YfUZc0NlkE6r2W8ThoXM46oESrTRYd7Pg+POcXwARUW/L9jTtw+u/67YpqjwaIXrbbKh6/EmHyBmKUa3kfCZNO59WMJR39UbzdAk4XDg/pp5ebEkg1XbEj+gWBRTpk6OtiE/f3XCuIU9aj2aUvfPjHeKsQhBvMig5HB28Dj1nLUunD8L3uaZGdu52dcdJGPvfUIqsANNrBqXVkQJW9dA== Received: from MW4P221CA0013.NAMP221.PROD.OUTLOOK.COM (2603:10b6:303:8b::18) by PH0PR12MB5484.namprd12.prod.outlook.com (2603:10b6:510:eb::14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5746.26; Tue, 25 Oct 2022 13:33:03 +0000 Received: from CO1NAM11FT017.eop-nam11.prod.protection.outlook.com (2603:10b6:303:8b:cafe::b8) by MW4P221CA0013.outlook.office365.com (2603:10b6:303:8b::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5746.28 via Frontend Transport; Tue, 25 Oct 2022 13:33:03 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.117.160) smtp.mailfrom=nvidia.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=nvidia.com; Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates 216.228.117.160 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.117.160; helo=mail.nvidia.com; pr=C Received: from mail.nvidia.com (216.228.117.160) by CO1NAM11FT017.mail.protection.outlook.com (10.13.175.108) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5746.16 via Frontend Transport; Tue, 25 Oct 2022 13:33:03 +0000 Received: from rnnvmail201.nvidia.com (10.129.68.8) by mail.nvidia.com (10.129.200.66) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.26; Tue, 25 Oct 2022 06:32:53 -0700 Received: from nvidia.com (10.126.231.35) by rnnvmail201.nvidia.com (10.129.68.8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.29; Tue, 25 Oct 2022 06:32:52 -0700 From: Ali Alnubani To: Subject: [PATCH v2] lib: remove empty return types from doxygen comments Date: Tue, 25 Oct 2022 16:32:38 +0300 Message-ID: <20221025133238.3211967-1-alialnu@nvidia.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20221025132220.3209578-1-alialnu@nvidia.com> References: <20221025132220.3209578-1-alialnu@nvidia.com> MIME-Version: 1.0 X-Originating-IP: [10.126.231.35] X-ClientProxiedBy: rnnvmail202.nvidia.com (10.129.68.7) To rnnvmail201.nvidia.com (10.129.68.8) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CO1NAM11FT017:EE_|PH0PR12MB5484:EE_ X-MS-Office365-Filtering-Correlation-Id: 9ab93d7a-43c9-4032-ff73-08dab68d7135 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: wpgwZ9LGIUYnZP+xs/apeswKpPR8mHzv1MhwevCbdRbGCEnIL8cBVYuQGCvFYnsxv02resjNSCRopD3rlY230117EsJE9+ZyKu4uaSvk3Cdzx7mPiW/LfPCrssKG08nweAMCjTWD4FnwBypVyi0N54N/IiMztU6uW1GKn0Y67LCoK4HZnsss/9DmFhoqZ8e1dGWYGFwaNZ9Q8+v/3yWY/yCwiE06qFhuEyMfghIG+iJJBoq1eUjn2DfXfJ2WuE6ZLDCkL4O9T4SOp+b1lF56DMaYMgBqmFXMwNwZA2J0NDKFeXZgCwRRPilYYmqfHtNACSwnoUw6bd7DR3V1WRdWkAraJS34uGZjgeMsb9jtZnC7YGN2bVWR3apLwzUApcYGINgk48NIQspxM3MX++rQ/256uTneXpaBxI9/4LzWXAscZyuQfkElGrTVUB3NncPZG3QUOxq7U7I/n3kJpoNFLjClW4Jv9HPM6ChzjYiSBtBJiyDjVAqcMSWvXBdwZ9Sj2h/vInpprQHImoCS1MMdUs5GB2Q4UI2vhBw9uF76KxIWVC7Sb1GNYHEUDFREfyWGkobt/SV8gd4pJVWKgUAswF3FODkTOSKb0oupZV/BfK1A4YVQDAKHGSmbFH3FjaBfi47OIkSruUfjmqdDBuTC6bOhl1n0aKhmCQqH7aIFlt8lk5SjPtLf0UQb1/u5CuSObjJusFle5RMBuzbYGmftyoiHXaTkWQBCjBZ484QIprVnySG2jPZR7Ua3KNBvMJlpRdBWhKLA6eKUownad0L7VA== X-Forefront-Antispam-Report: CIP:216.228.117.160; CTRY:US; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:mail.nvidia.com; PTR:dc6edge1.nvidia.com; CAT:NONE; SFS:(13230022)(4636009)(396003)(39860400002)(346002)(136003)(376002)(451199015)(36840700001)(46966006)(40470700004)(6916009)(6286002)(316002)(40460700003)(26005)(36756003)(70586007)(41300700001)(86362001)(8676002)(8936002)(2906002)(70206006)(5660300002)(356005)(7636003)(6666004)(478600001)(83380400001)(82310400005)(82740400003)(47076005)(40480700001)(36860700001)(7696005)(55016003)(336012)(1076003)(186003)(426003)(2616005)(16526019); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Oct 2022 13:33:03.1417 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 9ab93d7a-43c9-4032-ff73-08dab68d7135 X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a; Ip=[216.228.117.160]; Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: CO1NAM11FT017.eop-nam11.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR12MB5484 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 Recent versions of doxygen (1.9.4 and newer) complain about documented return types for functions that don't return anything. This patch removes these return types to fix build errors similar to this one: [..] Generating doc/api/doxygen with a custom command FAILED: doc/api/html /usr/bin/python3 /path/to/doc/api/generate_doxygen.py doc/api/html /usr/bin/doxygen doc/api/doxy-api.conf /root/dpdk/lib/eal/include/rte_bitmap.h:324: error: found documented return type for rte_bitmap_prefetch0 that does not return anything (warning treated as error, aborting now) [..] Tested with doxygen versions: 1.8.13, 1.8.17, 1.9.1, and 1.9.4. Signed-off-by: Ali Alnubani Acked-by: Stephen Hemminger --- Changes in v2: - Reword commit message. - Add 1.8.13 to list of tested doxygen versions. lib/eal/include/rte_bitmap.h | 2 -- lib/eal/include/rte_hexdump.h | 4 ---- lib/fib/rte_fib.h | 2 -- lib/fib/rte_fib6.h | 2 -- lib/hash/rte_thash.h | 2 -- lib/ipsec/rte_ipsec_sad.h | 2 -- lib/lpm/rte_lpm.h | 2 -- lib/lpm/rte_lpm6.h | 2 -- lib/reorder/rte_reorder.h | 2 -- lib/rib/rte_rib.h | 2 -- lib/rib/rte_rib6.h | 2 -- 11 files changed, 24 deletions(-) diff --git a/lib/eal/include/rte_bitmap.h b/lib/eal/include/rte_bitmap.h index e4623bb176..c589d5cde0 100644 --- a/lib/eal/include/rte_bitmap.h +++ b/lib/eal/include/rte_bitmap.h @@ -327,8 +327,6 @@ rte_bitmap_reset(struct rte_bitmap *bmp) * Handle to bitmap instance * @param pos * Bit position - * @return - * 0 upon success, error code otherwise */ static inline void rte_bitmap_prefetch0(struct rte_bitmap *bmp, uint32_t pos) diff --git a/lib/eal/include/rte_hexdump.h b/lib/eal/include/rte_hexdump.h index 2d03c089c4..80cf2933a7 100644 --- a/lib/eal/include/rte_hexdump.h +++ b/lib/eal/include/rte_hexdump.h @@ -27,8 +27,6 @@ extern "C" { * This is the buffer address to print out. * @param len * The number of bytes to dump out -* @return -* None. */ extern void @@ -45,8 +43,6 @@ rte_hexdump(FILE *f, const char * title, const void * buf, unsigned int len); * This is the buffer address to print out. * @param len * The number of bytes to dump out -* @return -* None. */ void diff --git a/lib/fib/rte_fib.h b/lib/fib/rte_fib.h index baa206093c..d7a5aafe53 100644 --- a/lib/fib/rte_fib.h +++ b/lib/fib/rte_fib.h @@ -124,8 +124,6 @@ rte_fib_find_existing(const char *name); * @param fib * FIB object handle created by rte_fib_create(). * If fib is NULL, no operation is performed. - * @return - * None */ void rte_fib_free(struct rte_fib *fib); diff --git a/lib/fib/rte_fib6.h b/lib/fib/rte_fib6.h index 6fc915b1f3..2eb8b82676 100644 --- a/lib/fib/rte_fib6.h +++ b/lib/fib/rte_fib6.h @@ -115,8 +115,6 @@ rte_fib6_find_existing(const char *name); * @param fib * FIB object handle created by rte_fib6_create(). * If fib is NULL, no operation is performed. - * @return - * None */ void rte_fib6_free(struct rte_fib6 *fib); diff --git a/lib/hash/rte_thash.h b/lib/hash/rte_thash.h index 451f64043a..c20ff0244c 100644 --- a/lib/hash/rte_thash.h +++ b/lib/hash/rte_thash.h @@ -329,8 +329,6 @@ rte_thash_find_existing(const char *name); * * @param ctx * Thash context - * @return - * None */ __rte_experimental void diff --git a/lib/ipsec/rte_ipsec_sad.h b/lib/ipsec/rte_ipsec_sad.h index a3ae57df7e..dbd89901af 100644 --- a/lib/ipsec/rte_ipsec_sad.h +++ b/lib/ipsec/rte_ipsec_sad.h @@ -139,8 +139,6 @@ rte_ipsec_sad_find_existing(const char *name); * * @param sad * pointer to the SAD object - * @return - * None */ void rte_ipsec_sad_destroy(struct rte_ipsec_sad *sad); diff --git a/lib/lpm/rte_lpm.h b/lib/lpm/rte_lpm.h index c8295905e4..82139c6447 100644 --- a/lib/lpm/rte_lpm.h +++ b/lib/lpm/rte_lpm.h @@ -180,8 +180,6 @@ rte_lpm_find_existing(const char *name); * @param lpm * LPM object handle * If lpm is NULL, no operation is performed. - * @return - * None */ void rte_lpm_free(struct rte_lpm *lpm); diff --git a/lib/lpm/rte_lpm6.h b/lib/lpm/rte_lpm6.h index cd9ce17989..c93683e624 100644 --- a/lib/lpm/rte_lpm6.h +++ b/lib/lpm/rte_lpm6.h @@ -73,8 +73,6 @@ rte_lpm6_find_existing(const char *name); * @param lpm * LPM object handle * If lpm is NULL, no operation is performed. - * @return - * None */ void rte_lpm6_free(struct rte_lpm6 *lpm); diff --git a/lib/reorder/rte_reorder.h b/lib/reorder/rte_reorder.h index f72f07e645..4f9f71af75 100644 --- a/lib/reorder/rte_reorder.h +++ b/lib/reorder/rte_reorder.h @@ -116,8 +116,6 @@ rte_reorder_reset(struct rte_reorder_buffer *b); * @param b * Pointer to reorder buffer instance. * If b is NULL, no operation is performed. - * @return - * None */ void rte_reorder_free(struct rte_reorder_buffer *b); diff --git a/lib/rib/rte_rib.h b/lib/rib/rte_rib.h index f41774afe7..2054d3cebd 100644 --- a/lib/rib/rte_rib.h +++ b/lib/rib/rte_rib.h @@ -265,8 +265,6 @@ rte_rib_find_existing(const char *name); * @param rib * RIB object handle created with rte_rib_create(). * If rib is NULL, no operation is performed. - * @return - * None */ void rte_rib_free(struct rte_rib *rib); diff --git a/lib/rib/rte_rib6.h b/lib/rib/rte_rib6.h index 49d5b99b70..775286f965 100644 --- a/lib/rib/rte_rib6.h +++ b/lib/rib/rte_rib6.h @@ -320,8 +320,6 @@ rte_rib6_find_existing(const char *name); * @param rib * RIB object handle created with rte_rib6_create(). * If rib is NULL, no operation is performed. - * @return - * None */ void rte_rib6_free(struct rte_rib6 *rib);