korg/linux
0
0
Fork 0
mirror of https://mirrors.bfsu.edu.cn/git/linux.git synced 2024-11-11 04:18:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

nilfs2: cpfile: fix some kernel-doc warnings

Browse Source 
Correct the function parameter names for nilfs_cpfile_get_info():

cpfile.c:564: warning: Function parameter or member 'cnop' not described in 'nilfs_cpfile_get_cpinfo'
cpfile.c:564: warning: Function parameter or member 'mode' not described in 'nilfs_cpfile_get_cpinfo'
cpfile.c:564: warning: Function parameter or member 'buf' not described in 'nilfs_cpfile_get_cpinfo'
cpfile.c:564: warning: Function parameter or member 'cisz' not described in 'nilfs_cpfile_get_cpinfo'
cpfile.c:564: warning: Excess function parameter 'cno' description in 'nilfs_cpfile_get_cpinfo'
cpfile.c:564: warning: Excess function parameter 'ci' description in 'nilfs_cpfile_get_cpinfo'

Also add missing descriptions of the function's specification.

[ konishi.ryusuke@gmail.com: filled in missing descriptions ]

Link: https://lkml.kernel.org/r/20231220065931.2372-1-rdunlap@infradead.org
Link: https://lkml.kernel.org/r/20231220221342.11505-1-konishi.ryusuke@gmail.com
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Ryusuke Konishi <konishi.ryusuke@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
This commit is contained in:
Randy Dunlap 2023-12-21 07:13:42 +09:00 committed by Andrew Morton
parent 5f981878c7
commit 8e226a0a8d
1 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
fs/nilfs2/cpfile.c
View File

@ -552,11 +552,29 @@ static ssize_t nilfs_cpfile_do_get_ssinfo(struct inode *cpfile, __u64 *cnop,
}
/**
* nilfs_cpfile_get_cpinfo -
* @cpfile:
* @cno:
* @ci:
* @nci:
* nilfs_cpfile_get_cpinfo - get information on checkpoints
* @cpfile: checkpoint file inode
* @cnop: place to pass a starting checkpoint number and receive a
* checkpoint number to continue the search
* @mode: mode of checkpoints that the caller wants to retrieve
* @buf: buffer for storing checkpoints' information
* @cisz: byte size of one checkpoint info item in array
* @nci: number of checkpoint info items to retrieve
*
* nilfs_cpfile_get_cpinfo() searches for checkpoints in @mode state
* starting from the checkpoint number stored in @cnop, and stores
* information about found checkpoints in @buf.
* The buffer pointed to by @buf must be large enough to store information
* for @nci checkpoints. If at least one checkpoint information is
* successfully retrieved, @cnop is updated to point to the checkpoint
* number to continue searching.
*
* Return: Count of checkpoint info items stored in the output buffer on
* success, or the following negative error code on failure.
* * %-EINVAL - Invalid checkpoint mode.
* * %-ENOMEM - Insufficient memory available.
* * %-EIO - I/O error (including metadata corruption).
* * %-ENOENT - Invalid checkpoint number specified.
*/
ssize_t nilfs_cpfile_get_cpinfo(struct inode *cpfile, __u64 *cnop, int mode,