Re: [PATCH v2 3/3] drivers: add deprecated remarks to strlcat()
From: Andy Shevchenko
Date: Fri May 15 2026 - 03:33:26 EST
On Fri, May 15, 2026 at 10:30 AM Andy Shevchenko
<andy.shevchenko@xxxxxxxxx> wrote:
> On Fri, May 15, 2026 at 10:23 AM Geert Uytterhoeven
> <geert@xxxxxxxxxxxxxx> wrote:
> > On Thu, 14 May 2026 at 18:32, Manuel Ebner <manuelebner@xxxxxxxxxxx> wrote:
> > > add kernel-doc comment to strlcat() function definitions
...
> > > +/**
> > > + * strlcat - Append a string to an existing string
> > > + *
> > > + * @dest: pointer to %NUL-terminated string to append to
> > > + * @src: pointer to %NUL-terminated string to append from
> > > + * @count: Maximum bytes available in @dest
> > > + *
> >
> > Missing "Returns ...".
>
> Documentation says "Return:" as
I mean the kernel-doc documentation. Here the section is missed and
needs to be added, indeed.
> - the section (note important colon)
> - the singular (however plural is undocumented and supported)
>
> > > + * Do not use this function. Prefer building the string with
> > > + * formatting, via scnprintf(), seq_buf, or similar.
> > > + *
> > > + */
--
With Best Regards,
Andy Shevchenko