xsk: Fix a documentation mistake in xsk_queue.h

cloftus · Alexei Starovoitov · commit f1fc8ece6c07 · 2020-09-29T11:25:56.000-07:00
After 'peeking' the ring, the consumer, not the producer, reads the data. Fix this mistake in the comments. Fixes: 15d8c91 ("xsk: Add function naming comments and reorder functions") Signed-off-by: Ciara Loftus <ciara.loftus@intel.com> Signed-off-by: Alexei Starovoitov <ast@kernel.org> Acked-by: Magnus Karlsson <magnus.karlsson@intel.com> Link: https://lore.kernel.org/bpf/20200928082344.17110-1-ciara.loftus@intel.com
diff --git 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.
  *

Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ struct xsk_queue {`
`96`	`96`	`* seen and read by the consumer.`
`97`	`97`	`*`
`98`	`98`	`* The consumer peeks into the ring to see if the producer has written`
`99`		`- * any new entries. If so, the producer can then read these entries`
	`99`	`+ * any new entries. If so, the consumer can then read these entries`
`100`	`100`	`* and when it is done reading them release them back to the producer`
`101`	`101`	`* so that the producer can use these slots to fill in new entries.`
`102`	`102`	`*`