openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

ecryptfs: mmap: Help out one function header and demote other abuses 

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

 fs/ecryptfs/mmap.c:26: warning: Incorrect use of kernel-doc format:  * ecryptfs_get_locked_page
 fs/ecryptfs/mmap.c:34: warning: Function parameter or member 'inode' not described in 'ecryptfs_get_locked_page'
 fs/ecryptfs/mmap.c:34: warning: Function parameter or member 'index' not described in 'ecryptfs_get_locked_page'
 fs/ecryptfs/mmap.c:34: warning: expecting prototype for eCryptfs(). Prototype was for ecryptfs_get_locked_page() instead
 fs/ecryptfs/mmap.c:52: warning: Function parameter or member 'wbc' not described in 'ecryptfs_writepage'
 fs/ecryptfs/mmap.c:98: warning: Incorrect use of kernel-doc format:  * ecryptfs_copy_up_encrypted_with_header
 fs/ecryptfs/mmap.c:110: warning: Function parameter or member 'page' not described in 'ecryptfs_copy_up_encrypted_with_header'
 fs/ecryptfs/mmap.c:110: warning: Function parameter or member 'crypt_stat' not described in 'ecryptfs_copy_up_encrypted_with_header'
 fs/ecryptfs/mmap.c:110: warning: expecting prototype for Header Extent(). Prototype was for ecryptfs_copy_up_encrypted_with_header() instead
 fs/ecryptfs/mmap.c:233: warning: wrong kernel-doc identifier on line:
 fs/ecryptfs/mmap.c:379: warning: Function parameter or member 'ecryptfs_inode' not described in 'ecryptfs_write_inode_size_to_header'

Cc: Tyler Hicks <code@tyhicks.com>
Cc: James Morris <jamorris@linux.microsoft.com>
Cc: Tycho Andersen <tycho@tycho.pizza>
Cc: Christian Brauner <christian.brauner@ubuntu.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>
This commit is contained in:
Lee Jones 2021-03-30 17:44:56 +01:00 committed by Tyler Hicks
parent 5da877eadf
commit 688a9f7cd8
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
fs/ecryptfs/mmap.c
View File

@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0-or-later // SPDX-License-Identifier: GPL-2.0-or-later
/** /*
* eCryptfs: Linux filesystem encryption layer * eCryptfs: Linux filesystem encryption layer
* This is where eCryptfs coordinates the symmetric encryption and * This is where eCryptfs coordinates the symmetric encryption and
* decryption of the file data as it passes between the lower * decryption of the file data as it passes between the lower
@ -22,7 +22,7 @@
#include <asm/unaligned.h> #include <asm/unaligned.h>
#include "ecryptfs_kernel.h" #include "ecryptfs_kernel.h"
/** /*
* ecryptfs_get_locked_page * ecryptfs_get_locked_page
* *
* Get one page from cache or lower f/s, return error otherwise. * Get one page from cache or lower f/s, return error otherwise.
@ -41,6 +41,7 @@ struct page *ecryptfs_get_locked_page(struct inode *inode, loff_t index)
/** /**
* ecryptfs_writepage * ecryptfs_writepage
* @page: Page that is locked before this call is made * @page: Page that is locked before this call is made
* @wbc: Write-back control structure
* *
* Returns zero on success; non-zero otherwise * Returns zero on success; non-zero otherwise
* *
@ -78,7 +79,7 @@ static void strip_xattr_flag(char *page_virt,
} }
} }
/** /*
* Header Extent: * Header Extent:
* Octets 0-7: Unencrypted file size (big-endian) * Octets 0-7: Unencrypted file size (big-endian)
* Octets 8-15: eCryptfs special marker * Octets 8-15: eCryptfs special marker
@ -229,7 +230,7 @@ static int ecryptfs_readpage(struct file *file, struct page *page)
return rc; return rc;
} }
/** /*
* Called with lower inode mutex held. * Called with lower inode mutex held.
*/ */
static int fill_zeros_to_end_of_page(struct page *page, unsigned int to) static int fill_zeros_to_end_of_page(struct page *page, unsigned int to)
@ -368,7 +369,7 @@ static int ecryptfs_write_begin(struct file *file,
return rc; return rc;
} }
/** /*
* ecryptfs_write_inode_size_to_header * ecryptfs_write_inode_size_to_header
* *
* Writes the lower file size to the first 8 bytes of the header. * Writes the lower file size to the first 8 bytes of the header.