All of lore.kernel.org
 help / color / mirror / Atom feed
From: Khalid Masum <khalid.masum.92@gmail.com>
To: linux-kernel-mentees@lists.linuxfoundation.org
Cc: Shuah Khan <skhan@linuxfoundation.org>,
	David Howells <dhowells@redhat.com>,
	linux-cachefs@redhat.com, linux-kernel@vger.kernel.org,
	Khalid Masum <khalid.masum.92@gmail.com>
Subject: [PATCH] fscache: fix misdocumented parameter name
Date: Sat, 21 May 2022 20:24:46 +0600	[thread overview]
Message-ID: <20220521142446.4746-1-khalid.masum.92@gmail.com> (raw)

To fix warning generated by make docs in the file fscache.h:
The functions fscache_use_cookie and fscache_unuse_cookie have a
parameter named cookie. But they are documented with the name "object".
Which generates warning when creating docs. This commit will replace
the documentation with a better one named "cookie". This new
documentation
line is taken from the function fscache_update_cookie in the same
file.

Signed-off-by: Khalid Masum <khalid.masum.92@gmail.com>
---
 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 e25539072..32cf593b8 100644
--- a/include/linux/fscache.h
+++ b/include/linux/fscache.h
@@ -256,7 +256,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
@@ -272,7 +272,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)
  *
-- 
2.25.1


WARNING: multiple messages have this Message-ID (diff)
From: Khalid Masum <khalid.masum.92@gmail.com>
To: linux-kernel-mentees@lists.linuxfoundation.org
Cc: David Howells <dhowells@redhat.com>,
	linux-cachefs@redhat.com, linux-kernel@vger.kernel.org
Subject: [PATCH] fscache: fix misdocumented parameter name
Date: Sat, 21 May 2022 20:24:46 +0600	[thread overview]
Message-ID: <20220521142446.4746-1-khalid.masum.92@gmail.com> (raw)

To fix warning generated by make docs in the file fscache.h:
The functions fscache_use_cookie and fscache_unuse_cookie have a
parameter named cookie. But they are documented with the name "object".
Which generates warning when creating docs. This commit will replace
the documentation with a better one named "cookie". This new
documentation
line is taken from the function fscache_update_cookie in the same
file.

Signed-off-by: Khalid Masum <khalid.masum.92@gmail.com>
---
 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 e25539072..32cf593b8 100644
--- a/include/linux/fscache.h
+++ b/include/linux/fscache.h
@@ -256,7 +256,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
@@ -272,7 +272,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)
  *
-- 
2.25.1

_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

             reply	other threads:[~2022-05-21 14:49 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-21 14:24 Khalid Masum [this message]
2022-05-21 14:24 ` [PATCH] fscache: fix misdocumented parameter name Khalid Masum
2022-05-21 15:31 ` Randy Dunlap
2022-05-21 15:31   ` Randy Dunlap

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=20220521142446.4746-1-khalid.masum.92@gmail.com \
    --to=khalid.masum.92@gmail.com \
    --cc=dhowells@redhat.com \
    --cc=linux-cachefs@redhat.com \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=skhan@linuxfoundation.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.