[PATCH bpf] xsk: fix a documentation mistake in xsk_queue.h

[PATCH bpf] xsk: fix a documentation mistake in xsk_queue.h

[Ciara Loftus]

After 'peeking' the ring, the consumer, not the producer, reads the data.
Fix this mistake in the comments.

Fixes: 15d8c9162ced ("xsk: Add function naming comments and reorder functions")
Signed-off-by: Ciara Loftus <ciara.loftus@intel.com>
---
 net/xdp/xsk_queue.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/net/xdp/xsk_queue.h b/net/xdp/xsk_queue.h
index bf42cfd74b89..a0bb2f722b3f 100644
--- a/net/xdp/xsk_queue.h
+++ b/net/xdp/xsk_queue.h
@@ -96,7 +96,7 @@ struct xsk_queue {
  * seen and read by the consumer.
  *
  * The consumer peeks into the ring to see if the producer has written
- * any new entries. If so, the producer can then read these entries
+ * any new entries. If so, the consumer can then read these entries
  * and when it is done reading them release them back to the producer
  * so that the producer can use these slots to fill in new entries.
  *
-- 
2.17.1

Re: [PATCH bpf] xsk: fix a documentation mistake in xsk_queue.h

[Magnus Karlsson]

On Mon, Sep 28, 2020 at 10:49 AM Ciara Loftus <ciara.loftus@intel.com> wrote:
>
> After 'peeking' the ring, the consumer, not the producer, reads the data.
> Fix this mistake in the comments.
>
> Fixes: 15d8c9162ced ("xsk: Add function naming comments and reorder functions")
> Signed-off-by: Ciara Loftus <ciara.loftus@intel.com>
> ---
>  net/xdp/xsk_queue.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/net/xdp/xsk_queue.h b/net/xdp/xsk_queue.h
> index bf42cfd74b89..a0bb2f722b3f 100644
> --- a/net/xdp/xsk_queue.h
> +++ b/net/xdp/xsk_queue.h
> @@ -96,7 +96,7 @@ struct xsk_queue {
>   * seen and read by the consumer.
>   *
>   * The consumer peeks into the ring to see if the producer has written
> - * any new entries. If so, the producer can then read these entries
> + * any new entries. If so, the consumer can then read these entries
>   * and when it is done reading them release them back to the producer
>   * so that the producer can use these slots to fill in new entries.
>   *
> --
> 2.17.1
>

Thank you Ciara.

Acked-by: Magnus Karlsson <magnus.karlsson@intel.com>

Re: [PATCH bpf] xsk: fix a documentation mistake in xsk_queue.h

[patchwork-bot+bpf]

Hello:

This patch was applied to bpf/bpf-next.git (refs/heads/master):

On Mon, 28 Sep 2020 08:23:44 +0000 you wrote:
> After 'peeking' the ring, the consumer, not the producer, reads the data.
> Fix this mistake in the comments.
> 
> Fixes: 15d8c9162ced ("xsk: Add function naming comments and reorder functions")
> Signed-off-by: Ciara Loftus <ciara.loftus@intel.com>
> ---
>  net/xdp/xsk_queue.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Here is the summary with links:
  - xsk: fix a documentation mistake in xsk_queue.h
    https://git.kernel.org/bpf/bpf-next/c/f1fc8ece6c07

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html