From: Thomas Monjalon <thomas@monjalon.net>
To: ferruh.yigit@intel.com, arybchenko@solarflare.com
Cc: dev@dpdk.org, ophirmu@mellanox.com, bernard.iremonger@intel.com,
rahul.lakkireddy@chelsio.com
Subject: [dpdk-dev] [PATCH v6 3/6] ethdev: fix doxygen comments of shared data fields
Date: Fri, 19 Oct 2018 04:07:54 +0200 [thread overview]
Message-ID: <20181019020757.27698-4-thomas@monjalon.net> (raw)
In-Reply-To: <20181019020757.27698-1-thomas@monjalon.net>
Some doxygen comments were wrongly associated to the next field
because of syntax /** instead of /**<
Some other cleanups (like alignment) are done.
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Reviewed-by: Andrew Rybchenko <arybchenko@solarflare.com>
---
lib/librte_ethdev/rte_ethdev_core.h | 28 +++++++++++++---------------
1 file changed, 13 insertions(+), 15 deletions(-)
diff --git a/lib/librte_ethdev/rte_ethdev_core.h b/lib/librte_ethdev/rte_ethdev_core.h
index 33d12b3a2..03ec4992a 100644
--- a/lib/librte_ethdev/rte_ethdev_core.h
+++ b/lib/librte_ethdev/rte_ethdev_core.h
@@ -581,22 +581,20 @@ struct rte_eth_dev_data {
void *dev_private; /**< PMD-specific private data */
- struct rte_eth_link dev_link;
- /**< Link-level information & status */
-
+ struct rte_eth_link dev_link; /**< Link-level information & status. */
struct rte_eth_conf dev_conf; /**< Configuration applied to device. */
uint16_t mtu; /**< Maximum Transmission Unit. */
-
uint32_t min_rx_buf_size;
- /**< Common rx buffer size handled by all queues */
+ /**< Common RX buffer size handled by all queues. */
uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
- struct ether_addr* mac_addrs;/**< Device Ethernet Link address. */
+ struct ether_addr *mac_addrs; /**< Device Ethernet link address. */
uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
- /** bitmap array of associating Ethernet MAC addresses to pools */
- struct ether_addr* hash_mac_addrs;
- /** Device Ethernet MAC addresses of hash filtering. */
+ /**< Bitmap associating MAC addresses to pools. */
+ struct ether_addr *hash_mac_addrs;
+ /**< Device Ethernet MAC addresses of hash filtering. */
uint16_t port_id; /**< Device [external] port identifier. */
+
__extension__
uint8_t promiscuous : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
scattered_rx : 1, /**< RX of scattered packets is ON(1) / OFF(0) */
@@ -604,14 +602,14 @@ struct rte_eth_dev_data {
dev_started : 1, /**< Device state: STARTED(1) / STOPPED(0). */
lro : 1; /**< RX LRO is ON(1) / OFF(0) */
uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
- /** Queues state: STARTED(1) / STOPPED(0) */
+ /**< Queues state: STARTED(1) / STOPPED(0). */
uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
- /** Queues state: STARTED(1) / STOPPED(0) */
- uint32_t dev_flags; /**< Capabilities */
- enum rte_kernel_driver kdrv; /**< Kernel driver passthrough */
- int numa_node; /**< NUMA node connection */
+ /**< Queues state: STARTED(1) / STOPPED(0). */
+ uint32_t dev_flags; /**< Capabilities. */
+ enum rte_kernel_driver kdrv; /**< Kernel driver passthrough. */
+ int numa_node; /**< NUMA node connection. */
struct rte_vlan_filter_conf vlan_filter_conf;
- /**< VLAN filter configuration. */
+ /**< VLAN filter configuration. */
struct rte_eth_dev_owner owner; /**< The port owner. */
} __rte_cache_aligned;
--
2.19.0
next prev parent reply other threads:[~2018-10-19 2:08 UTC|newest]
Thread overview: 78+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-09-07 23:39 [dpdk-dev] [RFC] ethdev: complete closing to free all resources Thomas Monjalon
2018-09-10 8:03 ` Andrew Rybchenko
2018-09-10 8:42 ` Thomas Monjalon
2018-09-10 8:54 ` Andrew Rybchenko
2018-09-12 14:57 ` Thomas Monjalon
2018-09-12 15:44 ` Andrew Rybchenko
2018-09-28 12:46 ` Ferruh Yigit
2018-10-09 22:00 ` Thomas Monjalon
2018-10-09 22:17 ` [dpdk-dev] [PATCH v2] ethdev: complete closing of port Thomas Monjalon
2018-10-10 6:15 ` Andrew Rybchenko
2018-10-10 7:44 ` Thomas Monjalon
2018-10-10 7:50 ` Andrew Rybchenko
2018-10-10 8:39 ` Thomas Monjalon
2018-10-10 15:01 ` Andrew Rybchenko
2018-10-10 16:43 ` Thomas Monjalon
2018-10-10 18:01 ` Andrew Rybchenko
2018-10-10 19:03 ` Thomas Monjalon
2018-10-14 23:20 ` [dpdk-dev] [PATCH v3 0/2] ethdev port freeing Thomas Monjalon
2018-10-14 23:20 ` [dpdk-dev] [PATCH v3 1/2] ethdev: free all common data when releasing port Thomas Monjalon
2018-10-16 11:16 ` Andrew Rybchenko
2018-10-16 12:22 ` Thomas Monjalon
2018-10-16 12:47 ` Andrew Rybchenko
2018-10-16 12:52 ` Thomas Monjalon
2018-10-16 12:55 ` Andrew Rybchenko
2018-10-14 23:20 ` [dpdk-dev] [PATCH v3 2/2] ethdev: complete closing of port Thomas Monjalon
2018-10-16 11:24 ` Andrew Rybchenko
2018-10-16 12:25 ` Thomas Monjalon
2018-10-17 1:54 ` [dpdk-dev] [PATCH v3 0/4] ethdev port freeing Thomas Monjalon
2018-10-17 1:54 ` [dpdk-dev] [PATCH v3 1/4] app/testpmd: allow detaching a port not closed Thomas Monjalon
2018-10-17 2:06 ` Thomas Monjalon
2018-10-17 6:26 ` Andrew Rybchenko
2018-10-17 8:20 ` Thomas Monjalon
2018-10-17 10:30 ` Iremonger, Bernard
2018-10-17 11:33 ` Thomas Monjalon
2018-10-17 1:54 ` [dpdk-dev] [PATCH v3 2/4] ethdev: free all common data when releasing port Thomas Monjalon
2018-10-17 7:13 ` Andrew Rybchenko
2018-10-17 8:22 ` Thomas Monjalon
2018-10-17 1:54 ` [dpdk-dev] [PATCH v3 3/4] ethdev: remove release function for secondary process Thomas Monjalon
2018-10-17 7:25 ` Andrew Rybchenko
2018-10-17 9:27 ` Thomas Monjalon
2018-10-17 1:54 ` [dpdk-dev] [PATCH v3 4/4] ethdev: complete closing of port Thomas Monjalon
2018-10-17 2:12 ` Thomas Monjalon
2018-10-17 10:24 ` [dpdk-dev] [PATCH v3 0/4] ethdev port freeing Shreyansh Jain
2018-10-17 11:31 ` Thomas Monjalon
2018-10-18 1:23 ` [dpdk-dev] [PATCH v5 0/6] " Thomas Monjalon
2018-10-18 1:23 ` [dpdk-dev] [PATCH v5 1/6] app/testpmd: fix ports list after removing several at once Thomas Monjalon
2018-10-18 10:40 ` Iremonger, Bernard
2018-10-18 11:29 ` Thomas Monjalon
2018-10-18 11:41 ` Iremonger, Bernard
2018-10-18 14:21 ` Thomas Monjalon
2018-10-18 16:42 ` Iremonger, Bernard
2018-10-18 17:06 ` Thomas Monjalon
2018-10-18 11:49 ` Wisam Monther
2018-10-18 13:22 ` Iremonger, Bernard
2018-10-18 1:23 ` [dpdk-dev] [PATCH v5 2/6] app/testpmd: allow detaching a port not closed Thomas Monjalon
2018-10-18 7:45 ` Andrew Rybchenko
2018-10-18 10:51 ` Iremonger, Bernard
2018-10-18 11:24 ` Thomas Monjalon
2018-10-18 1:23 ` [dpdk-dev] [PATCH v5 3/6] ethdev: fix doxygen comments of shared data fields Thomas Monjalon
2018-10-18 7:11 ` Andrew Rybchenko
2018-10-18 1:24 ` [dpdk-dev] [PATCH v5 4/6] ethdev: free all common data when releasing port Thomas Monjalon
2018-10-18 7:13 ` Andrew Rybchenko
2018-10-18 1:24 ` [dpdk-dev] [PATCH v5 5/6] ethdev: remove release function for secondary process Thomas Monjalon
2018-10-18 7:15 ` Andrew Rybchenko
2018-10-18 1:24 ` [dpdk-dev] [PATCH v5 6/6] ethdev: complete closing of port Thomas Monjalon
2018-10-18 8:33 ` Andrew Rybchenko
2018-10-18 9:32 ` Thomas Monjalon
2018-10-19 2:07 ` [dpdk-dev] [PATCH v6 0/6] ethdev port freeing Thomas Monjalon
2018-10-19 2:07 ` [dpdk-dev] [PATCH v6 1/6] app/testpmd: update port list for multiple removals Thomas Monjalon
2018-10-19 14:32 ` Iremonger, Bernard
2018-10-19 2:07 ` [dpdk-dev] [PATCH v6 2/6] app/testpmd: allow detaching a port not closed Thomas Monjalon
2018-10-19 14:32 ` Iremonger, Bernard
2018-10-19 2:07 ` Thomas Monjalon [this message]
2018-10-19 2:07 ` [dpdk-dev] [PATCH v6 4/6] ethdev: free all common data when releasing port Thomas Monjalon
2018-10-19 2:07 ` [dpdk-dev] [PATCH v6 5/6] ethdev: remove release function for secondary process Thomas Monjalon
2018-10-19 2:07 ` [dpdk-dev] [PATCH v6 6/6] ethdev: complete closing of port Thomas Monjalon
2018-10-19 10:13 ` Andrew Rybchenko
2018-10-22 15:43 ` [dpdk-dev] [PATCH v6 0/6] ethdev port freeing Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20181019020757.27698-4-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=arybchenko@solarflare.com \
--cc=bernard.iremonger@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=ophirmu@mellanox.com \
--cc=rahul.lakkireddy@chelsio.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).