[dpdk-stable] patch 'ethdev: fix doxygen comments of shared data fields' has been queued to stable release 18.08.1

[Kevin Traynor]

Hi,

FYI, your patch has been queued to stable release 18.08.1

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 11/28/18. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the patch applied
to the branch. If the code is different (ie: not only metadata diffs), due for example to
a change in context or macro names, please double check it.

Thanks.

Kevin Traynor

---
>From e4f0c1ecf3e8906c5f4b19a7ce143b12bb1e7681 Mon Sep 17 00:00:00 2001
From: Thomas Monjalon <thomas at monjalon.net>
Date: Fri, 19 Oct 2018 04:07:54 +0200
Subject: [PATCH] ethdev: fix doxygen comments of shared data fields

[ upstream commit f6a12685a5ff64188b5191f52fd486465e4919db ]

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 at monjalon.net>
Reviewed-by: Andrew Rybchenko <arybchenko at 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
@@ -582,20 +582,18 @@ 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). */
@@ -605,12 +603,12 @@ struct rte_eth_dev_data {
 		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

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2018-11-22 16:47:33.465864727 +0000
+++ 0046-ethdev-fix-doxygen-comments-of-shared-data-fields.patch	2018-11-22 16:47:32.000000000 +0000
@@ -1,8 +1,10 @@
-From f6a12685a5ff64188b5191f52fd486465e4919db Mon Sep 17 00:00:00 2001
+From e4f0c1ecf3e8906c5f4b19a7ce143b12bb1e7681 Mon Sep 17 00:00:00 2001
 From: Thomas Monjalon <thomas at monjalon.net>
 Date: Fri, 19 Oct 2018 04:07:54 +0200
 Subject: [PATCH] ethdev: fix doxygen comments of shared data fields
 
+[ upstream commit f6a12685a5ff64188b5191f52fd486465e4919db ]
+
 Some doxygen comments were wrongly associated to the next field
 because of syntax /** instead of /**<
 
@@ -15,10 +17,10 @@
  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 0d28fd902..b9d10c53a 100644
+index 33d12b3a2..03ec4992a 100644
 --- a/lib/librte_ethdev/rte_ethdev_core.h
 +++ b/lib/librte_ethdev/rte_ethdev_core.h
-@@ -588,20 +588,18 @@ struct rte_eth_dev_data {
+@@ -582,20 +582,18 @@ struct rte_eth_dev_data {
  	void *dev_private;              /**< PMD-specific private data */
  
 -	struct rte_eth_link dev_link;
@@ -46,7 +48,7 @@
 +
  	__extension__
  	uint8_t promiscuous   : 1, /**< RX promiscuous mode ON(1) / OFF(0). */
-@@ -611,12 +609,12 @@ struct rte_eth_dev_data {
+@@ -605,12 +603,12 @@ struct rte_eth_dev_data {
  		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) */