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: Ryusuke Konishi <konishi.ryusuke@gmail.com>
Cc: "Brian G ." <gissf1@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>

diff --git a/fs/nilfs2/btnode.c b/fs/nilfs2/btnode.c
index 54a3fa0cf67edbf9411a5b6b7f20c1d9ba163e05..56836712909201775907483887e8a0022851bbec 100644 (file)
--- a/fs/nilfs2/btnode.c
+++ b/fs/nilfs2/btnode.c
@@ -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.
  */

diff --git a/fs/nilfs2/cpfile.c b/fs/nilfs2/cpfile.c
index aaab0ae90261f8f91bb2a0dd55c60bde001b557d..bcc7d76269ac90f5b1618b696b8f4d00d983bfe3 100644 (file)
--- a/fs/nilfs2/cpfile.c
+++ b/fs/nilfs2/cpfile.c
@@ -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 @@ out_sem:
  * 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 @@ out_sem:
  * 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.

diff --git a/fs/nilfs2/dat.c b/fs/nilfs2/dat.c
index c5664035b3e364ff3b45f33f0c513ca98231086f..c664daba56ae6c34a1818eb48dca6a99a7c77672 100644 (file)
--- a/fs/nilfs2/dat.c
+++ b/fs/nilfs2/dat.c
@@ -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.

diff --git a/fs/nilfs2/ifile.c b/fs/nilfs2/ifile.c
index e1e050dfbbc2ab3f4220053155fda5d5727f55c8..c4cd4a4dedd0f4b7566ace814f27d6a2852350cb 100644 (file)
--- a/fs/nilfs2/ifile.c
+++ b/fs/nilfs2/ifile.c
@@ -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).

diff --git a/fs/nilfs2/ioctl.c b/fs/nilfs2/ioctl.c
index e877c97974a420de294d1a9d0ffb26b53d9a77b0..a66d62a51f77774ff5a31453a315a10ad08a418b 100644 (file)
--- a/fs/nilfs2/ioctl.c
+++ b/fs/nilfs2/ioctl.c
@@ -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.

diff --git a/fs/nilfs2/segment.c b/fs/nilfs2/segment.c
index 94f45281253c28d44108a656b3d17dad203c7f49..3a202e51b36009a330090dac3694ddd6d0aea195 100644 (file)
--- a/fs/nilfs2/segment.c
+++ b/fs/nilfs2/segment.c
@@ -1122,7 +1122,8 @@ static int nilfs_segctor_scan_file_dsync(struct nilfs_sc_info *sci,
  * a super root block containing this sufile change is complete, and it can
  * be canceled with nilfs_sufile_cancel_freev() until then.
  *
- * 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 segment number.
  * * %-EIO     - I/O error (including metadata corruption).
  * * %-ENOMEM  - Insufficient memory available.
@@ -2834,7 +2835,8 @@ static void nilfs_segctor_destroy(struct nilfs_sc_info *sci)
  * This allocates a log writer object, initializes it, and starts the
  * log writer.
  *
- * 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:
  * * %-EINTR   - Log writer thread creation failed due to interruption.
  * * %-ENOMEM  - Insufficient memory available.
  */

diff --git a/fs/nilfs2/sufile.c b/fs/nilfs2/sufile.c
index 47d01255a8fbba48c4226a171444d6a75d3e0641..330f269abedf5d913448c31c14b6412af4c7511d 100644 (file)
--- a/fs/nilfs2/sufile.c
+++ b/fs/nilfs2/sufile.c
@@ -850,7 +850,7 @@ out:
  * @nsi:    size of suinfo array
  *
  * Return: Count of segment usage 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:
  * * %-EIO     - I/O error (including metadata corruption).
  * * %-ENOMEM  - Insufficient memory available.
  */