From: Michael Halcrow <mhalcrow@us.ibm.com>
Date: Tue, 6 Jan 2009 22:42:04 +0000 (-0800)
Subject: eCryptfs: kerneldoc for ecryptfs_parse_tag_70_packet()
X-Git-Tag: v2.6.29-rc1~299
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=7d8bc2be51706152828164b305e969b4a8471041;p=platform%2Fkernel%2Flinux-3.10.git

eCryptfs: kerneldoc for ecryptfs_parse_tag_70_packet()

Kerneldoc updates for ecryptfs_parse_tag_70_packet().

Signed-off-by: Michael Halcrow <mhalcrow@us.ibm.com>
Cc: Dustin Kirkland <dustin.kirkland@gmail.com>
Cc: Eric Sandeen <sandeen@redhat.com>
Cc: Tyler Hicks <tchicks@us.ibm.com>
Cc: David Kleikamp <shaggy@us.ibm.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
---

diff --git a/fs/ecryptfs/keystore.c b/fs/ecryptfs/keystore.c
index c90ca5d..ff53942 100644
--- a/fs/ecryptfs/keystore.c
+++ b/fs/ecryptfs/keystore.c
@@ -771,6 +771,17 @@ struct ecryptfs_parse_tag_70_packet_silly_stack {
 /**
  * parse_tag_70_packet - Parse and process FNEK-encrypted passphrase packet
  * @filename: This function kmalloc's the memory for the filename
+ * @filename_size: This function sets this to the amount of memory
+ *                 kmalloc'd for the filename
+ * @packet_size: This function sets this to the the number of octets
+ *               in the packet parsed
+ * @mount_crypt_stat: The mount-wide cryptographic context
+ * @data: The memory location containing the start of the tag 70
+ *        packet
+ * @max_packet_size: The maximum legal size of the packet to be parsed
+ *                   from @data
+ *
+ * Returns zero on success; non-zero otherwise
  */
 int
 ecryptfs_parse_tag_70_packet(char **filename, size_t *filename_size,