Re: [PATCH v2 29/38] kernel-doc: limit the "section header:" detection to a select few

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

 



On Sat,  4 Jun 2016 14:37:30 +0300
Jani Nikula <jani.nikula@xxxxxxxxx> wrote:

> kernel-doc currently identifies anything matching "section header:"
> (specifically a string of word characters and spaces followed by a
> colon) as a new section in the documentation comment, and renders the
> section header accordingly.
> 
> Unfortunately, this turns all uses of colon into sections, mostly
> unintentionally.

I've been looking at how the patch series changes (traditional) htmldocs
generation, and this one is responsible for a lot of them.  Those changes
are almost all good!  There is a lot of cruft out there.  Just FWIW, I'm
going to add a patch putting "note|examples|" into the list, since those
appear to be intentional.

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