Commit 2e62857f authored by Ryusuke Konishi's avatar Ryusuke Konishi Committed by Andrew Morton
Browse files

nilfs2: revise the return value description style for consistency. 

Also for comments that do not cause kernel-doc warnings (those that list
multiple error codes), revise the return value description style to match
Brian G.'s suggestion of "..., or one of the following negative error
codes on failure:".

Link: https://lkml.kernel.org/r/CAAq45aNh1qV8P6XgDhKeNstT=PvcPUaCXsAF-f9rvmzznsZL5A@mail.gmail.com
Link: https://lkml.kernel.org/r/20250110010530.21872-8-konishi.ryusuke@gmail.com


Signed-off-by: default avatarRyusuke Konishi <konishi.ryusuke@gmail.com>
Cc: "Brian G ." <gissf1@gmail.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent fd4e7fad

fs/nilfs2/btnode.c

+2 −1
Original line number Diff line number Diff line
@@ -201,7 +201,8 @@ void nilfs_btnode_delete(struct buffer_head *bh) 
 * Note that the current implementation does not support folio sizes larger

 * than the page size.

 *

 * Return: 0 on success, or the following negative error code on failure.

 * Return: 0 on success, or one of the following negative error codes on

 * failure:

 * * %-EIO	- I/O error (metadata corruption).

 * * %-ENOMEM	- Insufficient memory available.

 */

fs/nilfs2/cpfile.c

+10 −6
Original line number Diff line number Diff line
@@ -236,7 +236,8 @@ static inline int nilfs_cpfile_delete_checkpoint_block(struct inode *cpfile, 
 * stores it to the inode file given by @ifile and the nilfs root object

 * given by @root.

 *

 * Return: 0 on success, or the following negative error code on failure.

 * Return: 0 on success, or one of the following negative error codes on

 * failure:

 * * %-EINVAL	- Invalid checkpoint.

 * * %-ENOMEM	- Insufficient memory available.

 * * %-EIO	- I/O error (including metadata corruption).
@@ -304,7 +305,8 @@ int nilfs_cpfile_read_checkpoint(struct inode *cpfile, __u64 cno, 
 * In either case, the buffer of the block containing the checkpoint entry

 * and the cpfile inode are made dirty for inclusion in the write log.

 *

 * Return: 0 on success, or the following negative error code on failure.

 * Return: 0 on success, or one of the following negative error codes on

 * failure:

 * * %-ENOMEM	- Insufficient memory available.

 * * %-EIO	- I/O error (including metadata corruption).

 * * %-EROFS	- Read only filesystem
@@ -373,7 +375,8 @@ int nilfs_cpfile_create_checkpoint(struct inode *cpfile, __u64 cno) 
 * cpfile with the data given by the arguments @root, @blkinc, @ctime, and

 * @minor.

 *

 * Return: 0 on success, or the following negative error code on failure.

 * Return: 0 on success, or one of the following negative error codes on

 * failure:

 * * %-ENOMEM	- Insufficient memory available.

 * * %-EIO	- I/O error (including metadata corruption).

 */
@@ -712,7 +715,7 @@ static ssize_t nilfs_cpfile_do_get_ssinfo(struct inode *cpfile, __u64 *cnop, 
 * 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.

 * success, or one of the following negative error codes on failure:

 * * %-EINVAL	- Invalid checkpoint mode.

 * * %-ENOMEM	- Insufficient memory available.

 * * %-EIO	- I/O error (including metadata corruption).
@@ -737,7 +740,8 @@ ssize_t nilfs_cpfile_get_cpinfo(struct inode *cpfile, __u64 *cnop, int mode, 
 * @cpfile: checkpoint file inode

 * @cno:    checkpoint number to delete

 *

 * Return: 0 on success, or the following negative error code on failure.

 * Return: 0 on success, or one of the following negative error codes on

 * failure:

 * * %-EBUSY	- Checkpoint in use (snapshot specified).

 * * %-EIO	- I/O error (including metadata corruption).

 * * %-ENOENT	- No valid checkpoint found.
@@ -1005,7 +1009,7 @@ static int nilfs_cpfile_clear_snapshot(struct inode *cpfile, __u64 cno) 
 * @cno:    checkpoint number

 *

 * Return: 1 if the checkpoint specified by @cno is a snapshot, 0 if not, or

 * the following negative error code on failure.

 * one of the following negative error codes on failure:

 * * %-EIO	- I/O error (including metadata corruption).

 * * %-ENOENT	- No such checkpoint.

 * * %-ENOMEM	- Insufficient memory available.

fs/nilfs2/dat.c

+2 −1
Original line number Diff line number Diff line
@@ -276,7 +276,8 @@ void nilfs_dat_abort_update(struct inode *dat, 
 * @dat:      DAT file inode

 * @vblocknr: virtual block number

 *

 * Return: 0 on success, or the following negative error code on failure.

 * Return: 0 on success, or one of the following negative error codes on

 * failure:

 * * %-EINVAL	- Invalid DAT entry (internal code).

 * * %-EIO	- I/O error (including metadata corruption).

 * * %-ENOMEM	- Insufficient memory available.

fs/nilfs2/ifile.c

+2 −1
Original line number Diff line number Diff line
@@ -172,7 +172,8 @@ int nilfs_ifile_count_free_inodes(struct inode *ifile, 
 * @cno: number of checkpoint entry to read

 * @inode_size: size of an inode

 *

 * Return: 0 on success, or the following negative error code on failure.

 * Return: 0 on success, or one of the following negative error codes on

 * failure:

 * * %-EINVAL	- Invalid checkpoint.

 * * %-ENOMEM	- Insufficient memory available.

 * * %-EIO	- I/O error (including metadata corruption).

fs/nilfs2/ioctl.c

+2 −1
Original line number Diff line number Diff line
@@ -1268,7 +1268,8 @@ static int nilfs_ioctl_get_fslabel(struct super_block *sb, void __user *argp) 
 * @filp: file object

 * @argp: pointer to userspace memory that contains the volume name

 *

 * Return: 0 on success, or the following negative error code on failure.

 * Return: 0 on success, or one of the following negative error codes on

 * failure:

 * * %-EFAULT	- Error copying input data.

 * * %-EINVAL	- Label length exceeds record size in superblock.

 * * %-EIO	- I/O error.