diff mbox series

block: fix kernel-doc for disk_force_media_change()

Message ID 20230926005232.23666-1-rdunlap@infradead.org
State New
Headers
Series block: fix kernel-doc for disk_force_media_change() |

Commit Message

Randy Dunlap Sept. 26, 2023, 12:52 a.m. UTC 
  Drop one function parameter's kernel-doc comment since the parameter
was removed. This prevents a kernel-doc warning:

block/disk-events.c:300: warning: Excess function parameter 'events' description in 'disk_force_media_change'

Fixes: ab6860f62bfe ("block: simplify the disk_force_media_change interface")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Closes: lore.kernel.org/r/202309060957.vfl0mUur-lkp@intel.com
Cc: Christoph Hellwig <hch@lst.de>
Cc: Jens Axboe <axboe@kernel.dk>
Cc: linux-block@vger.kernel.org
---
 block/disk-events.c |    1 -
 1 file changed, 1 deletion(-)

Comments

Christoph Hellwig Sept. 26, 2023, 6:04 a.m. UTC | #1 
Looks good:

Reviewed-by: Christoph Hellwig <hch@lst.de>
Jens Axboe Sept. 26, 2023, 6:43 a.m. UTC | #2 
On Mon, 25 Sep 2023 17:52:32 -0700, Randy Dunlap wrote:
> Drop one function parameter's kernel-doc comment since the parameter
> was removed. This prevents a kernel-doc warning:
> 
> block/disk-events.c:300: warning: Excess function parameter 'events' description in 'disk_force_media_change'
> 
> 

Applied, thanks!

[1/1] block: fix kernel-doc for disk_force_media_change()
      commit: a578a25339aca38e23bb5af6e3fc6c2c51f0215c

Best regards,
diff mbox series

Patch

diff -- a/block/disk-events.c b/block/disk-events.c
--- a/block/disk-events.c
+++ b/block/disk-events.c
@@ -290,7 +290,6 @@  EXPORT_SYMBOL(disk_check_media_change);
 /**
  * disk_force_media_change - force a media change event
  * @disk: the disk which will raise the event
- * @events: the events to raise
  *
  * Should be called when the media changes for @disk.  Generates a uevent
  * and attempts to free all dentries and inodes and invalidates all block