Re: How to fix DocBook parsers for private fields inside #ifdefs

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, 1 Oct 2015 14:21:07 -0300
Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxx> 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
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux