[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-Id: <dfd8112d0229154fea7d4c833d3248c3d15c6650.1660829433.git.mchehab@kernel.org>
Date: Thu, 18 Aug 2022 15:38:57 +0200
From: Mauro Carvalho Chehab <mchehab@...nel.org>
To: Linux Doc Mailing List <linux-doc@...r.kernel.org>, corbet@....net
Cc: Mauro Carvalho Chehab <mchehab@...nel.org>,
David Howells <dhowells@...hat.com>, linux-cachefs@...hat.com,
linux-kernel@...r.kernel.org
Subject: [PATCH 11/13] fscache: fix kernel-doc markup on two functions
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@...nel.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
Powered by blists - more mailing lists