nilfs2-correct-return-value-kernel-doc-descriptions-for-bmap-functions.patch removed from -mm tree
The quilt patch titled
Subject: nilfs2: correct return value kernel-doc descriptions for bmap functions
has been removed from the -mm tree. Its filename was
nilfs2-correct-return-value-kernel-doc-descriptions-for-bmap-functions.patch
This patch was dropped because it was merged into the mm-nonmm-stable branch of git://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm
------------------------------------------------------
From: Ryusuke Konishi <[email protected]>
Subject: nilfs2: correct return value kernel-doc descriptions for bmap functions
Date: Fri, 10 Jan 2025 10:01:45 +0900
Similar to the previous patch to fix the ioctl return value descriptions, this fixes the format of the return value descriptions for bmap (and btree)-related functions, which was causing the kernel-doc script to emit a number of warnings.
---
fs/nilfs2/bmap.c | 122 ++++++++++++++++++-------------------------- fs/nilfs2/btree.c | 7 +- 2 files changed, 55 insertions(+), 74 deletions(-)
fs/nilfs2/bmap.c renamed from fs/nilfs2/bmap.c~nilfs2-correct-return-value-kernel-doc-descriptions-for-bmap-functions +52 -70
@@ -47,17 +47,14 @@ static int nilfs_bmap_convert_error(stru* @ptrp: place to store the value associated to @key * * Description: nilfs_bmap_lookup_at_level() finds a record whose key -* matches @key in the block at @level of the bmap. +* matches @key in the block at @level of the bmap. The record associated +* with @key is stored in the place pointed to by @ptrp. * -* Return Value: On success, 0 is returned and the record associated with @key -* is stored in the place pointed by @ptrp. On error, one of the following -* negative error codes is returned. -* -* %-EIO - I/O error. -* -* %-ENOMEM - Insufficient amount of memory available. -* -* %-ENOENT - A record associated with @key 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 - A record associated with @key does not exist. +* * %-ENOMEM - Insufficient memory available. */ int nilfs_bmap_lookup_at_level (struct nilfs_bmap *bmap,__u64 key,int level,__u64 *ptrp)
@@ -138,14 +135,11 @@ static int nilfs_bmap_do_insert(struct n* Description: nilfs_bmap_insert() inserts the new key-record pair specified * by @key and @rec into @bmap. * -* 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. -* -* %-EEXIST - A record associated with @key already exist. +* Return: 0 on success, or one of the following negative error codes on +* failure: +* * %-EEXIST - A record associated with @key already exists. +* * %-EIO - I/O error (including metadata corruption). +* * %-ENOMEM - Insufficient memory available. */ int nilfs_bmap_insert (struct nilfs_bmap *bmap,__u64 key,unsigned long rec) {
@@ -193,14 +187,11 @@ static int nilfs_bmap_do_delete(struct n* Description: nilfs_bmap_seek_key() seeks a valid key on @bmap * starting from @start, and stores it to @keyp if found. * -* 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. -* -* %-ENOENT - No valid entry was found +* Return: 0 on success, or one of the following negative error codes on +* failure: +* * %-EIO - I/O error (including metadata corruption). +* * %-ENOENT - No valid entry was found. +* * %-ENOMEM - Insufficient memory available. */ int nilfs_bmap_seek_key (struct nilfs_bmap *bmap,__u64 start,__u64 *keyp) {
@@ -236,14 +227,11 @@ int nilfs_bmap_last_key(struct nilfs_bma* Description: nilfs_bmap_delete() deletes the key-record pair specified by * @key from @bmap. * -* 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. -* -* %-ENOENT - A record associated with @key 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 - A record associated with @key does not exist. +* * %-ENOMEM - Insufficient memory available. */ int nilfs_bmap_delete (struct nilfs_bmap *bmap,__u64 key) {
@@ -290,12 +278,10 @@ static int nilfs_bmap_do_truncate(struct* Description: nilfs_bmap_truncate() removes key-record pairs whose keys are * greater than or equal to @key from @bmap. * -* 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. +* 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_bmap_truncate (struct nilfs_bmap *bmap,__u64 key) {
@@ -330,12 +316,10 @@ void nilfs_bmap_clear(struct nilfs_bmap* Description: nilfs_bmap_propagate() marks the buffers that directly or * indirectly refer to the block specified by @bh dirty. * -* 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. +* 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_bmap_propagate (struct nilfs_bmap *bmap,struct buffer_head *bh) {
@@ -362,22 +346,22 @@ void nilfs_bmap_lookup_dirty_buffers(str/** * nilfs_bmap_assign - assign a new block number to a block -* @bmap: bmap -* @bh: pointer to buffer head +* @bmap: bmap +* @bh: place to store a pointer to the buffer head to which a block +* address is assigned (in/out) * @blocknr: block number -* @binfo: block information +* @binfo: block information * * Description: nilfs_bmap_assign() assigns the block number @blocknr to the -* buffer specified by @bh. -* -* Return Value: On success, 0 is returned and the buffer head of a newly -* create buffer and the block information associated with the buffer are -* stored in the place pointed by @bh and @binfo, respectively. On error, one -* of the following negative error codes is returned. -* -* %-EIO - I/O error. -* -* %-ENOMEM - Insufficient amount of memory available. +* buffer specified by @bh. The block information is stored in the memory +* pointed to by @binfo, and the buffer head may be replaced as a block +* address is assigned, in which case a pointer to the new buffer head is +* stored in the memory pointed to by @bh. +* +* 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_bmap_assign(struct nilfs_bmap *bmap, struct buffer_head **bh,
@@ -402,12 +386,10 @@ int nilfs_bmap_assign(struct nilfs_bmap* Description: nilfs_bmap_mark() marks the block specified by @key and @level * as dirty. * -* 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. +* 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_bmap_mark (struct nilfs_bmap *bmap,__u64 key,int level) {
@@ -430,7 +412,7 @@ int nilfs_bmap_mark(struct nilfs_bmap *b* Description: nilfs_test_and_clear() is the atomic operation to test and * clear the dirty state of @bmap. * -* Return Value: 1 is returned if @bmap is dirty, or 0 if clear. +* Return: 1 if @bmap is dirty, or 0 if clear. */ int nilfs_bmap_test_and_clear_dirty (struct nilfs_bmap *bmap) {
@@ -490,10 +472,10 @@ static struct lock_class_key nilfs_bmap_* * Description: nilfs_bmap_read() initializes the bmap @bmap. * -* Return Value: On success, 0 is returned. On error, the following negative -* error code is returned. -* -* %-ENOMEM - Insufficient amount of memory available. +* Return: 0 on success, or one of the following negative error codes on +* failure: +* * %-EIO - I/O error (corrupted bmap). +* * %-ENOMEM - Insufficient memory available. */ int nilfs_bmap_read (struct nilfs_bmap *bmap,struct nilfs_inode *raw_inode) {
fs/nilfs2/btree.c renamed from fs/nilfs2/btree.c~nilfs2-correct-return-value-kernel-doc-descriptions-for-bmap-functions +3 -4
@@ -334,7 +334,7 @@ static int nilfs_btree_node_lookup(const* @inode: host inode of btree * @blocknr: block number * -* Return Value: If node is broken, 1 is returned. Otherwise, 0 is returned. +* Return: 0 if normal, 1 if the node is broken. */ static int nilfs_btree_node_broken(const struct nilfs_btree_node *node, size_t size, struct inode *inode,
@@ -366,7 +366,7 @@ static int nilfs_btree_node_broken(const* @node: btree root node to be examined * @inode: host inode of btree * -* Return Value: If node is broken, 1 is returned. Otherwise, 0 is returned. +* Return: 0 if normal, 1 if the root node is broken. */ static int nilfs_btree_root_broken (const struct nilfs_btree_node *node,struct inode *inode)
@@ -652,8 +652,7 @@ static int nilfs_btree_do_lookup_last(co* @minlevel: start level * @nextkey: place to store the next valid key * -* Return Value: If a next key was found, 0 is returned. Otherwise, -* -ENOENT is returned. +* Return: 0 if the next key was found, %-ENOENT if not found. */ static int nilfs_btree_get_next_key(const struct nilfs_bmap *btree, const struct nilfs_btree_path *path,
_
Patches currently in -mm which might be from [email protected] are