linux-kernel - [PATCH 04/21] ide: ide-io: Fix a few kernel-doc misdemeanours

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20210602101722.2276638-5-lee.jones@linaro.org>
Date:   Wed,  2 Jun 2021 11:17:05 +0100
From:   Lee Jones <lee.jones@...aro.org>
To:     lee.jones@...aro.org
Cc:     linux-kernel@...r.kernel.org,
        "David S. Miller" <davem@...emloft.net>, linux-ide@...r.kernel.org
Subject: [PATCH 04/21] ide: ide-io: Fix a few kernel-doc misdemeanours

Fixes the following W=1 kernel build warning(s):

 drivers/ide/ide-io.c:268: warning: expecting prototype for execute_drive_command(). Prototype was for execute_drive_cmd() instead
 drivers/ide/ide-io.c:320: warning: Function parameter or member 'drive' not described in 'start_request'
 drivers/ide/ide-io.c:320: warning: Function parameter or member 'rq' not described in 'start_request'
 drivers/ide/ide-io.c:618: warning: Function parameter or member 't' not described in 'ide_timer_expiry'
 drivers/ide/ide-io.c:618: warning: Excess function parameter 'data' description in 'ide_timer_expiry'
 drivers/ide/ide-io.c:775: warning: Excess function parameter 'regs' description in 'ide_intr'

Cc: "David S. Miller" <davem@...emloft.net>
Cc: linux-ide@...r.kernel.org
Signed-off-by: Lee Jones <lee.jones@...aro.org>
---
 drivers/ide/ide-io.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/ide/ide-io.c b/drivers/ide/ide-io.c
index 4867b67b60d69..bd3e78985bcc7 100644
--- a/drivers/ide/ide-io.c
+++ b/drivers/ide/ide-io.c
@@ -252,7 +252,7 @@ void ide_init_sg_cmd(struct ide_cmd *cmd, unsigned int nr_bytes)
 EXPORT_SYMBOL_GPL(ide_init_sg_cmd);
 
 /**
- *	execute_drive_command	-	issue special drive command
+ *	execute_drive_cmd	-	issue special drive command
  *	@drive: the drive to issue the command on
  *	@rq: the request structure holding the command
  *
@@ -309,6 +309,8 @@ static ide_startstop_t ide_special_rq(ide_drive_t *drive, struct request *rq)
 
 /**
  *	start_request	-	start of I/O and command issuing for IDE
+ *	@drive: the drive to issue the command on
+ *	@rq: the request structure holding the command
  *
  *	start_request() initiates handling of a new I/O request. It
  *	accepts commands and I/O (read/write) requests.
@@ -602,7 +604,7 @@ static int drive_is_ready(ide_drive_t *drive)
 
 /**
  *	ide_timer_expiry	-	handle lack of an IDE interrupt
- *	@data: timer callback magic (hwif)
+ *	@t: timer callback magic (hwif)
  *
  *	An IDE command has timed out before the expected drive return
  *	occurred. At this point we attempt to clean up the current
@@ -748,9 +750,7 @@ static void unexpected_intr(int irq, ide_hwif_t *hwif)
 
 /**
  *	ide_intr	-	default IDE interrupt handler
- *	@irq: interrupt number
  *	@dev_id: hwif
- *	@regs: unused weirdness from the kernel irq layer
  *
  *	This is the default IRQ handler for the IDE layer. You should
  *	not need to override it. If you do be aware it is subtle in
-- 
2.31.1