From: Anup K Parikh <parikhanupk.foss@gmail.com>
To: bigeasy@linutronix.de, mcgrof@kernel.org, xiubli@redhat.com,
akpm@linux-foundation.org, jlayton@kernel.org,
skhan@linuxfoundation.org
Cc: linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org
Subject: [PATCH] Doc fix for dget_dlock and dget
Date: Sat, 13 Aug 2022 13:50:48 +0530 [thread overview]
Message-ID: <Yvde4NryqBnZesTI@autolfshost> (raw)
dcache header:
1. Remove a warning for dget_dlock
2. Add a similar comment for dget and
mention the difference between dget and dget_dlock
as suggested by Mr. Randy Dunlap
Link: https://lore.kernel.org/all/29708eb3-ff1e-411e-cf84-7aa9af765603@infradead.org/
Signed-off-by: Anup K Parikh <parikhanupk.foss@gmail.com>
---
include/linux/dcache.h | 24 +++++++++++++++++++-----
1 file changed, 19 insertions(+), 5 deletions(-)
diff --git a/include/linux/dcache.h b/include/linux/dcache.h
index 92c78ed02..aa473b6bf 100644
--- a/include/linux/dcache.h
+++ b/include/linux/dcache.h
@@ -299,12 +299,15 @@ extern char *dentry_path(const struct dentry *, char *, int);
/* Allocation counts.. */
/**
- * dget, dget_dlock - get a reference to a dentry
- * @dentry: dentry to get a reference to
+ * dget_dlock - get a reference to a dentry
+ * @dentry: dentry to get a reference to
*
- * Given a dentry or %NULL pointer increment the reference count
- * if appropriate and return the dentry. A dentry will not be
- * destroyed when it has references.
+ * Given a dentry or %NULL pointer increment the reference count
+ * if appropriate and return the dentry. A dentry will not be
+ * destroyed when it has references.
+ *
+ * The reference count increment in this function is not atomic.
+ * Consider dget() if atomicity is required.
*/
static inline struct dentry *dget_dlock(struct dentry *dentry)
{
@@ -313,6 +316,17 @@ static inline struct dentry *dget_dlock(struct dentry *dentry)
return dentry;
}
+/**
+ * dget - get a reference to a dentry
+ * @dentry: dentry to get a reference to
+ *
+ * Given a dentry or %NULL pointer increment the reference count
+ * if appropriate and return the dentry. A dentry will not be
+ * destroyed when it has references.
+ *
+ * This function atomically increments the reference count.
+ * Consider dget_dlock() if atomicity is not required or manually managed.
+ */
static inline struct dentry *dget(struct dentry *dentry)
{
if (dentry)
--
2.35.1
next reply other threads:[~2022-08-13 8:21 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-13 8:20 Anup K Parikh [this message]
-- strict thread matches above, loose matches on Subject: below --
2022-08-12 9:47 [PATCH] Doc fix for dget_dlock and dget Anup K Parikh
2022-08-13 1:44 ` Randy Dunlap
2022-08-15 6:55 ` Anup Parikh
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=Yvde4NryqBnZesTI@autolfshost \
--to=parikhanupk.foss@gmail.com \
--cc=akpm@linux-foundation.org \
--cc=bigeasy@linutronix.de \
--cc=jlayton@kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mcgrof@kernel.org \
--cc=skhan@linuxfoundation.org \
--cc=xiubli@redhat.com \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.