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

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>

authored by

Lee Jones and committed by
Tyler Hicks
09d02efa b7f8f259

+3 -1
+3 -1
fs/ecryptfs/read_write.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0-or-later 2 - /** 2 + /* 3 3 * eCryptfs: Linux filesystem encryption layer 4 4 * 5 5 * Copyright (C) 2007 International Business Machines Corp. ··· 230 230 * ecryptfs_read_lower_page_segment 231 231 * @page_for_ecryptfs: The page into which data for eCryptfs will be 232 232 * written 233 + * @page_index: Page index in @page_for_ecryptfs from which to start 234 + * writing 233 235 * @offset_in_page: Offset in @page_for_ecryptfs from which to start 234 236 * writing 235 237 * @size: The number of bytes to write into @page_for_ecryptfs