Michael Halcrow 22e78fafbd eCryptfs: kerneldoc fixes for crypto.c and keystore.c
Andrew Morton wrote:
From: mhalcrow@us.ibm.com <mhalcrow@halcrow.austin.ibm.com>
> > +/**
> > + * decrypt_passphrase_encrypted_session_key - Decrypt the session key
> > + * with the given auth_tok.
> >   *
> >   * Returns Zero on success; non-zero error otherwise.
> >   */
>
> That comment purports to be a kerneldoc-style comment.  But
>
> - kerneldoc doesn't support multiple lines on the introductory line
>   which identifies the name of the function (alas).  So you'll need to
>   overflow 80 cols here.
>
> - the function args weren't documented
>
> But the return value is!  People regularly forget to do that.  And
> they frequently forget to document the locking prerequisites and the
> permissible calling contexts (process/might_sleep/hardirq, etc)
>
> (please check all ecryptfs kerneldoc for this stuff sometime)

This patch cleans up some of the existing comments and makes a couple
of line break tweaks. There is more work to do to bring eCryptfs into
full kerneldoc-compliance.

Signed-off-by: Michael Halcrow <mhalcrow@us.ibm.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2007-10-16 09:43:11 -07:00
..
2007-10-16 09:42:57 -07:00
2007-10-16 09:42:58 -07:00
2007-08-22 19:52:46 -07:00
2007-10-16 09:42:56 -07:00
2007-10-16 09:42:55 -07:00
2007-10-15 17:56:36 -07:00
2007-05-08 11:14:59 -07:00
2007-10-16 09:42:58 -07:00
2007-10-16 09:42:55 -07:00
2007-10-16 09:42:55 -07:00
2007-10-16 09:42:55 -07:00
2007-10-16 09:42:57 -07:00
2007-10-16 09:42:55 -07:00
2007-10-16 09:42:56 -07:00
2007-10-16 09:42:56 -07:00
2007-10-16 09:43:07 -07:00
2007-10-16 09:42:56 -07:00
2007-10-16 09:43:03 -07:00
2007-10-16 09:42:57 -07:00
2007-10-16 09:42:58 -07:00
2007-10-16 09:42:57 -07:00
2007-10-16 09:42:57 -07:00
2007-07-16 09:05:52 -07:00
2007-10-12 09:16:30 -07:00
2007-10-16 09:42:58 -07:00
2007-10-16 09:42:56 -07:00
2007-10-16 09:42:55 -07:00
2007-10-16 09:42:57 -07:00
2007-10-16 09:42:55 -07:00
2007-10-16 09:42:57 -07:00
2007-10-16 09:42:57 -07:00
2007-10-16 09:42:57 -07:00
2007-10-16 09:42:55 -07:00
2007-10-08 12:58:14 -07:00
2007-10-16 09:42:53 -07:00
2007-10-16 09:42:53 -07:00
2007-10-16 09:42:55 -07:00
2007-07-19 10:04:43 -07:00
2007-07-19 10:04:45 -07:00
2007-07-29 17:09:29 -07:00
2007-10-16 09:42:53 -07:00
2007-05-18 13:09:34 -07:00
2007-09-20 13:19:59 -07:00
2007-05-21 09:18:19 -07:00
2007-05-08 11:15:01 -07:00
2007-10-10 09:25:57 +02:00
2007-05-08 11:15:09 -07:00
2007-07-16 09:05:48 -07:00
2007-05-11 08:29:36 -07:00
2007-10-16 09:42:54 -07:00
2007-07-19 10:04:45 -07:00
2007-10-15 17:00:19 +02:00
2007-07-27 15:40:13 -07:00
2007-09-20 13:19:59 -07:00
2007-07-16 09:05:46 -07:00