xsk: fix a documentation mistake in xsk_queue.h
Subsystems (3)
PATCH 1/1 xsk: fix a documentation mistake in xsk_queue.h
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 <[email protected]>
--- net/xdp/xsk_queue.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
net/xdp/xsk_queue.h +1 -1
@@ -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. *
Signature · 1 line
2.17.1
Quoted 24 lines · 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 <[email protected]>--- net/xdp/xsk_queue.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)net/xdp/xsk_queue.h +1
-2@@ -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. * --
Quoted 2 lines
2.17.1
Thank you Ciara.
Acked-by Magnus Karlsson <[email protected]>
This patch was applied to bpf/bpf-next.git (refs/heads/master):
Hello:
This patch was applied to bpf/bpf-next.git (refs/heads/master):
Quoted 8 lines · 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 <[email protected]>--- 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