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

nilfs2: correct return value kernel-doc descriptions for the rest 

Similar to the previous changes to fix return value descriptions, this
fixes the format of the return value descriptions of functions for the
rest.

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

fs/nilfs2/gcinode.c

+10 −14
Original line number Diff line number Diff line
@@ -46,14 +46,11 @@ 
 * specified by @pbn to the GC pagecache with the key @blkoff.

 * This function sets @vbn (@pbn if @vbn is zero) in b_blocknr of the buffer.

 *

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

 * negative error code is returned.

 *

 * %-EIO - I/O error.

 *

 * %-ENOMEM - Insufficient amount of memory available.

 *

 * %-ENOENT - The block specified with @pbn does not exist.

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

 * failure:

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

 * * %-ENOENT	- The block specified with @pbn does not exist.

 * * %-ENOMEM	- Insufficient memory available.

 */

int nilfs_gccache_submit_read_data(struct inode *inode, sector_t blkoff,

				   sector_t pbn, __u64 vbn,
@@ -114,12 +111,11 @@ int nilfs_gccache_submit_read_data(struct inode *inode, sector_t blkoff, 
 * specified by @vbn to the GC pagecache.  @pbn can be supplied by the

 * caller to avoid translation of the disk block address.

 *

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

 * negative error code is returned.

 *

 * %-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).

 * * %-ENOENT	- Invalid virtual block address.

 * * %-ENOMEM	- Insufficient memory available.

 */

int nilfs_gccache_submit_read_node(struct inode *inode, sector_t pbn,

				   __u64 vbn, struct buffer_head **out_bh)

fs/nilfs2/inode.c

+3 −9
Original line number Diff line number Diff line
@@ -598,10 +598,7 @@ struct inode *nilfs_iget_for_gc(struct super_block *sb, unsigned long ino, 
 * or does nothing if the inode already has it.  This function allocates

 * an additional inode to maintain page cache of B-tree nodes one-on-one.

 *

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

 * negative error code is returned.

 *

 * %-ENOMEM - Insufficient memory available.

 * Return: 0 on success, or %-ENOMEM if memory is insufficient.

 */

int nilfs_attach_btree_node_cache(struct inode *inode)

{
@@ -660,11 +657,8 @@ void nilfs_detach_btree_node_cache(struct inode *inode) 
 * in one inode and the one for b-tree node pages is set up in the

 * other inode, which is attached to the former inode.

 *

 * Return Value: On success, a pointer to the inode for data pages is

 * returned. On errors, one of the following negative error code is returned

 * in a pointer type.

 *

 * %-ENOMEM - Insufficient memory available.

 * Return: a pointer to the inode for data pages on success, or %-ENOMEM

 * if memory is insufficient.

 */

struct inode *nilfs_iget_for_shadow(struct inode *inode)

{

fs/nilfs2/recovery.c

+12 −20
Original line number Diff line number Diff line
@@ -754,18 +754,13 @@ static void nilfs_abort_roll_forward(struct the_nilfs *nilfs) 
 * @sb: super block instance

 * @ri: pointer to a nilfs_recovery_info struct to store search results.

 *

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

 * negative error code is returned.

 *

 * %-EINVAL - Inconsistent filesystem state.

 *

 * %-EIO - I/O error

 *

 * %-ENOSPC - No space left on device (only in a panic state).

 *

 * %-ERESTARTSYS - Interrupted.

 *

 * %-ENOMEM - Insufficient memory available.

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

 * failure:

 * * %-EINVAL		- Inconsistent filesystem state.

 * * %-EIO		- I/O error.

 * * %-ENOMEM		- Insufficient memory available.

 * * %-ENOSPC		- No space left on device (only in a panic state).

 * * %-ERESTARTSYS	- Interrupted.

 */

int nilfs_salvage_orphan_logs(struct the_nilfs *nilfs,

			      struct super_block *sb,
@@ -830,14 +825,11 @@ int nilfs_salvage_orphan_logs(struct the_nilfs *nilfs, 
 * segment pointed by the superblock.  It sets up struct the_nilfs through

 * this search. It fills nilfs_recovery_info (ri) required for recovery.

 *

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

 * negative error code is returned.

 *

 * %-EINVAL - No valid segment found

 *

 * %-EIO - I/O error

 *

 * %-ENOMEM - Insufficient memory available.

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

 * failure:

 * * %-EINVAL	- No valid segment found.

 * * %-EIO	- I/O error.

 * * %-ENOMEM	- Insufficient memory available.

 */

int nilfs_search_super_root(struct the_nilfs *nilfs,

			    struct nilfs_recovery_info *ri)

fs/nilfs2/segbuf.c

+2 −10
Original line number Diff line number Diff line
@@ -406,12 +406,7 @@ static int nilfs_segbuf_submit_bh(struct nilfs_segment_buffer *segbuf, 
 * @segbuf: buffer storing a log to be written

 * @nilfs: nilfs object

 *

 * Return Value: On Success, 0 is returned. On Error, one of the following

 * negative error code is returned.

 *

 * %-EIO - I/O error

 *

 * %-ENOMEM - Insufficient memory available.

 * Return: Always 0.

 */

static int nilfs_segbuf_write(struct nilfs_segment_buffer *segbuf,

			      struct the_nilfs *nilfs)
@@ -452,10 +447,7 @@ static int nilfs_segbuf_write(struct nilfs_segment_buffer *segbuf, 
 * nilfs_segbuf_wait - wait for completion of requested BIOs

 * @segbuf: segment buffer

 *

 * Return Value: On Success, 0 is returned. On Error, one of the following

 * negative error code is returned.

 *

 * %-EIO - I/O error

 * Return: 0 on success, or %-EIO if I/O error is detected.

 */

static int nilfs_segbuf_wait(struct nilfs_segment_buffer *segbuf)

{

fs/nilfs2/segment.c

+18 −30
Original line number Diff line number Diff line
@@ -191,12 +191,10 @@ static int nilfs_prepare_segment_lock(struct super_block *sb, 
 * When @vacancy_check flag is set, this function will check the amount of

 * free space, and will wait for the GC to reclaim disk space if low capacity.

 *

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

 * negative error code is returned.

 *

 * %-ENOMEM - Insufficient memory available.

 *

 * %-ENOSPC - No space left on device

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

 * failure:

 * * %-ENOMEM	- Insufficient memory available.

 * * %-ENOSPC	- No space left on device (if checking free space).

 */

int nilfs_transaction_begin(struct super_block *sb,

			    struct nilfs_transaction_info *ti,
@@ -2314,18 +2312,13 @@ static void nilfs_segctor_wakeup(struct nilfs_sc_info *sci, int err, bool force) 
 * nilfs_construct_segment - construct a logical segment

 * @sb: super block

 *

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

 * negative error code is returned.

 *

 * %-EROFS - Read only filesystem.

 *

 * %-EIO - I/O error

 *

 * %-ENOSPC - No space left on device (only in a panic state).

 *

 * %-ERESTARTSYS - Interrupted.

 *

 * %-ENOMEM - Insufficient 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.

 * * %-ENOSPC		- No space left on device (only in a panic state).

 * * %-ERESTARTSYS	- Interrupted.

 * * %-EROFS		- Read only filesystem.

 */

int nilfs_construct_segment(struct super_block *sb)

{
@@ -2349,18 +2342,13 @@ int nilfs_construct_segment(struct super_block *sb) 
 * @start: start byte offset

 * @end: end byte offset (inclusive)

 *

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

 * negative error code is returned.

 *

 * %-EROFS - Read only filesystem.

 *

 * %-EIO - I/O error

 *

 * %-ENOSPC - No space left on device (only in a panic state).

 *

 * %-ERESTARTSYS - Interrupted.

 *

 * %-ENOMEM - Insufficient 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.

 * * %-ENOSPC		- No space left on device (only in a panic state).

 * * %-ERESTARTSYS	- Interrupted.

 * * %-EROFS		- Read only filesystem.

 */

int nilfs_construct_dsync_segment(struct super_block *sb, struct inode *inode,

				  loff_t start, loff_t end)