Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:4 as permitted sender) client-ip=2620:137:e000::3:4;
Date:   Fri, 20 Oct 2023 16:49:17 -0400
From:   Steven Rostedt <rostedt@goodmis.org>
To:     Jonathan Corbet <corbet@lwn.net>
Cc:     LKML <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] seq_buf: fix a misleading comment
Message-ID: <20231020164917.6fb6f89b@gandalf.local.home>
In-Reply-To: <87pm19kp0m.fsf@meer.lwn.net>
References: <87pm19kp0m.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Precedence: bulk

On Fri, 20 Oct 2023 14:38:49 -0600
Jonathan Corbet <corbet@lwn.net> wrote:

> 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.
> 

I guess we can add:

Fixes: 8cd709ae7658a ("tracing: Have seq_buf use full buffer")

Thanks!

-- Steve

> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> ---
>  include/linux/seq_buf.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/seq_buf.h b/include/linux/seq_buf.h
> index 515d7fcb9634..026302765494 100644
> --- a/include/linux/seq_buf.h
> +++ b/include/linux/seq_buf.h
> @@ -39,7 +39,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)