Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

ecryptfs: keystore: Fix some kernel-doc issues and demote non-conformant headers

Fixes the following W=1 kernel build warning(s):

fs/ecryptfs/keystore.c:25: warning: Incorrect use of kernel-doc format: * request_key returned an error instead of a valid key address;
fs/ecryptfs/keystore.c:30: warning: Function parameter or member 'err_code' not described in 'process_request_key_err'
fs/ecryptfs/keystore.c:30: warning: expecting prototype for eCryptfs(). Prototype was for process_request_key_err() instead
fs/ecryptfs/keystore.c:558: warning: Function parameter or member 'auth_tok_key' not described in 'ecryptfs_find_auth_tok_for_sig'
fs/ecryptfs/keystore.c:558: warning: Function parameter or member 'mount_crypt_stat' not described in 'ecryptfs_find_auth_tok_for_sig'
fs/ecryptfs/keystore.c:558: warning: Excess function parameter 'crypt_stat' description in 'ecryptfs_find_auth_tok_for_sig'
fs/ecryptfs/keystore.c:584: warning: cannot understand function prototype: 'struct ecryptfs_write_tag_70_packet_silly_stack '
fs/ecryptfs/keystore.c:622: warning: Function parameter or member 'dest' not described in 'ecryptfs_write_tag_70_packet'
fs/ecryptfs/keystore.c:622: warning: Function parameter or member 'remaining_bytes' not described in 'ecryptfs_write_tag_70_packet'
fs/ecryptfs/keystore.c:622: warning: Function parameter or member 'packet_size' not described in 'ecryptfs_write_tag_70_packet'
fs/ecryptfs/keystore.c:622: warning: Function parameter or member 'mount_crypt_stat' not described in 'ecryptfs_write_tag_70_packet'
fs/ecryptfs/keystore.c:622: warning: Function parameter or member 'filename_size' not described in 'ecryptfs_write_tag_70_packet'
fs/ecryptfs/keystore.c:622: warning: expecting prototype for write_tag_70_packet(). Prototype was for ecryptfs_write_tag_70_packet() instead
fs/ecryptfs/keystore.c:895: warning: expecting prototype for parse_tag_70_packet(). Prototype was for ecryptfs_parse_tag_70_packet() instead

Cc: Tyler Hicks <code@tyhicks.com>
Cc: "Michael A. Halcrow" <mhalcrow@us.ibm.com>
Cc: "Michael C. Thompson" <mcthomps@us.ibm.com>
Cc: "Trevor S. Highland" <trevor.highland@gmail.com>
Cc: ecryptfs@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Tyler Hicks <code@tyhicks.com>

authored by

Lee Jones and committed by
Tyler Hicks
ffbed072 d17074ac

+7 -6
+7 -6
fs/ecryptfs/keystore.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0-or-later 2 - /** 2 + /* 3 3 * eCryptfs: Linux filesystem encryption layer 4 4 * In-kernel key management code. Includes functions to parse and 5 5 * write authentication token-related packets with the underlying ··· 21 21 #include <linux/slab.h> 22 22 #include "ecryptfs_kernel.h" 23 23 24 - /** 24 + /* 25 25 * request_key returned an error instead of a valid key address; 26 26 * determine the type of error, make appropriate log entries, and 27 27 * return an error code. ··· 536 536 537 537 /** 538 538 * ecryptfs_find_auth_tok_for_sig 539 + * @auth_tok_key: key containing the authentication token 539 540 * @auth_tok: Set to the matching auth_tok; NULL if not found 540 - * @crypt_stat: inode crypt_stat crypto context 541 + * @mount_crypt_stat: inode crypt_stat crypto context 541 542 * @sig: Sig of auth_tok to find 542 543 * 543 544 * For now, this function simply looks at the registered auth_tok's ··· 577 576 return rc; 578 577 } 579 578 580 - /** 579 + /* 581 580 * write_tag_70_packet can gobble a lot of stack space. We stuff most 582 581 * of the function's parameters in a kmalloc'd struct to help reduce 583 582 * eCryptfs' overall stack usage. ··· 605 604 struct shash_desc *hash_desc; 606 605 }; 607 606 608 - /** 607 + /* 609 608 * write_tag_70_packet - Write encrypted filename (EFN) packet against FNEK 610 609 * @filename: NULL-terminated filename string 611 610 * ··· 874 873 }; 875 874 876 875 /** 877 - * parse_tag_70_packet - Parse and process FNEK-encrypted passphrase packet 876 + * ecryptfs_parse_tag_70_packet - Parse and process FNEK-encrypted passphrase packet 878 877 * @filename: This function kmalloc's the memory for the filename 879 878 * @filename_size: This function sets this to the amount of memory 880 879 * kmalloc'd for the filename