linux-kernel - 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-next>] [day] [month] [year] [list]

Message-ID: <20081216211824.GG12431@fluff.org.uk>
Date:	Tue, 16 Dec 2008 21:18:24 +0000
From:	Ben Dooks <ben-linux@...ff.org>
To:	linux-kernel@...r.kernel.org
Subject: Kernel function documentation question

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

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

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

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

-- 
Ben (ben@...ff.org, http://www.fluff.org/)

  'a smiley only costs 4 bytes'
--
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/