Re: is there any quality checking on kernel-doc that goes into kernel?

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

 



On 09/24/13 08:07, Randy Dunlap wrote:
> On 09/24/13 06:39, Robert P. J. Day wrote:
>>
>>   it seems that, as time goes by, any kernel-doc content that gets
>> cleaned up is simply offset by more utterly unbuildable crap that's
>> introduced. i just tried a simple "make htmldocs" and got screen after
>> screen of errors, culminating in an actual fatal error:
>>
>> kernel-api.xml:9483: element refentry: validity error : ID API-kmalloc
>> already defined
>> <refentry id="API-kmalloc">
> 
> Patch for that was posted to the linux-mm mailing list a few days ago.
> I expect that travel/conferences (and low priority) has caused it not to
> be merged yet.  OTOH, it is not a fatal error (it does not stop kernel-doc
> from continuing).

Ah, the fatal Error that I see is from include/linux/regulator/driver.h:

Error(include/linux/regulator/driver.h:52): cannot understand prototype: 'struct regulator_linear_range '

and I have already sent a patch for that to the Regulators maintainer.
He also asked for a patch to scripts/kernel-doc to make that a Warning instead
of a fatal Error, which is OK with me.  How does that sound to others???


>> and i notice that there is *still* no fix for changing XHTML
>> generation back to HTML, even though that problem has existed for well
>> over a year.
>>
>>   what is the point of encouraging people to use kerneldoc if there is
>> absolutely no quality control on it?
> 
> I encourage people to do any kind of documentation.
> kernel-doc is just one option.
> 
> BTW, I run 'make htmldocs' on every -rc and linus release kernel
> and try to fix any errors and some warnings.
> 
> Fengguang Wu has recently added 'make htmldocs' to his linux-next testing
> so that errors and warnings can be detected sooner.  In the past I had
> tried testing linux-next but the amount of problems and lack of merging
> some of them (both my patches and the original patches in linux-next)
> made it seem not so worthwhile to me.
> 


-- 
~Randy
--
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