All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
	David Howells <dhowells@redhat.com>,
	linux-cachefs@redhat.com, linux-kernel@vger.kernel.org
Subject: [PATCH v3 07/21] fscache: fix kernel-doc documentation
Date: Sat,  9 Jul 2022 11:07:20 +0100	[thread overview]
Message-ID: <880d7d25753fb326ee17ac08005952112fcf9bdb.1657360984.git.mchehab@kernel.org> (raw)
In-Reply-To: <cover.1657360984.git.mchehab@kernel.org>

The prototype of two functions use "cookie" for the object
parameter.

Update kernel-doc tags accordingly, fixing those 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>
---

To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH v3 00/21] at: https://lore.kernel.org/all/cover.1657360984.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 2f82ea31d4c1..e13184c4b198 100644
--- a/include/linux/fscache.h
+++ b/include/linux/fscache.h
@@ -257,7 +257,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: Object description
  * @will_modify: If cache is expected to be modified locally
  *
  * Request usage of the cookie attached to an object.  The caller should tell
@@ -273,7 +273,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: Object description
  * @aux_data: Updated auxiliary data (or NULL)
  * @object_size: Revised size of the object (or NULL)
  *
-- 
2.36.1


  parent reply	other threads:[~2022-07-09 10:07 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-09 10:07 [PATCH v3 00/21] Update Documentation/ cross references and fix issues Mauro Carvalho Chehab
2022-07-09 10:07 ` Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 01/21] docs: networking: update netdevices.rst reference Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 02/21] docs: update vmalloced-kernel-stacks.rst reference Mauro Carvalho Chehab
2022-07-09 13:37   ` Wu XiangCheng
2022-07-11  2:32   ` YanTeng Si
2022-07-09 10:07 ` [PATCH v3 03/21] docs: update vmemmap_dedup.rst reference Mauro Carvalho Chehab
2022-07-11  6:05   ` Muchun Song
2022-07-09 10:07 ` [PATCH v3 04/21] docs: zh_CN: page_migration: fix reference to mm index.rst Mauro Carvalho Chehab
2022-07-09 10:41   ` Wu XiangCheng
2022-07-11  2:28   ` YanTeng Si
2022-07-09 10:07 ` [PATCH v3 05/21] dt-bindings: arm: update arm,coresight-cpu-debug.yaml reference Mauro Carvalho Chehab
2022-07-09 10:07   ` Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 06/21] x86/sgx: fix kernel-doc markups Mauro Carvalho Chehab
2022-07-09 10:07 ` Mauro Carvalho Chehab [this message]
2022-07-09 10:07 ` [PATCH v3 08/21] fs: namei: address some kernel-doc issues Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 09/21] drm/scheduler: fix a kernel-doc warning Mauro Carvalho Chehab
2022-07-09 10:07   ` Mauro Carvalho Chehab
2022-08-11 16:32   ` Alex Deucher
2022-08-11 16:32     ` Alex Deucher
2022-07-09 10:07 ` [PATCH v3 10/21] drm/scheduler: add a missing kernel-doc parameter Mauro Carvalho Chehab
2022-07-09 10:07   ` Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 11/21] kfence: fix a " Mauro Carvalho Chehab
2022-07-09 10:07   ` Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 12/21] genalloc: add a description for start_addr parameter Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 13/21] textsearch: document list inside struct ts_ops Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 14/21] dcache: fix a kernel-doc warning Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 15/21] docs: ext4: blockmap.rst: fix a broken table Mauro Carvalho Chehab
2022-07-09 15:37   ` Theodore Ts'o
2022-07-09 10:07 ` [PATCH v3 16/21] docs: PCI: pci-vntb-function.rst: Properly include ascii artwork Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 17/21] docs: PCI: pci-vntb-howto.rst: fix a title markup Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 18/21] docs: virt: kvm: fix a title markup at api.rst Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 19/21] docs: ABI: sysfs-bus-nvdimm Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 20/21] docs: leds: index.rst: add leds-qcom-lpg to it Mauro Carvalho Chehab
2022-07-09 10:07 ` [PATCH v3 21/21] Documentation: coresight: fix binding wildcards Mauro Carvalho Chehab
2022-07-09 10:07   ` 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=880d7d25753fb326ee17ac08005952112fcf9bdb.1657360984.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 \
    --cc=mchehab+huawei@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 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.