From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <stable-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
by inbox.dpdk.org (Postfix) with ESMTP id 2B7A7A034C
for <public@inbox.dpdk.org>; Tue, 8 Mar 2022 10:47:13 +0100 (CET)
Received: from [217.70.189.124] (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id 21CB3406B4;
Tue, 8 Mar 2022 10:47:13 +0100 (CET)
Received: from mga06.intel.com (mga06.intel.com [134.134.136.31])
by mails.dpdk.org (Postfix) with ESMTP id BD3814068B;
Tue, 8 Mar 2022 10:47:10 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple;
d=intel.com; i=@intel.com; q=dns/txt; s=Intel;
t=1646732831; x=1678268831;
h=from:to:cc:subject:date:message-id:mime-version:
content-transfer-encoding;
bh=y2qB84d8nodS8pmKBg/sx4NTNxoiQwlT88tDgiffGHM=;
b=LdjgHokHrtmDVRSsjtjGyMqVu9ahH4Z5QVHCEnCn4QDA+ridjlEU2cpO
9BR/Vnd1Zz69HU4rI2KeuvNsbf+dwgJhiFeBNDHg+I93xMSg3tgP+kDOc
9Os9f7uvE6D+K7iAThTxHGKSH/lwHx/RM6kE5Xvsis7+tbNMaxm0iZGe/
UphOyFvMKo5Bcix3sXsjoUm0jgICAovTxSpUYGlIRsJF7YZboieebdQy/
7T9jensecwU5a/Br1fek4sBZdQXLgbKBSPrgbtuKuxw24DZXG83O+7a7i
h+CjETDmjHS2bnhCCgPsyAKWmyT4z+5Ho1RqoefJBp6uOysg8MGeH57NO A==;
X-IronPort-AV: E=McAfee;i="6200,9189,10279"; a="315357939"
X-IronPort-AV: E=Sophos;i="5.90,164,1643702400"; d="scan'208";a="315357939"
Received: from fmsmga002.fm.intel.com ([10.253.24.26])
by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
08 Mar 2022 01:47:09 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.90,164,1643702400"; d="scan'208";a="641689228"
Received: from silpixa00399752.ir.intel.com (HELO
silpixa00399752.ger.corp.intel.com) ([10.237.222.27])
by fmsmga002.fm.intel.com with ESMTP; 08 Mar 2022 01:47:08 -0800
From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Thomas Monjalon <thomas@monjalon.net>,
Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>,
Pablo de Lara <pablo.de.lara.guarch@intel.com>,
David Marchand <david.marchand@6wind.com>
Cc: dev@dpdk.org, Ferruh Yigit <ferruh.yigit@intel.com>, stable@dpdk.org,
Bruce Merry <bmerry@sarao.ac.za>
Subject: [PATCH] ethdev: fix doxygen comment for device info struct
Date: Tue, 8 Mar 2022 09:47:00 +0000
Message-Id: <20220308094700.3409406-1-ferruh.yigit@intel.com>
X-Mailer: git-send-email 2.35.1
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-BeenThere: stable@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: patches for DPDK stable branches <stable.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/stable>,
<mailto:stable-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/stable/>
List-Post: <mailto:stable@dpdk.org>
List-Help: <mailto:stable-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/stable>,
<mailto:stable-request@dpdk.org?subject=subscribe>
Errors-To: stable-bounces@dpdk.org
API documentation for "struct rte_eth_dev_info" was missing some fields
'device' & 'max_hash_mac_addrs',
because of syntax error in doxygen comment, fixing it.
Bugzilla ID: 954
Fixes: 88ac4396ad29 ("ethdev: add VMDq support")
Fixes: cd8c7c7ce241 ("ethdev: replace bus specific struct with generic dev")
Cc: stable@dpdk.org
Reported-by: Bruce Merry <bmerry@sarao.ac.za>
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
lib/ethdev/rte_ethdev.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index c2d1f9a97239..04cff8ee103b 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -1855,7 +1855,7 @@ enum rte_eth_representor_type {
* device, etc...
*/
struct rte_eth_dev_info {
- struct rte_device *device; /** Generic device information */
+ struct rte_device *device; /**< Generic device information */
const char *driver_name; /**< Device Driver name. */
unsigned int if_index; /**< Index to bound host interface, or 0 if none.
Use if_indextoname() to translate into an interface name. */
@@ -1869,8 +1869,8 @@ struct rte_eth_dev_info {
uint16_t max_rx_queues; /**< Maximum number of Rx queues. */
uint16_t max_tx_queues; /**< Maximum number of Tx queues. */
uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
- uint32_t max_hash_mac_addrs;
/** Maximum number of hash MAC addresses for MTA and UTA. */
+ uint32_t max_hash_mac_addrs;
uint16_t max_vfs; /**< Maximum number of VFs. */
uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
struct rte_eth_rxseg_capa rx_seg_capa; /**< Segmentation capability.*/
--
2.35.1