fscache: fix misdocumented parameter
authorKhalid Masum <khalid.masum.92@gmail.com>
Thu, 18 Aug 2022 04:07:38 +0000 (10:07 +0600)
committerDavid Howells <dhowells@redhat.com>
Wed, 31 Aug 2022 13:57:28 +0000 (14:57 +0100)
commitec1bd37123c607ca6485beb4542a792a4db765aa
tree25d4af1f66522ede21c601aa7862270f8d8676e9
parentb90cb1053190353cc30f0fef0ef1f378ccc063c5
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/
Link: https://lore.kernel.org/r/20220818040738.12036-1-khalid.masum.92@gmail.com/
Link: https://lore.kernel.org/r/880d7d25753fb326ee17ac08005952112fcf9bdb.1657360984.git.mchehab@kernel.org/
include/linux/fscache.h