[Intel-wired-lan] [PATCH] i40e: fix kerneldoc for xsk methods

[Intel-wired-lan] [PATCH] i40e: fix kerneldoc for xsk methods

[Sokolowski, Jan]

One method, xsk_umem_setup, had an incorrect kernel doc
description, which has been corrected.

Also fixes small typos found in the comments.

Signed-off-by: Jan Sokolowski <jan.sokolowski@intel.com>
---
drivers/net/ethernet/intel/i40e/i40e_xsk.c | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/drivers/net/ethernet/intel/i40e/i40e_xsk.c b/drivers/net/ethernet/intel/i40e/i40e_xsk.c
index add1e45..433c8e6 100644
--- a/drivers/net/ethernet/intel/i40e/i40e_xsk.c
+++ b/drivers/net/ethernet/intel/i40e/i40e_xsk.c
@@ -33,7 +33,7 @@ static int i40e_alloc_xsk_umems(struct i40e_vsi *vsi)
}
 /**
- * i40e_add_xsk_umem - Store an UMEM for a certain ring/qid
+ * i40e_add_xsk_umem - Store a UMEM for a certain ring/qid
  * @vsi: Current VSI
  * @umem: UMEM to store
  * @qid: Ring/qid to associate with the UMEM
@@ -56,7 +56,7 @@ static int i40e_add_xsk_umem(struct i40e_vsi *vsi, struct xdp_umem *umem,
}
 /**
- * i40e_remove_xsk_umem - Remove an UMEM for a certain ring/qid
+ * i40e_remove_xsk_umem - Remove a UMEM for a certain ring/qid
  * @vsi: Current VSI
  * @qid: Ring/qid associated with the UMEM
  **/
@@ -130,7 +130,7 @@ static void i40e_xsk_umem_dma_unmap(struct i40e_vsi *vsi, struct xdp_umem *umem)
}
 /**
- * i40e_xsk_umem_enable - Enable/associate an UMEM to a certain ring/qid
+ * i40e_xsk_umem_enable - Enable/associate a UMEM to a certain ring/qid
  * @vsi: Current VSI
  * @umem: UMEM
  * @qid: Rx ring to associate UMEM to
@@ -189,7 +189,7 @@ static int i40e_xsk_umem_enable(struct i40e_vsi *vsi, struct xdp_umem *umem,
}
 /**
- * i40e_xsk_umem_disable - Diassociate an UMEM from a certain ring/qid
+ * i40e_xsk_umem_disable - Disassociate a UMEM from a certain ring/qid
  * @vsi: Current VSI
  * @qid: Rx ring to associate UMEM to
  *
@@ -255,12 +255,12 @@ int i40e_xsk_umem_query(struct i40e_vsi *vsi, struct xdp_umem **umem,
}
 /**
- * i40e_xsk_umem_query - Queries a certain ring/qid for its UMEM
+ * i40e_xsk_umem_setup - Enable/disassociate a UMEM to/from a ring/qid
  * @vsi: Current VSI
  * @umem: UMEM to enable/associate to a ring, or NULL to disable
  * @qid: Rx ring to (dis)associate UMEM (from)to
  *
- * This function enables or disables an UMEM to a certain ring.
+ * This function enables or disables a UMEM to a certain ring.
  *
  * Returns 0 on success, <0 on failure
  **/
@@ -276,7 +276,7 @@ int i40e_xsk_umem_setup(struct i40e_vsi *vsi, struct xdp_umem *umem,
  * @rx_ring: Rx ring
  * @xdp: xdp_buff used as input to the XDP program
  *
- * This function enables or disables an UMEM to a certain ring.
+ * This function enables or disables a UMEM to a certain ring.
  *
  * Returns any of I40E_XDP_{PASS, CONSUMED, TX, REDIR}
  **/
--
1.8.3.1

--------------------------------------------------------------------

Intel Technology Poland sp. z o.o.
ul. Slowackiego 173 | 80-298 Gdansk | Sad Rejonowy Gdansk Polnoc | VII Wydzial Gospodarczy Krajowego Rejestru Sadowego - KRS 101882 | NIP 957-07-52-316 | Kapital zakladowy 200.000 PLN.

Ta wiadomosc wraz z zalacznikami jest przeznaczona dla okreslonego adresata i moze zawierac informacje poufne. W razie przypadkowego otrzymania tej wiadomosci, prosimy o powiadomienie nadawcy oraz trwale jej usuniecie; jakiekolwiek
przegladanie lub rozpowszechnianie jest zabronione.
This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). If you are not the intended recipient, please contact the sender and delete all copies; any review or distribution by
others is strictly prohibited.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osuosl.org/pipermail/intel-wired-lan/attachments/20181127/6b0ac67e/attachment.html>

