ethdev: fix doxygen comment to be with structure
Checks
Commit Message
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
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>
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.
@@ -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. */