diff mbox

[dpdk-dev] ethdev: fix doxygen comments about RSS

Message ID 1416866980-23002-1-git-send-email-thomas.monjalon@6wind.com (mailing list archive)
State Accepted, archived
Headers show

Commit Message

Thomas Monjalon Nov. 24, 2014, 10:09 p.m. UTC
The parameters port_id didn't match with comments about port.

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
 lib/librte_ether/rte_ethdev.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Bruce Richardson Nov. 25, 2014, 8:47 a.m. UTC | #1
On Mon, Nov 24, 2014 at 11:09:40PM +0100, Thomas Monjalon wrote:
> The parameters port_id didn't match with comments about port.
> 
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>

Acked-by: Bruce Richardson <bruce.richardson@intel.com>

> ---
>  lib/librte_ether/rte_ethdev.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h
> index fec4d4c..78a9d37 100644
> --- a/lib/librte_ether/rte_ethdev.h
> +++ b/lib/librte_ether/rte_ethdev.h
> @@ -3370,7 +3370,7 @@ int rte_eth_dev_bypass_wd_reset(uint8_t port);
>   /**
>   * Configuration of Receive Side Scaling hash computation of Ethernet device.
>   *
> - * @param port
> + * @param port_id
>   *   The port identifier of the Ethernet device.
>   * @param rss_conf
>   *   The new configuration to use for RSS hash computation on the port.
> @@ -3387,7 +3387,7 @@ int rte_eth_dev_rss_hash_update(uint8_t port_id,
>   * Retrieve current configuration of Receive Side Scaling hash computation
>   * of Ethernet device.
>   *
> - * @param port
> + * @param port_id
>   *   The port identifier of the Ethernet device.
>   * @param rss_conf
>   *   Where to store the current RSS hash configuration of the Ethernet device.
> -- 
> 2.1.3
>
Thomas Monjalon Nov. 25, 2014, 11:52 a.m. UTC | #2
> > The parameters port_id didn't match with comments about port.
> > 
> > Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
> 
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied
diff mbox

Patch

diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h
index fec4d4c..78a9d37 100644
--- a/lib/librte_ether/rte_ethdev.h
+++ b/lib/librte_ether/rte_ethdev.h
@@ -3370,7 +3370,7 @@  int rte_eth_dev_bypass_wd_reset(uint8_t port);
  /**
  * Configuration of Receive Side Scaling hash computation of Ethernet device.
  *
- * @param port
+ * @param port_id
  *   The port identifier of the Ethernet device.
  * @param rss_conf
  *   The new configuration to use for RSS hash computation on the port.
@@ -3387,7 +3387,7 @@  int rte_eth_dev_rss_hash_update(uint8_t port_id,
  * Retrieve current configuration of Receive Side Scaling hash computation
  * of Ethernet device.
  *
- * @param port
+ * @param port_id
  *   The port identifier of the Ethernet device.
  * @param rss_conf
  *   Where to store the current RSS hash configuration of the Ethernet device.