Re: [PATCH] checkpatch: Added warnings in favor of strscpy().

From: Jonathan Corbet
Date: Mon Jul 22 2019 - 17:57:34 EST


On Mon, 22 Jul 2019 14:50:09 -0700
Joe Perches <joe@xxxxxxxxxxx> wrote:

> On Mon, 2019-07-22 at 23:01 +0200, Stephen Kitt wrote:
> > How about you submit your current patch set, and I follow up with the above
> > adapted to stracpy?
>
> OK, I will shortly after I figure out how to add kernel-doc
> for stracpy/stracpy_pad to lib/string.c.
>
> It doesn't seem appropriate to add the kernel-doc to string.h
> as it would be separated from the others in string.c
>
> Anyone got a clue here? Jonathan?

If the functions themselves are fully defined in the .h file, I'd just add
the kerneldoc there as well. That's how it's usually done, and you want
to keep the documentation and the prototypes together.

jon