ksummit.lists.linux.dev archive mirror
 help / color / mirror / Atom feed
From: Julia Lawall <julia.lawall@lip6.fr>
To: "Peter Hüwe" <PeterHuewe@gmx.de>
Cc: Dan Carpenter <dan.carpenter@oracle.com>,
	ksummit-discuss@lists.linuxfoundation.org
Subject: Re: [Ksummit-discuss] [CORE-TOPIC] Documentation
Date: Sun, 12 Jul 2015 19:15:32 -0400 (EDT)	[thread overview]
Message-ID: <alpine.DEB.2.10.1507121910290.2657@hadrien> (raw)
In-Reply-To: <201507130038.01474.PeterHuewe@gmx.de>

> So this leads me to following questions:
> - How can we easily identify missing documentation?
> -- Maybe Julia can come up with some coccinelle magic?
> -- Maybe even mark non-extractable documentation and convert it.
> -- In the document it mentions scripts/basic/doproc.c checks for missing
> documentation, but this file does not exist anymore :/

Interesting idea.  I had not thought of this.  Coccinelle doesn't really
process comments, but one can always use grep.  So the idea would be to
find function definitions that don't have anything that looks like a
comment in the lines above (ie, the lines since the end of the previous
function definition).  One could furthermore rank the results by the
number of non-local calls to the function.  I guess there would be a lot
of reports, and it would be most productive to start with functions that
are commonly used,

julia

  reply	other threads:[~2015-07-12 23:15 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-07-12 22:38 Peter Hüwe
2015-07-12 23:15 ` Julia Lawall [this message]
2015-07-14 11:59   ` Mauro Carvalho Chehab
2015-07-13  9:47 ` Alexey Dobriyan
2015-07-13 16:01   ` Randy Dunlap
2015-07-13 16:37   ` Steven Rostedt
2015-07-13 16:46     ` David Woodhouse
2015-07-13 17:35       ` Steven Rostedt
2015-07-13 19:22         ` Peter Hüwe
2015-07-13 19:28       ` Peter Hüwe
2015-07-13 17:42     ` Jason Cooper
2015-07-13 18:11       ` Steven Rostedt
2015-07-14  3:56         ` Zefan Li
2015-07-13 19:25       ` Peter Hüwe
2015-07-13 22:10       ` Laurent Pinchart
2015-07-13 17:45   ` Jonathan Corbet
2015-07-13 19:46     ` Peter Hüwe
2015-07-14  2:36       ` Jonathan Corbet
2015-07-14  8:40         ` Laurent Pinchart
2015-07-14 11:19           ` Daniel Vetter
2015-07-14 12:43         ` Mauro Carvalho Chehab
2015-07-14 12:53           ` Jonathan Corbet
2015-07-14 13:57           ` Laurent Pinchart
2015-07-14  6:44       ` Johannes Berg
2015-07-13 19:20   ` Peter Hüwe
2015-07-13 23:01     ` Laurent Pinchart
2015-07-13 17:05 ` Lai Jiangshan
2015-07-13 17:42 ` Jonathan Corbet

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=alpine.DEB.2.10.1507121910290.2657@hadrien \
    --to=julia.lawall@lip6.fr \
    --cc=PeterHuewe@gmx.de \
    --cc=dan.carpenter@oracle.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