Fix a doxygen comment of rte_eth_dev_allocate()

Message ID 1533499408-12931-1-git-send-email-rami.rosen@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series Fix a doxygen comment of rte_eth_dev_allocate() |

Checks

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

Commit Message

Rami Rosen Aug. 5, 2018, 8:03 p.m. UTC
  This patch fixes a doxygen comment of the rte_eth_dev_allocate()
method. There is no parameter named "type" for this 
method; so this patch removes the doxygen comment about it.

Signed-off-by: Rami Rosen <rami.rosen@intel.com>
---
 lib/librte_ethdev/rte_ethdev_driver.h | 1 -
 1 file changed, 1 deletion(-)
  

Comments

Ferruh Yigit Aug. 7, 2018, 3:44 p.m. UTC | #1
On 8/5/2018 9:03 PM, Rami Rosen wrote:
> This patch fixes a doxygen comment of the rte_eth_dev_allocate()
> method. There is no parameter named "type" for this 
> method; so this patch removes the doxygen comment about it.
> 
> Signed-off-by: Rami Rosen <rami.rosen@intel.com>

Fixes: 6751f6deb798 ("ethdev: get rid of device type")
Cc: david.marchand@6wind.com

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
  
Thomas Monjalon Aug. 9, 2018, 3:56 p.m. UTC | #2
07/08/2018 17:44, Ferruh Yigit:
> On 8/5/2018 9:03 PM, Rami Rosen wrote:
> > This patch fixes a doxygen comment of the rte_eth_dev_allocate()
> > method. There is no parameter named "type" for this 
> > method; so this patch removes the doxygen comment about it.
> > 
> > Signed-off-by: Rami Rosen <rami.rosen@intel.com>
> 
> Fixes: 6751f6deb798 ("ethdev: get rid of device type")
> Cc: david.marchand@6wind.com

Cc: stable@dpdk.org

> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

title:
	ethdev: fix a doxygen comment for port allocation

Applied, thanks
  

Patch

diff --git a/lib/librte_ethdev/rte_ethdev_driver.h b/lib/librte_ethdev/rte_ethdev_driver.h
index e2426af..c6d9bc1 100644
--- a/lib/librte_ethdev/rte_ethdev_driver.h
+++ b/lib/librte_ethdev/rte_ethdev_driver.h
@@ -38,7 +38,6 @@ 
  * to that slot for the driver to use.
  *
  * @param	name	Unique identifier name for each Ethernet device
- * @param	type	Device type of this Ethernet device
  * @return
  *   - Slot in the rte_dev_devices array for a new device;
  */