Messages in this thread | | | From | Jani Nikula <> | Subject | Re: [PATCH v2 29/38] kernel-doc: limit the "section header:" detection to a select few | Date | Thu, 09 Jun 2016 19:39:34 +0300 |
| |
On Thu, 09 Jun 2016, Jonathan Corbet <corbet@lwn.net> wrote: > On Sat, 4 Jun 2016 14:37:30 +0300 > Jani Nikula <jani.nikula@intel.com> 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.
Heh, you scared me a bit until the "almost all good" part. :)
I'm fine with adding more to the list, although I intentionally tried to keep them to a minimum initially. I had this vague idea of turning some of the "note" and "warning" type things into rst admonitions [1] later on, but I don't really have a concrete plan yet.
BR, Jani.
[1] http://docutils.sourceforge.net/docs/ref/rst/directives.html#admonitions
-- Jani Nikula, Intel Open Source Technology Center
| |