Skip to content

Commit 3901539

Browse files
bulwahnChristian Brauner
authored andcommitted
fs: turn some comments into kernel-doc
While reviewing ./include/linux/fs.h, I noticed that three comments can actually be turned into kernel-doc comments. This allows to check the consistency between the descriptions and the functions' signatures in case they may change in the future. A quick validation with the consistency check: ./scripts/kernel-doc -none include/linux/fs.h currently reports no issues in this file. Link: https://lore.kernel.org/r/20210204180059.28360-2-lukas.bulwahn@gmail.com Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Acked-by: Christian Brauner <christian.brauner@ubuntu.com> Signed-off-by: Christian Brauner <christian.brauner@ubuntu.com>
1 parent 6961fed commit 3901539

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

include/linux/fs.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1739,7 +1739,7 @@ static inline void sb_start_pagefault(struct super_block *sb)
17391739
__sb_start_write(sb, SB_FREEZE_PAGEFAULT);
17401740
}
17411741

1742-
/*
1742+
/**
17431743
* sb_start_intwrite - get write access to a superblock for internal fs purposes
17441744
* @sb: the super we write to
17451745
*
@@ -3161,7 +3161,7 @@ static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
31613161

31623162
void inode_dio_wait(struct inode *inode);
31633163

3164-
/*
3164+
/**
31653165
* inode_dio_begin - signal start of a direct I/O requests
31663166
* @inode: inode the direct I/O happens on
31673167
*
@@ -3173,7 +3173,7 @@ static inline void inode_dio_begin(struct inode *inode)
31733173
atomic_inc(&inode->i_dio_count);
31743174
}
31753175

3176-
/*
3176+
/**
31773177
* inode_dio_end - signal finish of a direct I/O requests
31783178
* @inode: inode the direct I/O happens on
31793179
*

0 commit comments

Comments
 (0)