[dpdk-dev] [PATCH] ethdev: fix a typo in eth device API doc

[dpdk-dev] [PATCH] ethdev: fix a typo in eth device API doc

[Nikhil Rao]

This patch fixes a typo in the eth device API doc, device
config. not stored between calls to rte_eth_dev_start/stop()
should be restored before a call to rte_eth_dev_start()
instead of after a call to rte_eth_dev_start().

Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>
---
 lib/librte_ether/rte_ethdev.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h
index b0fe033..099aeb1 100644
--- a/lib/librte_ether/rte_ethdev.h
+++ b/lib/librte_ether/rte_ethdev.h
@@ -118,7 +118,7 @@
  *     - NIC queue statistics mappings
  *
  * Any other configuration will not be stored and will need to be re-entered
- * after a call to rte_eth_dev_start().
+ * before a call to rte_eth_dev_start().
  *
  * Finally, a network application can close an Ethernet device by invoking the
  * rte_eth_dev_close() function.
-- 
2.7.4

Re: [dpdk-dev] [PATCH] ethdev: fix a typo in eth device API doc

[Thomas Monjalon]

2016-08-01 11:19, Nikhil Rao:
> This patch fixes a typo in the eth device API doc, device
> config. not stored between calls to rte_eth_dev_start/stop()
> should be restored before a call to rte_eth_dev_start()
> instead of after a call to rte_eth_dev_start().
> 
> Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>
[...]
> --- a/lib/librte_ether/rte_ethdev.h
> +++ b/lib/librte_ether/rte_ethdev.h
> @@ -118,7 +118,7 @@
>   *     - NIC queue statistics mappings
>   *
>   * Any other configuration will not be stored and will need to be re-entered
> - * after a call to rte_eth_dev_start().
> + * before a call to rte_eth_dev_start().

I have some doubts about this and above comment.
I think we should give move details in the comments of the functions,
instead of this (not often read) global comment.

Re: [dpdk-dev] [PATCH] ethdev: fix a typo in eth device API doc

[Mcnamara, John]

> -----Original Message-----
> From: Rao, Nikhil
> Sent: Monday, August 1, 2016 6:50 AM
> To: dev@dpdk.org
> Cc: thomas.monjalon@6wind.com; Mcnamara, John <john.mcnamara@intel.com>;
> Rao, Nikhil <nikhil.rao@intel.com>
> Subject: [PATCH] ethdev: fix a typo in eth device API doc
> 
> This patch fixes a typo in the eth device API doc, device config. not
> stored between calls to rte_eth_dev_start/stop() should be restored before
> a call to rte_eth_dev_start() instead of after a call to
> rte_eth_dev_start().
> 
> Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>

Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [dpdk-dev] [PATCH] ethdev: fix a typo in eth device API doc

[Thomas Monjalon]

30/06/2017 16:47, Mcnamara, John:
> > 
> > This patch fixes a typo in the eth device API doc, device config. not
> > stored between calls to rte_eth_dev_start/stop() should be restored before
> > a call to rte_eth_dev_start() instead of after a call to
> > rte_eth_dev_start().
> > 
> > Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

I am still not convinced by this whole text,
but applied to move forward.

Re: [dpdk-dev] [PATCH] ethdev: fix a typo in eth device API doc

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Sunday, July 2, 2017 6:49 PM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org; Rao, Nikhil <nikhil.rao@intel.com>
> Subject: Re: [dpdk-dev] [PATCH] ethdev: fix a typo in eth device API doc
> 
> 30/06/2017 16:47, Mcnamara, John:
> > >
> > > This patch fixes a typo in the eth device API doc, device config.
> > > not stored between calls to rte_eth_dev_start/stop() should be
> > > restored before a call to rte_eth_dev_start() instead of after a
> > > call to rte_eth_dev_start().
> > >
> > > Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>
> >
> > Acked-by: John McNamara <john.mcnamara@intel.com>
> 
> I am still not convinced by this whole text, but applied to move forward.

Agreed. We should mark this as a defect and have someone re-evaluate the
overall text. However, in terms of this patch, at least it is less wrong than
the existing text.