diff mbox series

ethdev: fix doxygen comment to be with structure

Message ID 20180925143109.19742-1-ferruh.yigit@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series ethdev: fix doxygen comment to be with structure |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Ferruh Yigit Sept. 25, 2018, 2:31 p.m. UTC 
  From: Paul M Stillwell Jr <paul.m.stillwell.jr@intel.com>

The doxygen comment describing the rte_eth_dev_info structure
was separated from the structure itself so move the comment
back to be with the structure.

Fixes: 7238e63bce52 ("ethdev: add support for device offload capabilities")
Cc: ivan.boule@6wind.com
Cc: stable@dpdk.org

Signed-off-by: Paul M Stillwell Jr <paul.m.stillwell.jr@intel.com>
---
 lib/librte_ethdev/rte_ethdev.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

Comments

Thomas Monjalon Sept. 25, 2018, 1:44 p.m. UTC | #1 
25/09/2018 16:31, Ferruh Yigit:
> From: Paul M Stillwell Jr <paul.m.stillwell.jr@intel.com>
> 
> The doxygen comment describing the rte_eth_dev_info structure
> was separated from the structure itself so move the comment
> back to be with the structure.
> 
> Fixes: 7238e63bce52 ("ethdev: add support for device offload capabilities")
> Cc: ivan.boule@6wind.com
> Cc: stable@dpdk.org
> 
> Signed-off-by: Paul M Stillwell Jr <paul.m.stillwell.jr@intel.com>

Good catch!

Acked-by: Thomas Monjalon <thomas@monjalon.net>
Ferruh Yigit Sept. 25, 2018, 3:43 p.m. UTC | #2 
On 9/25/2018 2:44 PM, Thomas Monjalon wrote:
> 25/09/2018 16:31, Ferruh Yigit:
>> From: Paul M Stillwell Jr <paul.m.stillwell.jr@intel.com>
>>
>> The doxygen comment describing the rte_eth_dev_info structure
>> was separated from the structure itself so move the comment
>> back to be with the structure.
>>
>> Fixes: 7238e63bce52 ("ethdev: add support for device offload capabilities")
>> Cc: ivan.boule@6wind.com
>> Cc: stable@dpdk.org
>>
>> Signed-off-by: Paul M Stillwell Jr <paul.m.stillwell.jr@intel.com>
> 
> Good catch!
> 
> Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied to dpdk-next-net/master, thanks.
diff mbox series

Patch

diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index 44b4fb33f..012577b0a 100644
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h
@@ -869,12 +869,6 @@  struct rte_eth_conf {
 	struct rte_intr_conf intr_conf; /**< Interrupt mode configuration. */
 };
 
-/**
- * A structure used to retrieve the contextual information of
- * an Ethernet device, such as the controlling driver of the device,
- * its PCI context, etc...
- */
-
 /**
  * RX offload capabilities of a device.
  */
@@ -1005,6 +999,12 @@  struct rte_eth_switch_info {
 /**
  * Ethernet device information
  */
+
+/**
+ * A structure used to retrieve the contextual information of
+ * an Ethernet device, such as the controlling driver of the
+ * device, etc...
+ */
 struct rte_eth_dev_info {
 	struct rte_device *device; /** Generic device information */
 	const char *driver_name; /**< Device Driver name. */