From: Matthew Wilcox <willy6545@gmail.com>
To: Joe Perches <joe@perches.com>
Cc: ksummit <ksummit-discuss@lists.linuxfoundation.org>
Subject: Re: [Ksummit-discuss] [TECH TOPIC] Documentation
Date: Sun, 14 Jun 2020 09:23:41 -0400 [thread overview]
Message-ID: <CAFhKne9K5KBwHncm5-AWmRuUrtO+iJzTAvGJUEW9d6XXgyr_4w@mail.gmail.com> (raw)
In-Reply-To: <8dff373fabbbe6ae20512848e93dac7544e0abce.camel@perches.com>
[-- Attachment #1.1: Type: text/plain, Size: 3804 bytes --]
Also W=1 will enable documentation warnings. We can move that to default if
we want people to take documentation seriously. Last time I tried it added
about 700 warnings to the build and I didn't have the spoons to make a
serious dent in fixing those warnings.
Maybe _that_ would be a good beginner task because it doesn't take much in
depth knowledge of any particular subsystem.
On Sat., Jun. 13, 2020, 12:57 Joe Perches, <joe@perches.com> wrote:
> On Sat, 2020-06-13 at 18:42 +0200, Julia Lawall wrote:
> > I tried collecting information about missing or incorrectly formatted
> > function documentation using Coccinelle. Here is an example of the
> > output:
> >
> > drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr:
> extra names mod, f_isr, h_src_arg
> > drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr:
> missing name isr_cb
> > drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr:
> missing name module
> > drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr:
> missing name src_arg
> > drivers/net/ethernet/freescale/fman/fman.c:2077 fman_register_intr:
> return comment but no return value
> > drivers/net/ethernet/freescale/fman/fman.c:2103 fman_unregister_intr:
> extra names mod
> > drivers/net/ethernet/freescale/fman/fman.c:2103 fman_unregister_intr:
> missing name module
> > drivers/net/ethernet/freescale/fman/fman.c:2103 fman_unregister_intr:
> return comment but no return value
> > drivers/net/ethernet/freescale/fman/fman.c:2355 fman_get_revision:
> return comment but no return value
> > drivers/net/ethernet/freescale/fman/fman.c:2520 fman_bind: extra names
> dev
> > drivers/net/ethernet/freescale/fman/fman.c:2520 fman_bind: missing name
> fm_dev
> > drivers/net/ethernet/freescale/fman/fman.c:2527 fman_has_errata_a050385:
> no comment for fman_has_errata_a050385
>
> just fyi: scripts/kernel-doc already does:
>
> $ ./scripts/kernel-doc drivers/net/ethernet/freescale/fman/fman.c >
> /dev/null
> drivers/net/ethernet/freescale/fman/fman.c:2080: warning: Function
> parameter or member 'module' not described in 'fman_register_intr'
> drivers/net/ethernet/freescale/fman/fman.c:2080: warning: Function
> parameter or member 'isr_cb' not described in 'fman_register_intr'
> drivers/net/ethernet/freescale/fman/fman.c:2080: warning: Function
> parameter or member 'src_arg' not described in 'fman_register_intr'
> drivers/net/ethernet/freescale/fman/fman.c:2080: warning: Excess function
> parameter 'mod' description in 'fman_register_intr'
> drivers/net/ethernet/freescale/fman/fman.c:2080: warning: Excess function
> parameter 'f_isr' description in 'fman_register_intr'
> drivers/net/ethernet/freescale/fman/fman.c:2080: warning: Excess function
> parameter 'h_src_arg' description in 'fman_register_intr'
> drivers/net/ethernet/freescale/fman/fman.c:2105: warning: Function
> parameter or member 'module' not described in 'fman_unregister_intr'
> drivers/net/ethernet/freescale/fman/fman.c:2105: warning: Excess function
> parameter 'mod' description in 'fman_unregister_intr'
> drivers/net/ethernet/freescale/fman/fman.c:2356: warning: Function
> parameter or member 'fman' not described in 'fman_get_revision'
> drivers/net/ethernet/freescale/fman/fman.c:2356: warning: Function
> parameter or member 'rev_info' not described in 'fman_get_revision'
> drivers/net/ethernet/freescale/fman/fman.c:2521: warning: Function
> parameter or member 'fm_dev' not described in 'fman_bind'
> drivers/net/ethernet/freescale/fman/fman.c:2521: warning: Excess function
> parameter 'dev' description in 'fman_bind'
>
>
>
> _______________________________________________
> Ksummit-discuss mailing list
> Ksummit-discuss@lists.linuxfoundation.org
> https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
>
[-- Attachment #1.2: Type: text/html, Size: 4654 bytes --]
[-- Attachment #2: Type: text/plain, Size: 186 bytes --]
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
next prev parent reply other threads:[~2020-06-14 13:24 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 [this message]
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
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=CAFhKne9K5KBwHncm5-AWmRuUrtO+iJzTAvGJUEW9d6XXgyr_4w@mail.gmail.com \
--to=willy6545@gmail.com \
--cc=joe@perches.com \
--cc=ksummit-discuss@lists.linuxfoundation.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).