ecryptfs: read_write: File headers do not make good candidates for kernel-doc
authorLee Jones <lee.jones@linaro.org>
Tue, 30 Mar 2021 16:44:46 +0000 (17:44 +0100)
committerTyler Hicks <code@tyhicks.com>
Mon, 19 Apr 2021 04:42:13 +0000 (04:42 +0000)
commit09d02efaafdc2114565a5ad218172b6064404f0f
tree94723a36b843665979afb3014d5b0aa5c158b6cd
parentb7f8f259896f669f131713b0c74ba4d008daa71d
ecryptfs: read_write: File headers do not make good candidates for kernel-doc

Provide missing param description for 'page_index' too.

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

 fs/ecryptfs/read_write.c:16: warning: Incorrect use of kernel-doc format:  * ecryptfs_write_lower
 fs/ecryptfs/read_write.c:29: warning: Function parameter or member 'ecryptfs_inode' not described in 'ecryptfs_write_lower'
 fs/ecryptfs/read_write.c:29: warning: Function parameter or member 'data' not described in 'ecryptfs_write_lower'
 fs/ecryptfs/read_write.c:29: warning: Function parameter or member 'offset' not described in 'ecryptfs_write_lower'
 fs/ecryptfs/read_write.c:29: warning: Function parameter or member 'size' not described in 'ecryptfs_write_lower'
 fs/ecryptfs/read_write.c:29: warning: expecting prototype for eCryptfs(). Prototype was for ecryptfs_write_lower() instead
 fs/ecryptfs/read_write.c:248: warning: Function parameter or member 'page_index' not described in 'ecryptfs_read_lower_page_segment'

Cc: Tyler Hicks <code@tyhicks.com>
Cc: "Michael A. Halcrow" <mahalcro@us.ibm.com>
Cc: ecryptfs@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Tyler Hicks <code@tyhicks.com>
fs/ecryptfs/read_write.c