Commit 09d02efa authored Mar 30, 2021 by Lee Jones Committed by Tyler Hicks Apr 19, 2021

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>

parent b7f8f259

fs/ecryptfs/read_write.c

+3 −1

Original line number	Diff line number	Diff line
		// SPDX-License-Identifier: GPL-2.0-or-later
		/**
		/*
		* eCryptfs: Linux filesystem encryption layer
		*
		* Copyright (C) 2007 International Business Machines Corp.
		@@ -230,6 +230,8 @@ int ecryptfs_read_lower(char *data, loff_t offset, size_t size,
		* ecryptfs_read_lower_page_segment
		* @page_for_ecryptfs: The page into which data for eCryptfs will be
		* written
		* @page_index: Page index in @page_for_ecryptfs from which to start
		* writing
		* @offset_in_page: Offset in @page_for_ecryptfs from which to start
		* writing
		* @size: The number of bytes to write into @page_for_ecryptfs