Re: [Ksummit-discuss] [TECH TOPIC] Documentation

Joe Perches <[email protected]> Thu, 18 Jun 2020 07:40:22 -0700
Newsgroups org.linuxfoundation.lists.ksummit-discuss,dev.linux.lists.ksummit
Message-ID <[email protected]>
On Thu, 2020-06-18 at 12:04 +0300, Mike Rapoport wrote:
> if a patch breaks the sync between the code and the
> kerneldoc can it be detected by checkpatch.pl?

No, it can not.  Not directly.

Please remember that checkpatch is a trivial set
of regexes and that checkpatch looks only at
patch diff blocks line-by-line.

A patch block that changes a function argument
may not also contain the kernel-doc.

As there already is an existing tool, that tool
should be used when possible.

_______________________________________________
Ksummit-discuss mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss