Commit ec1bd371 authored Aug 18, 2022 by Khalid Masum Committed by David Howells Aug 31, 2022

fscache: fix misdocumented parameter

This patch fixes two warnings generated by make docs. The functions
fscache_use_cookie and fscache_unuse_cookie, both have a parameter
named cookie. But they are documented with the name "object" with
unclear description. Which generates the warning when creating docs.

This commit will replace the currently misdocumented parameter names
with the correct ones while adding proper descriptions.

CC: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Khalid Masum <khalid.masum.92@gmail.com>
Signed-off-by: David Howells <dhowells@redhat.com>
Link: https://lore.kernel.org/r/20220521142446.4746-1-khalid.masum.92@gmail.com/ # v1
Link: https://lore.kernel.org/r/20220818040738.12036-1-khalid.masum.92@gmail.com/ # v2
Link: https://lore.kernel.org/r/880d7d25753fb326ee17ac08005952112fcf9bdb.1657360984.git.mchehab@kernel.org/ # Mauro's version

parent b90cb105

include/linux/fscache.h

+2 −2

Original line number	Diff line number	Diff line
		@@ -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 representing the cache object
		* @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 representing the cache object
		* @aux_data: Updated auxiliary data (or NULL)
		* @object_size: Revised size of the object (or NULL)
		*