public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Johannes Berg <johannes@sipsolutions.net>
To: Randy Dunlap <rdunlap@xenotime.net>
Cc: LKML <linux-kernel@vger.kernel.org>
Subject: Re: [RFC] Docbook: allow warning on unused documentation
Date: Thu, 26 Aug 2010 18:51:16 +0200	[thread overview]
Message-ID: <1282841476.3812.69.camel@jlt3.sipsolutions.net> (raw)
In-Reply-To: <20100826093710.111b103e.rdunlap@xenotime.net>

On Thu, 2010-08-26 at 09:37 -0700, Randy Dunlap wrote:
> On Wed, 18 Aug 2010 15:09:27 +0200 Johannes Berg wrote:
> 
> > When you don't use !E or !I but only !F, then
> > it's very easy to miss including some functions,
> > structs etc. in documentation. To help finding
> > which ones were missed, allow printing out the
> > unused ones as warnings.
> 
> How do I test this?  Do I need to add !A to some source file?

Yeah, like to Documentation/DocBook/mac80211.tmpl you could add
!Ainclude/net/mac80211.h

> > +#define _GNU_SOURCE
> 
> Can you explain why that is needed?  (curious)

Yeah, I used asprintf somewhere.

> > +static void find_all_symbols(char *filename)
> > +{
> > +	char *vec[4]; /* kerneldoc -docbook -function "section" file NULL */
> 
> incorrect comment??

Oops, yes:

> > +	vec[0] = KERNELDOC;
> > +	vec[1] = LIST;
> > +	vec[2] = filename;
> > +	vec[3] = NULL;

johannes


  reply	other threads:[~2010-08-26 16:51 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-08-18 13:09 [RFC] Docbook: allow warning on unused documentation Johannes Berg
2010-08-26 16:37 ` Randy Dunlap
2010-08-26 16:51   ` Johannes Berg [this message]
2010-08-26 17:11     ` Randy Dunlap
2010-08-26 17:36       ` Johannes Berg
2010-08-26 17:43       ` [PATCH] " Johannes Berg
2010-08-26 18:48         ` Randy Dunlap

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=1282841476.3812.69.camel@jlt3.sipsolutions.net \
    --to=johannes@sipsolutions.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@xenotime.net \
    /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