]> www.infradead.org Git - users/dwmw2/linux.git/commitdiff
seq_buf: fix a misleading comment
authorJonathan Corbet <corbet@lwn.net>
Fri, 20 Oct 2023 20:38:49 +0000 (14:38 -0600)
committerSteven Rostedt (Google) <rostedt@goodmis.org>
Fri, 20 Oct 2023 20:51:06 +0000 (16:51 -0400)
The comment for seq_buf_has_overflowed() says that an overflow condition is
marked by len == size, but that's not what the code is testing.  Make the
comment match reality.

Link: https://lkml.kernel.org/r/87pm19kp0m.fsf@meer.lwn.net
Fixes: 8cd709ae7658a ("tracing: Have seq_buf use full buffer")
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
include/linux/seq_buf.h

index a0fb013cebdf22222314afcd4bfdf8f70d217e13..8483e4b2d0d2eeeea756cc76a89961085c39f912 100644 (file)
@@ -36,7 +36,7 @@ seq_buf_init(struct seq_buf *s, char *buf, unsigned int size)
 
 /*
  * seq_buf have a buffer that might overflow. When this happens
- * the len and size are set to be equal.
+ * len is set to be greater than size.
  */
 static inline bool
 seq_buf_has_overflowed(struct seq_buf *s)