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

From: Jonathan Corbet
Date: Thu Jun 09 2016 - 11:03:34 EST


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