[PATCH] drbd: add missing kernel-doc for peer_device parameter

[PATCH] drbd: add missing kernel-doc for peer_device parameter

[Sukrut Heroorkar]

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

Re: [PATCH] drbd: add missing kernel-doc for peer_device parameter

[Christoph Hellwig]

On Mon, Nov 17, 2025 at 10:55:56PM +0530, Sukrut Heroorkar wrote:
> 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.

Or just make it a non-kerneldoc comment as it doesn't document an
external API to start with.

Re: [PATCH] drbd: add missing kernel-doc for peer_device parameter

[sukrut heroorkar]

On Tue, Nov 18, 2025 at 11:39 AM Christoph Hellwig <hch@infradead.org> wrote:
>
> On Mon, Nov 17, 2025 at 10:55:56PM +0530, Sukrut Heroorkar wrote:
> > 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.
>
> Or just make it a non-kerneldoc comment as it doesn't document an
> external API to start with.
>
Thank you. I have sent another patch adhering to this suggestion.