linux-kernel - Re: kernel-doc problem

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: <1282232221.4507.12.camel@jlt3.sipsolutions.net>
Date:	Thu, 19 Aug 2010 17:37:01 +0200
From:	Johannes Berg <johannes@...solutions.net>
To:	Randy Dunlap <rdunlap@...otime.net>
Cc:	LKML <linux-kernel@...r.kernel.org>
Subject: Re: kernel-doc problem

On Thu, 2010-08-19 at 08:30 -0700, Randy Dunlap wrote:

> > --- here's the file ---
> > /**
> >  * fn - test
> >  *
> >  * @a: This is just a non-sense and totally useless dummy function
> >  *	argument: it has absolutely no effect.
> >  */
> > void fn(int a)
> > {
> > }
> 
> Colons (':') are bad.  They cause a section instance.

Yeah, that's what I found.

> I don't know how to fix it (inside kernel-doc or docproc or xmlto or wherever).
> Sometimes I change colon to "--" or "." or something that makes some sense,
> but colon is still the better choice if it would work.

Ok.

Actually, I can think of something. When we have a line that starts with
this kind of pattern, assume that the next line is a continuation of it
and do not pattern match it, unless there was a blank line. I guess that
needs a special case for @...: though.

johannes

--
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/