Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751817AbXEXPHK (ORCPT ); Thu, 24 May 2007 11:07:10 -0400 Received: (majordomo@vger.kernel.org) by vger.kernel.org id S1751110AbXEXPGr (ORCPT ); Thu, 24 May 2007 11:06:47 -0400 Received: from rgminet01.oracle.com ([148.87.113.118]:62277 "EHLO rgminet01.oracle.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751046AbXEXPGq (ORCPT ); Thu, 24 May 2007 11:06:46 -0400 Date: Thu, 24 May 2007 08:11:50 -0700 From: Randy Dunlap To: Colin Watson Cc: linux-kernel@vger.kernel.org, akpm Subject: [PATCH v2] kernel-doc: fix leading dot in man-mode output Message-Id: <20070524081150.ccc7bcb6.randy.dunlap@oracle.com> In-Reply-To: References: <20070523205940.5bc4fdb2.randy.dunlap@oracle.com> Organization: Oracle Linux Eng. X-Mailer: Sylpheed 2.3.1 (GTK+ 2.8.10; x86_64-unknown-linux-gnu) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-Whitelist: TRUE X-Whitelist: TRUE X-Brightmail-Tracker: AAAAAQAAAAI= Sender: linux-kernel-owner@vger.kernel.org X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1653 Lines: 53 On Thu, 24 May 2007 08:59:28 +0100 Colin Watson wrote: > This is a very unusual way to escape leading "." in *roff, and I'm not > entirely sure the result is defined given that \{ is normally supposed > to be paired with \} and used to construct blocks. The more conventional > method would be: > > print "\\&$line"; > > (\& is a zero-width space.) Hi, and thanks. That's a good change. I appreciate it. --- From: Randy Dunlap If a parameter description begins with a '.', this indicates a "request" for "man" mode output (*roff), so it needs special handling. Problem case is in include/asm-i386/atomic.h for function atomic_add_unless(): * @u: ...unless v is equal to u. This parameter description is currently not printed in man mode output. Signed-off-by: Randy Dunlap --- scripts/kernel-doc | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) --- linux-2.6.21-rc2-git4.orig/scripts/kernel-doc +++ linux-2.6.21-rc2-git4/scripts/kernel-doc @@ -384,8 +384,13 @@ sub output_highlight { if ($line eq ""){ print $lineprefix, $blankline; } else { - $line =~ s/\\\\\\/\&/g; - print $lineprefix, $line; + $line =~ s/\\\\\\/\&/g; + if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { + print "\\&$line"; + } + else { + print $lineprefix, $line; + } } print "\n"; } - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/