From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752664AbcFIPDb (ORCPT ); Thu, 9 Jun 2016 11:03:31 -0400 Received: from tex.lwn.net ([70.33.254.29]:57914 "EHLO vena.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751469AbcFIPD3 (ORCPT ); Thu, 9 Jun 2016 11:03:29 -0400 Date: Thu, 9 Jun 2016 09:03:27 -0600 From: Jonathan Corbet To: Jani Nikula Cc: Markus Heiser , Daniel Vetter , Grant Likely , Mauro Carvalho Chehab , Keith Packard , LKML , linux-doc@vger.kernel.org, Hans Verkuil Subject: Re: [PATCH v2 29/38] kernel-doc: limit the "section header:" detection to a select few Message-ID: <20160609090327.762bbd41@lwn.net> In-Reply-To: References: Organization: LWN.net MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Sat, 4 Jun 2016 14:37:30 +0300 Jani Nikula 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