linux-kernel - [PATCH v2] kernel-doc: fix leading dot in man-mode output

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-Id: <20070524081150.ccc7bcb6.randy.dunlap@oracle.com>
Date:	Thu, 24 May 2007 08:11:50 -0700
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	Colin Watson <cjwatson@...ian.org>
Cc:	linux-kernel@...r.kernel.org, akpm <akpm@...ux-foundation.org>
Subject: [PATCH v2] kernel-doc: fix leading dot in man-mode output

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 <randy.dunlap@...cle.com>

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 <randy.dunlap@...cle.com>
---
 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@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/