From: Mike Rapoport <rppt@linux.ibm.com>
To: Joe Perches <joe@perches.com>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
ksummit <ksummit-discuss@lists.linuxfoundation.org>
Subject: Re: [Ksummit-discuss] [TECH TOPIC] Documentation
Date: Thu, 9 Jul 2020 15:11:36 +0300 [thread overview]
Message-ID: <20200709121136.GG781326@linux.ibm.com> (raw)
In-Reply-To: <60434f00e5bc55d2ceac14bb6a8c00d4d17c4e96.camel@perches.com>
On Thu, Jul 09, 2020 at 04:42:58AM -0700, Joe Perches wrote:
> On Thu, 2020-07-09 at 12:21 +0200, Mauro Carvalho Chehab wrote:
> > Em Thu, 18 Jun 2020 07:40:22 -0700
> > Joe Perches <joe@perches.com> escreveu:
> >
> > > 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.
> >
> > Well, perhaps checkpatch.pl could run:
> >
> > ./scripts/kernel-doc -none
> >
> > if it finds "/**" on a patch, showing the warnings produced by it, if any.
>
> checkpatch runs on patches.
> Use the tools that are designed for this instead.
The problem is that people usually do run checkpatch and do not run
kernel-doc. That's where the idea to somehow put documentation checks
into checkpatch came from.
> > > As there already is an existing tool, that tool
> > > should be used when possible.
>
>
--
Sincerely yours,
Mike.
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
next prev parent reply other threads:[~2020-07-09 12:11 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-09 20:53 [Ksummit-discuss] [TECH TOPIC] Documentation Jonathan Corbet
2020-06-10 8:49 ` Dan Carpenter
2020-06-11 8:21 ` Daniel Vetter
2020-06-11 14:48 ` Linus Walleij
2020-06-11 18:03 ` Shuah Khan
2020-06-11 18:28 ` Joe Perches
2020-06-11 19:44 ` Shuah Khan
2020-06-12 8:18 ` Laurent Pinchart
2020-06-12 9:19 ` Mike Rapoport
2020-06-12 10:58 ` Mark Brown
2020-06-12 15:48 ` Shuah Khan
2020-06-12 9:07 ` Mike Rapoport
2020-06-12 16:08 ` Shuah Khan
2020-06-13 16:42 ` Julia Lawall
2020-06-13 16:51 ` Joe Perches
2020-06-13 17:04 ` Julia Lawall
2020-06-14 13:23 ` Matthew Wilcox
2020-06-14 14:13 ` Mike Rapoport
2020-06-15 9:46 ` Jani Nikula
2020-06-18 9:04 ` Mike Rapoport
2020-06-18 14:40 ` Joe Perches
[not found] ` <20200709122118.0ffaea91@coco.lan>
2020-07-09 11:42 ` Joe Perches
2020-07-09 12:11 ` Mike Rapoport [this message]
2020-07-09 16:59 ` Joe Perches
2020-07-09 17:29 ` Mike Rapoport
2020-07-09 17:57 ` Andrew Lunn
[not found] ` <104986.1594328429@turing-police>
2020-07-10 0:03 ` Joe Perches
2020-06-13 17:05 ` Laurent Pinchart
2020-06-18 9:08 ` Mike Rapoport
-- strict thread matches above, loose matches on Subject: below --
2019-06-12 14:54 Jonathan Corbet
2019-06-12 18:22 ` Shuah Khan
2019-06-12 19:12 ` Martin K. Petersen
2019-06-12 19:43 ` Shuah Khan
2019-06-13 14:25 ` Mauro Carvalho Chehab
2019-06-14 21:40 ` Shuah Khan
2019-06-15 0:05 ` Mauro Carvalho Chehab
2019-06-17 10:12 ` Mauro Carvalho Chehab
2019-06-17 17:21 ` Mauro Carvalho Chehab
2019-06-12 20:33 ` Kate Stewart
2019-06-13 14:17 ` Mauro Carvalho Chehab
2019-06-13 14:57 ` Mauro Carvalho Chehab
2019-06-13 18:48 ` Greg KH
2019-06-13 19:01 ` Mauro Carvalho Chehab
2019-06-20 18:36 ` Kees Cook
2019-06-20 19:28 ` Jonathan Corbet
2019-07-22 14:52 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200709121136.GG781326@linux.ibm.com \
--to=rppt@linux.ibm.com \
--cc=joe@perches.com \
--cc=ksummit-discuss@lists.linuxfoundation.org \
--cc=mchehab+huawei@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).