From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
To: Christian Brauner <christian.brauner@ubuntu.com>,
linux-fsdevel@vger.kernel.org
Cc: Alexander Viro <viro@zeniv.linux.org.uk>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-doc@vger.kernel.org, kernel-janitors@vger.kernel.org,
linux-kernel@vger.kernel.org,
Lukas Bulwahn <lukas.bulwahn@gmail.com>
Subject: [PATCH 1/5] fs: turn some comments into kernel-doc
Date: Thu, 4 Feb 2021 19:00:55 +0100 [thread overview]
Message-ID: <20210204180059.28360-2-lukas.bulwahn@gmail.com> (raw)
In-Reply-To: <20210204180059.28360-1-lukas.bulwahn@gmail.com>
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.
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
include/linux/fs.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/include/linux/fs.h b/include/linux/fs.h
index 3482146b11b0..04b6b142dfcf 100644
--- a/include/linux/fs.h
+++ b/include/linux/fs.h
@@ -1739,7 +1739,7 @@ static inline void sb_start_pagefault(struct super_block *sb)
__sb_start_write(sb, SB_FREEZE_PAGEFAULT);
}
-/*
+/**
* sb_start_intwrite - get write access to a superblock for internal fs purposes
* @sb: the super we write to
*
@@ -3162,7 +3162,7 @@ static inline ssize_t blockdev_direct_IO(struct kiocb *iocb,
void inode_dio_wait(struct inode *inode);
-/*
+/**
* inode_dio_begin - signal start of a direct I/O requests
* @inode: inode the direct I/O happens on
*
@@ -3174,7 +3174,7 @@ static inline void inode_dio_begin(struct inode *inode)
atomic_inc(&inode->i_dio_count);
}
-/*
+/**
* inode_dio_end - signal finish of a direct I/O requests
* @inode: inode the direct I/O happens on
*
--
2.17.1
next prev parent reply other threads:[~2021-02-04 18:11 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-04 18:00 [PATCH 0/5] kernel-doc fixes to latest fs changes Lukas Bulwahn
2021-02-04 18:00 ` Lukas Bulwahn [this message]
2021-02-04 18:00 ` [PATCH 2/5] fs: update kernel-doc for vfs_rename() Lukas Bulwahn
2021-02-04 18:00 ` [PATCH 3/5] fs: update kernel-doc for may_create_in_sticky() Lukas Bulwahn
2021-02-04 18:00 ` [PATCH 4/5] fs: update kernel-doc for vfs_tmpfile() Lukas Bulwahn
2021-02-04 18:00 ` [PATCH 5/5] fs: update kernel-doc for new mnt_userns argument Lukas Bulwahn
2021-03-01 12:51 ` [PATCH 0/5] kernel-doc fixes to latest fs changes Christian Brauner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210204180059.28360-2-lukas.bulwahn@gmail.com \
--to=lukas.bulwahn@gmail.com \
--cc=christian.brauner@ubuntu.com \
--cc=kernel-janitors@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
--cc=viro@zeniv.linux.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®