linux-kernel - Re: Kernel function documentation question

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: <49481DC5.4000404@oracle.com>
Date:	Tue, 16 Dec 2008 13:29:41 -0800
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	Ben Dooks <ben-linux@...ff.org>
CC:	linux-kernel@...r.kernel.org
Subject: Re: Kernel function documentation question

Ben Dooks wrote:
> The Documentation/kernel-doc-nano-HOWTO.txt says that functions
> should be documented as so:

That's an example.  There is no "should" with that example.

> /**
>  * foobar() - short function description of foobar
> 
> I notice there are a number of places that ommit the () off the
> foobar, for example:
> 
> include/linux/skbuff.h, line 461:
> 
> /**
>  *	skb_get - reference buffer
>  *	@skb: buffer to reference
> 
> where skb_get does not have ()s.

That's perfectly fine.  The "formal" syntax is given later in that file:

The format of the block comment is like this:

/**
 * function_name(:)? (- short description)?
(* @parameterx(space)*: (description of parameter x)?)*
(* a blank line)?
 * (Description:)? (Description of function)?
 * (section header: (section description)? )*
(*)?*/


and those parentheses are (confusing) grouping characters, not literals.  :(


> As a note, it seems the default debian emacs does not colour the
> function name unless it ends ().

File a bug with debian?

> Also, is there any policy on tabs vs a single space for indenting
> these comments?

Nope.  I prefer a single space, but some people seem to prefer tab(s).

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