From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>, corbet@lwn.net
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
Andrew Morton <akpm@linux-foundation.org>,
Ilya Dryomov <idryomov@gmail.com>,
Luis Chamberlain <mcgrof@kernel.org>,
Sebastian Andrzej Siewior <bigeasy@linutronix.de>,
Xiubo Li <xiubli@redhat.com>,
linux-kernel@vger.kernel.org
Subject: [PATCH 13/13] fs/dcache: fix a kernel-doc markup
Date: Thu, 18 Aug 2022 15:38:59 +0200 [thread overview]
Message-ID: <9d2676a83ebee327b97b82f3c2ab76a2e53756d1.1660829433.git.mchehab@kernel.org> (raw)
In-Reply-To: <cover.1660829433.git.mchehab@kernel.org>
There's no such thing of using the same kernel-doc markup for multiple
functions. Trying to be creative using a single one with a comma meant
for it to serve two functions will do the wrong thing and produce a
warning:
./include/linux/dcache.h:310: warning: expecting prototype for dget, dget_dlock(). Prototype was for dget_dlock() instead
Address it by duplicating the comment.
Yet, it probably makes sense to explain when/why someone has to use
each variant of it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---
See [PATCH 00/13] at: https://lore.kernel.org/all/cover.1660829433.git.mchehab@kernel.org/
include/linux/dcache.h | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/include/linux/dcache.h b/include/linux/dcache.h
index 92c78ed02b54..5f254284bb83 100644
--- a/include/linux/dcache.h
+++ b/include/linux/dcache.h
@@ -299,7 +299,7 @@ extern char *dentry_path(const struct dentry *, char *, int);
/* Allocation counts.. */
/**
- * dget, dget_dlock - get a reference to a dentry
+ * 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
@@ -313,6 +313,14 @@ 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.
+ */
static inline struct dentry *dget(struct dentry *dentry)
{
if (dentry)
--
2.37.1
prev parent reply other threads:[~2022-08-18 13:40 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-18 13:38 [PATCH 00/13] Fix documentation build warnings against 6.0-rc1 Mauro Carvalho Chehab
2022-08-18 13:38 ` [PATCH 01/13] scripts: kernel-doc: add support for EXPORT_SYMBOL variants Mauro Carvalho Chehab
2022-08-18 13:38 ` [PATCH 02/13] docs: update vmemmap_dedup.rst reference Mauro Carvalho Chehab
2022-08-18 14:58 ` Wu XiangCheng
2022-08-19 2:49 ` Muchun Song
2022-08-18 13:38 ` [PATCH 03/13] docs: ja_JP: remove SubmittingPatches Mauro Carvalho Chehab
2022-08-18 14:27 ` Akira Yokosawa
2022-08-18 14:49 ` Akira Yokosawa
2022-08-18 13:38 ` [PATCH 04/13] docs: zh_CN: remove references to rust documentation Mauro Carvalho Chehab
2022-08-20 2:20 ` YanTeng Si
2022-08-18 13:38 ` [PATCH 05/13] dt-bindings: arm: update arm,coresight-cpu-debug.yaml reference Mauro Carvalho Chehab
2022-09-12 8:39 ` Suzuki K Poulose
2022-08-18 13:38 ` [PATCH 06/13] Documentation: coresight: fix a documentation build warning Mauro Carvalho Chehab
2022-08-19 3:35 ` Bagas Sanjaya
2022-09-12 9:39 ` Suzuki K Poulose
2022-08-18 13:38 ` [PATCH 07/13] MAINTAINERS: fix wildcard for mfd da90* files Mauro Carvalho Chehab
2022-08-18 13:38 ` [PATCH 08/13] MAINTAINERS: fix a typo for hpe,gxp-spifi.yaml Mauro Carvalho Chehab
2022-08-18 13:38 ` [PATCH 09/13] ABI: sysfs-bus-nvdimm: fix a doc build warning Mauro Carvalho Chehab
2022-08-18 13:38 ` [PATCH 10/13] docs: leds: add leds-qcom-lpg.rst to the index file Mauro Carvalho Chehab
2022-08-19 3:49 ` Bagas Sanjaya
2022-08-18 13:38 ` [PATCH 11/13] fscache: fix kernel-doc markup on two functions Mauro Carvalho Chehab
2022-08-18 13:38 ` [PATCH 12/13] serial: document start_rx member at struct uart_ops Mauro Carvalho Chehab
2022-08-19 5:20 ` Jiri Slaby
2022-08-18 13:38 ` Mauro Carvalho Chehab [this message]
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=9d2676a83ebee327b97b82f3c2ab76a2e53756d1.1660829433.git.mchehab@kernel.org \
--to=mchehab@kernel.org \
--cc=akpm@linux-foundation.org \
--cc=bigeasy@linutronix.de \
--cc=corbet@lwn.net \
--cc=idryomov@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mcgrof@kernel.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 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®