| 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
| ||
|
Message-ID: <20070107113649.GA4569@ucw.cz> Date: Sun, 7 Jan 2007 11:36:50 +0000 From: Pavel Machek <pavel@....cz> To: "Robert P. J. Day" <rpjday@...dspring.com> Cc: Linux kernel mailing list <linux-kernel@...r.kernel.org>, Randy Dunlap <randy.dunlap@...cle.com> Subject: Re: [PATCH] Discuss a couple common errors in kernel-doc usage. Hi! > Explain a couple of the most common errors in kernel-doc usage. > > Signed-off-by: Robert P. J. Day <rpjday@...dspring.com> > > --- > > seems useful to emphasize these issues since they occur occasionally > in the source. > > diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt > index 284e7e1..ba50129 100644 > --- a/Documentation/kernel-doc-nano-HOWTO.txt > +++ b/Documentation/kernel-doc-nano-HOWTO.txt > @@ -107,10 +107,14 @@ The format of the block comment is like this: > * (section header: (section description)? )* > (*)?*/ > > -The short function description cannot be multiline, but the other > -descriptions can be (and they can contain blank lines). Avoid putting a > -spurious blank line after the function name, or else the description will > -be repeated! > +The short function description ***cannot be multiline***, but the other Can we shout a bit less? Pavel -- Thanks for all the (sleeping) penguins. - 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/
Powered by blists - more mailing lists