From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
by inbox.dpdk.org (Postfix) with ESMTP id D040543B61;
Wed, 21 Feb 2024 11:33:48 +0100 (CET)
Received: from mails.dpdk.org (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id DBB2D410E4;
Wed, 21 Feb 2024 11:32:49 +0100 (CET)
Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.15])
by mails.dpdk.org (Postfix) with ESMTP id 7E3E2410D0;
Wed, 21 Feb 2024 11:32:47 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple;
d=intel.com; i=@intel.com; q=dns/txt; s=Intel;
t=1708511568; x=1740047568;
h=from:to:cc:subject:date:message-id:in-reply-to:
references:mime-version:content-transfer-encoding;
bh=5l6C2UsH07ah7winMjH0gVv2ACaZI3byggiswjYd13g=;
b=ImYGppLihyHml9EJzD7trll4nnxks8hF3fG5adlerbcEEcxyFAnXuFYq
MBOz383VJ2GZi6phFPo+4Als8nYjIh045clFLf98jyY1UZmbRi/ZUC2XB
YB/+pGRZJJKL1C2S1B94Nb4FpLV/vX/xvpOI1mx6DfJjNUyEUC3iu27A+
ixoMB0n5eo7bz5rld+2liGrPuHYJ9gbKJO7e1Qqey/qegIo6tIvxas+ld
XwMzTM3eeN1UcMs1j9C9hx76bVQ78X5c80ZoRjVdhDUvdDwuw5u2nT0Fs
taUC9V1O3/rxEhOQGAdk4nwP96lcnsiDn8tQNYisCpj77pu0l+7lesvv5 w==;
X-IronPort-AV: E=McAfee;i="6600,9927,10990"; a="2800760"
X-IronPort-AV: E=Sophos;i="6.06,175,1705392000";
d="scan'208";a="2800760"
Received: from orviesa007.jf.intel.com ([10.64.159.147])
by fmvoesa109.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
21 Feb 2024 02:32:47 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="6.06,175,1705392000";
d="scan'208";a="5393035"
Received: from silpixa00401385.ir.intel.com ([10.237.214.38])
by orviesa007.jf.intel.com with ESMTP; 21 Feb 2024 02:32:46 -0800
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org,
jerinj@marvell.com,
mattias.ronnblom@ericsson.com
Cc: Bruce Richardson <bruce.richardson@intel.com>,
stable@dpdk.org
Subject: [PATCH v4 12/12] eventdev: fix doxygen processing of event vector
struct
Date: Wed, 21 Feb 2024 10:32:21 +0000
Message-Id: <20240221103221.933238-13-bruce.richardson@intel.com>
X-Mailer: git-send-email 2.40.1
In-Reply-To: <20240221103221.933238-1-bruce.richardson@intel.com>
References: <20240119174346.108905-1-bruce.richardson@intel.com>
<20240221103221.933238-1-bruce.richardson@intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
The event vector struct was missing comments on two members, and also
was inadvertently creating a local variable called "__rte_aligned" in
the doxygen output.
Correct the comment markers to fix the former issue, and fix the latter
by putting "#ifdef __DOXYGEN" around the alignment constraint.
Fixes: 1cc44d409271 ("eventdev: introduce event vector capability")
Fixes: 3c838062b91f ("eventdev: introduce event vector Rx capability")
Fixes: 699155f2d4e2 ("eventdev: fix clang C++ include")
Cc: stable@dpdk.org
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
lib/eventdev/rte_eventdev.h | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h
index 03748eb437..cf7d103a6c 100644
--- a/lib/eventdev/rte_eventdev.h
+++ b/lib/eventdev/rte_eventdev.h
@@ -1358,10 +1358,8 @@ struct rte_event_vector {
* port and queue of the mbufs in the vector
*/
struct {
- uint16_t port;
- /* Ethernet device port id. */
- uint16_t queue;
- /* Ethernet device queue id. */
+ uint16_t port; /**< Ethernet device port id. */
+ uint16_t queue; /**< Ethernet device queue id. */
};
};
/**< Union to hold common attributes of the vector array. */
@@ -1390,7 +1388,11 @@ struct rte_event_vector {
* vector array can be an array of mbufs or pointers or opaque u64
* values.
*/
+#ifndef __DOXYGEN__
} __rte_aligned(16);
+#else
+};
+#endif
/* Scheduler type definitions */
#define RTE_SCHED_TYPE_ORDERED 0
--
2.40.1