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

Configure Feed

Select the types of activity you want to include in your feed.

nilfs2: cpfile: fix some kernel-doc warnings

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>

authored by

Randy Dunlap and committed by
Andrew Morton 8e226a0a 5f981878

+23 -5
+23 -5
fs/nilfs2/cpfile.c
··· 552 552 } 553 553 554 554 /** 555 - * nilfs_cpfile_get_cpinfo - 556 - * @cpfile: 557 - * @cno: 558 - * @ci: 559 - * @nci: 555 + * nilfs_cpfile_get_cpinfo - get information on checkpoints 556 + * @cpfile: checkpoint file inode 557 + * @cnop: place to pass a starting checkpoint number and receive a 558 + * checkpoint number to continue the search 559 + * @mode: mode of checkpoints that the caller wants to retrieve 560 + * @buf: buffer for storing checkpoints' information 561 + * @cisz: byte size of one checkpoint info item in array 562 + * @nci: number of checkpoint info items to retrieve 563 + * 564 + * nilfs_cpfile_get_cpinfo() searches for checkpoints in @mode state 565 + * starting from the checkpoint number stored in @cnop, and stores 566 + * information about found checkpoints in @buf. 567 + * The buffer pointed to by @buf must be large enough to store information 568 + * for @nci checkpoints. If at least one checkpoint information is 569 + * successfully retrieved, @cnop is updated to point to the checkpoint 570 + * number to continue searching. 571 + * 572 + * Return: Count of checkpoint info items stored in the output buffer on 573 + * success, or the following negative error code on failure. 574 + * * %-EINVAL - Invalid checkpoint mode. 575 + * * %-ENOMEM - Insufficient memory available. 576 + * * %-EIO - I/O error (including metadata corruption). 577 + * * %-ENOENT - Invalid checkpoint number specified. 560 578 */ 561 579 562 580 ssize_t nilfs_cpfile_get_cpinfo(struct inode *cpfile, __u64 *cnop, int mode,