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>,
David Howells <dhowells@redhat.com>,
linux-cachefs@redhat.com, linux-kernel@vger.kernel.org
Subject: [PATCH 11/13] fscache: fix kernel-doc markup on two functions
Date: Thu, 18 Aug 2022 15:38:57 +0200 [thread overview]
Message-ID: <dfd8112d0229154fea7d4c833d3248c3d15c6650.1660829433.git.mchehab@kernel.org> (raw)
In-Reply-To: <cover.1660829433.git.mchehab@kernel.org>
The obj parameter was replaced by a cookie. Update docs
accordingly.
It solves those doc build warnings:
./include/linux/fscache.h:270: warning: Function parameter or member 'cookie' not described in 'fscache_use_cookie'
./include/linux/fscache.h:270: warning: Excess function parameter 'object' description in 'fscache_use_cookie'
./include/linux/fscache.h:287: warning: Function parameter or member 'cookie' not described in 'fscache_unuse_cookie'
./include/linux/fscache.h:287: warning: Excess function parameter 'object' description in 'fscache_unuse_cookie'
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/fscache.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/include/linux/fscache.h b/include/linux/fscache.h
index 720874e6ee94..bc089ce2c903 100644
--- a/include/linux/fscache.h
+++ b/include/linux/fscache.h
@@ -258,7 +258,7 @@ struct fscache_cookie *fscache_acquire_cookie(struct fscache_volume *volume,
/**
* fscache_use_cookie - Request usage of cookie attached to an object
- * @object: Object description
+ * @cookie: The cookie to be attached
* @will_modify: If cache is expected to be modified locally
*
* Request usage of the cookie attached to an object. The caller should tell
@@ -274,7 +274,7 @@ static inline void fscache_use_cookie(struct fscache_cookie *cookie,
/**
* fscache_unuse_cookie - Cease usage of cookie attached to an object
- * @object: Object description
+ * @cookie: The cookie to be unused
* @aux_data: Updated auxiliary data (or NULL)
* @object_size: Revised size of the object (or NULL)
*
--
2.37.1
next 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 ` Mauro Carvalho Chehab [this message]
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 ` [PATCH 13/13] fs/dcache: fix a kernel-doc markup Mauro Carvalho Chehab
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=dfd8112d0229154fea7d4c833d3248c3d15c6650.1660829433.git.mchehab@kernel.org \
--to=mchehab@kernel.org \
--cc=corbet@lwn.net \
--cc=dhowells@redhat.com \
--cc=linux-cachefs@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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®