From: Jonathan Corbet <corbet@lwn.net>
To: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Cc: linux-doc@vger.kernel.org, linux-media@vger.kernel.org
Subject: Re: How to fix DocBook parsers for private fields inside #ifdefs
Date: Mon, 5 Oct 2015 04:56:35 -0600 [thread overview]
Message-ID: <20151005045635.455b20eb@lwn.net> (raw)
In-Reply-To: <20151001142107.5a0bf7b2@recife.lan>
On Thu, 1 Oct 2015 14:21:07 -0300
Mauro Carvalho Chehab <mchehab@osg.samsung.com> wrote:
> They're all after a private comment:
> /* Private: internal use only */
>
> So, according with Documentation/kernel-doc-nano-HOWTO.txt, they shold
> have been ignored.
>
> Still, the scripts produce warnings for them:
Sorry, I've been away from the keyboard for a few days and am only now
catching up.
The problem is that kernel-doc is dumb...the test is case-sensitive, so
it needs to be "private:", not "Private:". I'm sure there's a magic perl
regex parameter to make the test case-insensitive; when I get a chance
I'll figure it out and put it in there.
(Of course, once you fix that glitch, you'll get gripes about the fields
that are marked private but documented anyway. Like I said, kernel-doc
is dumb.)
jon
next prev parent reply other threads:[~2015-10-05 10:56 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-10-01 17:21 How to fix DocBook parsers for private fields inside #ifdefs Mauro Carvalho Chehab
2015-10-05 10:56 ` Jonathan Corbet [this message]
2015-10-05 12:03 ` Mauro Carvalho Chehab
2015-10-05 12:35 ` kbuild test robot
2015-10-11 21:38 ` 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=20151005045635.455b20eb@lwn.net \
--to=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=mchehab@osg.samsung.com \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.