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

nilfs2: correct return value kernel-doc descriptions for sufile 

Similar to the previous changes to fix return value descriptions, this
fixes the format of the return value descriptions of functions for
sufile-related functions, eliminating a dozen warnings emitted by the
kernel-doc script.

Link: https://lkml.kernel.org/r/20250110010530.21872-4-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 e4a99d48

fs/nilfs2/sufile.c

+39 −63
Original line number Diff line number Diff line
@@ -155,17 +155,13 @@ unsigned long nilfs_sufile_get_ncleansegs(struct inode *sufile) 
 * of successfully modified segments from the head is stored in the

 * place @ndone points to.

 *

 * Return Value: On success, zero is returned.  On error, one of the

 * following negative error codes is returned.

 *

 * %-EIO - I/O error.

 *

 * %-ENOMEM - Insufficient amount of memory available.

 *

 * %-ENOENT - Given segment usage is in hole block (may be returned if

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

 * failure:

 * * %-EINVAL	- Invalid segment usage number

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

 * * %-ENOENT	- Given segment usage is in hole block (may be returned if

 *		  @create is zero)

 *

 * %-EINVAL - Invalid segment usage number

 * * %-ENOMEM	- Insufficient memory available.

 */

int nilfs_sufile_updatev(struct inode *sufile, __u64 *segnumv, size_t nsegs,

			 int create, size_t *ndone,
@@ -272,10 +268,7 @@ int nilfs_sufile_update(struct inode *sufile, __u64 segnum, int create, 
 * @start: minimum segment number of allocatable region (inclusive)

 * @end: maximum segment number of allocatable region (inclusive)

 *

 * Return Value: On success, 0 is returned.  On error, one of the

 * following negative error codes is returned.

 *

 * %-ERANGE - invalid segment region

 * Return: 0 on success, or %-ERANGE if segment range is invalid.

 */

int nilfs_sufile_set_alloc_range(struct inode *sufile, __u64 start, __u64 end)

{
@@ -300,17 +293,14 @@ int nilfs_sufile_set_alloc_range(struct inode *sufile, __u64 start, __u64 end) 
 * @sufile: inode of segment usage file

 * @segnump: pointer to segment number

 *

 * Description: nilfs_sufile_alloc() allocates a clean segment.

 *

 * Return Value: On success, 0 is returned and the segment number of the

 * allocated segment is stored in the place pointed by @segnump. On error, one

 * of the following negative error codes is returned.

 *

 * %-EIO - I/O error.

 * Description: nilfs_sufile_alloc() allocates a clean segment, and stores

 * its segment number in the place pointed to by @segnump.

 *

 * %-ENOMEM - Insufficient amount of memory available.

 *

 * %-ENOSPC - No clean segment left.

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

 * failure:

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

 * * %-ENOMEM	- Insufficient memory available.

 * * %-ENOSPC	- No clean segment left.

 */

int nilfs_sufile_alloc(struct inode *sufile, __u64 *segnump)

{
@@ -610,16 +600,13 @@ int nilfs_sufile_set_segment_usage(struct inode *sufile, __u64 segnum, 
 * @sufile: inode of segment usage file

 * @sustat: pointer to a structure of segment usage statistics

 *

 * Description: nilfs_sufile_get_stat() returns information about segment

 * usage.

 *

 * Return Value: On success, 0 is returned, and segment usage information is

 * stored in the place pointed by @sustat. On error, one of the following

 * negative error codes is returned.

 * Description: nilfs_sufile_get_stat() retrieves segment usage statistics

 * and stores them in the location pointed to by @sustat.

 *

 * %-EIO - I/O error.

 *

 * %-ENOMEM - Insufficient amount of memory available.

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

 * failure:

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

 * * %-ENOMEM	- Insufficient memory available.

 */

int nilfs_sufile_get_stat(struct inode *sufile, struct nilfs_sustat *sustat)

{
@@ -683,16 +670,12 @@ void nilfs_sufile_do_set_error(struct inode *sufile, __u64 segnum, 
 * @start: start segment number (inclusive)

 * @end: end segment number (inclusive)

 *

 * Return Value: On success, 0 is returned.  On error, one of the

 * following negative error codes is returned.

 *

 * %-EIO - I/O error.

 *

 * %-ENOMEM - Insufficient amount of memory available.

 *

 * %-EINVAL - Invalid number of segments specified

 *

 * %-EBUSY - Dirty or active segments are present in the range

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

 * failure:

 * * %-EBUSY	- Dirty or active segments are present in the range.

 * * %-EINVAL	- Invalid number of segments specified.

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

 * * %-ENOMEM	- Insufficient memory available.

 */

static int nilfs_sufile_truncate_range(struct inode *sufile,

				       __u64 start, __u64 end)
@@ -787,16 +770,12 @@ static int nilfs_sufile_truncate_range(struct inode *sufile, 
 * @sufile: inode of segment usage file

 * @newnsegs: new number of segments

 *

 * Return Value: On success, 0 is returned.  On error, one of the

 * following negative error codes is returned.

 *

 * %-EIO - I/O error.

 *

 * %-ENOMEM - Insufficient amount of memory available.

 *

 * %-ENOSPC - Enough free space is not left for shrinking

 *

 * %-EBUSY - Dirty or active segments exist in the region to be truncated

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

 * failure:

 * * %-EBUSY	- Dirty or active segments exist in the region to be truncated.

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

 * * %-ENOMEM	- Insufficient memory available.

 * * %-ENOSPC	- Enough free space is not left for shrinking.

 */

int nilfs_sufile_resize(struct inode *sufile, __u64 newnsegs)

{
@@ -939,14 +918,11 @@ ssize_t nilfs_sufile_get_suinfo(struct inode *sufile, __u64 segnum, void *buf, 
 * segment usage accordingly. Only the fields indicated by the sup_flags

 * are updated.

 *

 * Return Value: On success, 0 is returned. On error, one of the

 * following negative error codes is returned.

 *

 * %-EIO - I/O error.

 *

 * %-ENOMEM - Insufficient amount of memory available.

 *

 * %-EINVAL - Invalid values in input (segment number, flags or nblocks)

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

 * failure:

 * * %-EINVAL	- Invalid values in input (segment number, flags or nblocks).

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

 * * %-ENOMEM	- Insufficient memory available.

 */

ssize_t nilfs_sufile_set_suinfo(struct inode *sufile, void *buf,

				unsigned int supsz, size_t nsup)
@@ -1073,7 +1049,7 @@ ssize_t nilfs_sufile_set_suinfo(struct inode *sufile, void *buf, 
 * and start+len is rounded down. For each clean segment blkdev_issue_discard

 * function is invoked.

 *

 * Return Value: On success, 0 is returned or negative error code, otherwise.

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

 */

int nilfs_sufile_trim_fs(struct inode *sufile, struct fstrim_range *range)

{

fs/nilfs2/sufile.h

+6 −10
Original line number Diff line number Diff line
@@ -95,8 +95,7 @@ static inline int nilfs_sufile_freev(struct inode *sufile, __u64 *segnumv, 
 * @nsegs: size of @segnumv array

 * @ndone: place to store the number of cancelled segments

 *

 * Return Value: On success, 0 is returned. On error, a negative error codes

 * is returned.

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

 */

static inline int nilfs_sufile_cancel_freev(struct inode *sufile,

					    __u64 *segnumv, size_t nsegs,
@@ -114,14 +113,11 @@ static inline int nilfs_sufile_cancel_freev(struct inode *sufile, 
 * Description: nilfs_sufile_set_error() marks the segment specified by

 * @segnum as erroneous. The error segment will never be used again.

 *

 * Return Value: On success, 0 is returned. On error, one of the following

 * negative error codes is returned.

 *

 * %-EIO - I/O error.

 *

 * %-ENOMEM - Insufficient amount of memory available.

 *

 * %-EINVAL - Invalid segment usage number.

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

 * failure:

 * * %-EINVAL	- Invalid segment usage number.

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

 * * %-ENOMEM	- Insufficient memory available.

 */

static inline int nilfs_sufile_set_error(struct inode *sufile, __u64 segnum)

{