[Intel-wired-lan] [PATCH] i40e: fix kerneldoc for xsk methods

[Jeff Kirsher]

On Tue, 2018-11-27 at 08:19 +0000, Sokolowski, Jan wrote:
> One method, xsk_umem_setup, had an incorrect kernel doc
> description, which has been corrected.
>  
> Also fixes small typos found in the comments.
>  
> Signed-off-by: Jan Sokolowski <jan.sokolowski@intel.com>
> ---
> drivers/net/ethernet/intel/i40e/i40e_xsk.c | 14 +++++++-------
> 1 file changed, 7 insertions(+), 7 deletions(-)

Hmm, not sure why your patch is so corrupted.  Are you sending it as
plain text?

I have fixed it up and will resubmit it to IWl for you.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: This is a digitally signed message part
URL: <http://lists.osuosl.org/pipermail/intel-wired-lan/attachments/20181127/27d23df1/attachment-0001.asc>

[Intel-wired-lan] [PATCH] i40e: fix kerneldoc for xsk methods

[Bowers, AndrewX]

From: Intel-wired-lan [mailto:intel-wired-lan-bounces at osuosl.org] On Behalf Of Sokolowski, Jan
Sent: Tuesday, November 27, 2018 12:20 AM
To: intel-wired-lan@osuosl.org
Cc: netdev at vger.kernel.org
Subject: [Intel-wired-lan] [PATCH] i40e: fix kerneldoc for xsk methods

One method, xsk_umem_setup, had an incorrect kernel doc
description, which has been corrected.

Also fixes small typos found in the comments.

Signed-off-by: Jan Sokolowski <jan.sokolowski at intel.com<mailto:jan.sokolowski@intel.com>>
---
drivers/net/ethernet/intel/i40e/i40e_xsk.c | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)

Tested-by: Andrew Bowers <andrewx.bowers@intel.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osuosl.org/pipermail/intel-wired-lan/attachments/20181127/2cd87884/attachment.html>

RE: [PATCH] i40e: fix kerneldoc for xsk methods

[Bowers, AndrewX]

>From: Intel-wired-lan [mailto:intel-wired-lan-bounces@osuosl.org] On Behalf Of Sokolowski, Jan
>Sent: Tuesday, November 27, 2018 12:20 AM
>To: intel-wired-lan@osuosl.org
>Cc: netdev@vger.kernel.org
>Subject: [Intel-wired-lan] [PATCH] i40e: fix kerneldoc for xsk methods
>
>One method, xsk_umem_setup, had an incorrect kernel doc
>description, which has been corrected.
>
>Also fixes small typos found in the comments.
>
>Signed-off-by: Jan Sokolowski <jan.sokolowski@intel.com>
>---
>drivers/net/ethernet/intel/i40e/i40e_xsk.c | 14 +++++++-------
>1 file changed, 7 insertions(+), 7 deletions(-)

Tested-by: Andrew Bowers <andrewx.bowers@intel.com>

[Intel-wired-lan] [PATCH] i40e: fix kerneldoc for xsk methods

[Bowers, AndrewX]

>From: Intel-wired-lan [mailto:intel-wired-lan-bounces at osuosl.org] On Behalf Of Sokolowski, Jan
>Sent: Tuesday, November 27, 2018 12:20 AM
To: intel-wired-lan@osuosl.org
>Cc: netdev at vger.kernel.org
>Subject: [Intel-wired-lan] [PATCH] i40e: fix kerneldoc for xsk methods
>
>One method, xsk_umem_setup, had an incorrect kernel doc
>description, which has been corrected.
>
>Also fixes small typos found in the comments.
>
>Signed-off-by: Jan Sokolowski <jan.sokolowski@intel.com>
>---
>drivers/net/ethernet/intel/i40e/i40e_xsk.c | 14 +++++++-------
>1 file changed, 7 insertions(+), 7 deletions(-)

Tested-by: Andrew Bowers <andrewx.bowers@intel.com>