[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20160609090327.762bbd41@lwn.net>
Date: Thu, 9 Jun 2016 09:03:27 -0600
From: Jonathan Corbet <corbet@....net>
To: Jani Nikula <jani.nikula@...el.com>
Cc: Markus Heiser <markus.heiser@...marit.de>,
Daniel Vetter <daniel.vetter@...ll.ch>,
Grant Likely <grant.likely@...retlab.ca>,
Mauro Carvalho Chehab <mchehab@....samsung.com>,
Keith Packard <keithp@...thp.com>,
LKML <linux-kernel@...r.kernel.org>, linux-doc@...r.kernel.org,
Hans Verkuil <hverkuil@...all.nl>
Subject: Re: [PATCH v2 29/38] kernel-doc: limit the "section header:"
detection to a select few
On Sat, 4 Jun 2016 14:37:30 +0300
Jani Nikula <jani.nikula@...el.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.
jon
Powered by blists - more mailing lists