Skip to content

Commit c298638

Browse files
Andreas Gruenbacherbrauner
authored andcommitted
vfs: inode insertion kdoc corrections
Some minor corrections to the inode_insert5 and iget5_locked kernel documentation. Signed-off-by: Andreas Gruenbacher <agruenba@redhat.com> Link: https://lore.kernel.org/r/20241004115151.44834-1-agruenba@redhat.com Reviewed-by: Jan Kara <jack@suse.cz> Signed-off-by: Christian Brauner <brauner@kernel.org>
1 parent 0cb9c99 commit c298638

1 file changed

Lines changed: 12 additions & 13 deletions

File tree

fs/inode.c

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1239,16 +1239,15 @@ EXPORT_SYMBOL(unlock_two_nondirectories);
12391239
* @data: opaque data pointer to pass to @test and @set
12401240
*
12411241
* Search for the inode specified by @hashval and @data in the inode cache,
1242-
* and if present it is return it with an increased reference count. This is
1243-
* a variant of iget5_locked() for callers that don't want to fail on memory
1244-
* allocation of inode.
1242+
* and if present return it with an increased reference count. This is a
1243+
* variant of iget5_locked() that doesn't allocate an inode.
12451244
*
1246-
* If the inode is not in cache, insert the pre-allocated inode to cache and
1245+
* If the inode is not present in the cache, insert the pre-allocated inode and
12471246
* return it locked, hashed, and with the I_NEW flag set. The file system gets
12481247
* to fill it in before unlocking it via unlock_new_inode().
12491248
*
1250-
* Note both @test and @set are called with the inode_hash_lock held, so can't
1251-
* sleep.
1249+
* Note that both @test and @set are called with the inode_hash_lock held, so
1250+
* they can't sleep.
12521251
*/
12531252
struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
12541253
int (*test)(struct inode *, void *),
@@ -1312,16 +1311,16 @@ EXPORT_SYMBOL(inode_insert5);
13121311
* @data: opaque data pointer to pass to @test and @set
13131312
*
13141313
* Search for the inode specified by @hashval and @data in the inode cache,
1315-
* and if present it is return it with an increased reference count. This is
1316-
* a generalized version of iget_locked() for file systems where the inode
1314+
* and if present return it with an increased reference count. This is a
1315+
* generalized version of iget_locked() for file systems where the inode
13171316
* number is not sufficient for unique identification of an inode.
13181317
*
1319-
* If the inode is not in cache, allocate a new inode and return it locked,
1320-
* hashed, and with the I_NEW flag set. The file system gets to fill it in
1321-
* before unlocking it via unlock_new_inode().
1318+
* If the inode is not present in the cache, allocate and insert a new inode
1319+
* and return it locked, hashed, and with the I_NEW flag set. The file system
1320+
* gets to fill it in before unlocking it via unlock_new_inode().
13221321
*
1323-
* Note both @test and @set are called with the inode_hash_lock held, so can't
1324-
* sleep.
1322+
* Note that both @test and @set are called with the inode_hash_lock held, so
1323+
* they can't sleep.
13251324
*/
13261325
struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
13271326
int (*test)(struct inode *, void *),

0 commit comments

Comments
 (0)