From: Sukrut Heroorkar <hsukrut3@gmail.com>
To: "Philipp Reisner" <philipp.reisner@linbit.com>,
"Lars Ellenberg" <lars.ellenberg@linbit.com>,
"Christoph Böhmwalder" <christoph.boehmwalder@linbit.com>,
"Jens Axboe" <axboe@kernel.dk>,
drbd-dev@lists.linbit.com (open list:DRBD DRIVER),
linux-block@vger.kernel.org (open list:BLOCK LAYER),
linux-kernel@vger.kernel.org (open list)
Cc: Sukrut Heroorkar <hsukrut3@gmail.com>,
shuah@kernel.org, david.hunter.linux@gmail.com
Subject: [PATCH] drbd: add missing kernel-doc for peer_device parameter
Date: Mon, 17 Nov 2025 22:55:56 +0530 [thread overview]
Message-ID: <20251117172557.355797-1-hsukrut3@gmail.com> (raw)
W=1 build warns that peer_device is undocumented in the bitmap I/O
handlers. This parameter was introduced in commit 8164dd6c8ae1
("drbd: Add peer device parameter to whole-bitmap I/O handlers"), but
the kernel-doc was not updated.
Add the missing @peer_device entry.
Signed-off-by: Sukrut Heroorkar <hsukrut3@gmail.com>
---
drivers/block/drbd/drbd_bitmap.c | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/drivers/block/drbd/drbd_bitmap.c b/drivers/block/drbd/drbd_bitmap.c
index 85ca000a0564..2d26f9d2454d 100644
--- a/drivers/block/drbd/drbd_bitmap.c
+++ b/drivers/block/drbd/drbd_bitmap.c
@@ -1213,6 +1213,7 @@ static int bm_rw(struct drbd_device *device, const unsigned int flags, unsigned
/**
* drbd_bm_read() - Read the whole bitmap from its on disk location.
* @device: DRBD device.
+ * @peer_device: Peer device for which the bitmap read is performed.
*/
int drbd_bm_read(struct drbd_device *device,
struct drbd_peer_device *peer_device) __must_hold(local)
@@ -1224,6 +1225,7 @@ int drbd_bm_read(struct drbd_device *device,
/**
* drbd_bm_write() - Write the whole bitmap to its on disk location.
* @device: DRBD device.
+ * @peer_device: Peer device for which the bitmap write is performed.
*
* Will only write pages that have changed since last IO.
*/
@@ -1236,7 +1238,7 @@ int drbd_bm_write(struct drbd_device *device,
/**
* drbd_bm_write_all() - Write the whole bitmap to its on disk location.
* @device: DRBD device.
- *
+ * @peer_device: Peer device for which the bitmap write is performed.
* Will write all pages.
*/
int drbd_bm_write_all(struct drbd_device *device,
@@ -1258,6 +1260,7 @@ int drbd_bm_write_lazy(struct drbd_device *device, unsigned upper_idx) __must_ho
/**
* drbd_bm_write_copy_pages() - Write the whole bitmap to its on disk location.
* @device: DRBD device.
+ * @peer_device: Peer device for which the bitmap write is performed.
*
* Will only write pages that have changed since last IO.
* In contrast to drbd_bm_write(), this will copy the bitmap pages
@@ -1275,6 +1278,7 @@ int drbd_bm_write_copy_pages(struct drbd_device *device,
/**
* drbd_bm_write_hinted() - Write bitmap pages with "hint" marks, if they have changed.
* @device: DRBD device.
+ * @peer_device: Peer device for which the bitmap write is performed.
*/
int drbd_bm_write_hinted(struct drbd_device *device) __must_hold(local)
{
--
2.43.0
next reply other threads:[~2025-11-17 17:26 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-17 17:25 Sukrut Heroorkar [this message]
2025-11-18 6:09 ` [PATCH] drbd: add missing kernel-doc for peer_device parameter Christoph Hellwig
2025-11-18 9:09 ` sukrut heroorkar
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=20251117172557.355797-1-hsukrut3@gmail.com \
--to=hsukrut3@gmail.com \
--cc=axboe@kernel.dk \
--cc=christoph.boehmwalder@linbit.com \
--cc=david.hunter.linux@gmail.com \
--cc=drbd-dev@lists.linbit.com \
--cc=lars.ellenberg@linbit.com \
--cc=linux-block@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=philipp.reisner@linbit.com \
--cc=shuah@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox