linux-kernel - Re: [PATCH] Better document some regset helper functions

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: <20090428025926.599FEFC3C6@magilla.sf.frob.com>
Date:	Mon, 27 Apr 2009 19:59:26 -0700 (PDT)
From:	Roland McGrath <roland@...hat.com>
To:	David Howells <dhowells@...hat.com>
Cc:	torvalds@...l.org, akpm@...ux-foundation.org,
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH] Better document some regset helper functions

I'm all for better comments and your text looks fine to me.

The reason I had not used kerneldoc comments for those helpers is that
these are the private helpers purely for the use of arch code implementing
user_regset accessor functions.  By contrast, the calls in linux/regset.h
that have kerneldoc comments are those that generic code (including future
modules, etc.) uses.  When generating DocBook or man pages, the regset.h
functions are grouped together and those that have kerneldoc today make
sense to have there, but IMHO these inline helpers for arch code do not.

Thanks,
Roland
--
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/