diff options
author | Jonathan Corbet <corbet@lwn.net> | 2017-07-30 18:16:04 -0400 |
---|---|---|
committer | Tejun Heo <tj@kernel.org> | 2017-07-31 11:03:06 -0400 |
commit | 2f60e1ab2f0e148e82cb53c539ad003ffc9b9bd0 (patch) | |
tree | c827a56cfc3e3368faf4c15b71cc83798f054331 | |
parent | 59a5e266c3f5c1567508888dd61a45b86daed0fa (diff) |
libata: fix a couple of doc build warnings
The kerneldoc comments for a couple of functions in drivers/ata/libata-eh.c
had fallen behind the current implementation, resulting in these doc build
warnings:
./drivers/ata/libata-eh.c:1449: warning: No description found for parameter 'link'
./drivers/ata/libata-eh.c:1449: warning: Excess function parameter 'ap' description in 'ata_eh_done'
./drivers/ata/libata-eh.c:1590: warning: No description found for parameter 'qc'
./drivers/ata/libata-eh.c:1590: warning: Excess function parameter 'dev' description in 'ata_eh_request_sense'
Update the comments and make the warnings go away.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Tejun Heo <tj@kernel.org>
-rw-r--r-- | drivers/ata/libata-eh.c | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/drivers/ata/libata-eh.c b/drivers/ata/libata-eh.c index 7d79d206938a..3dbd05532c09 100644 --- a/drivers/ata/libata-eh.c +++ b/drivers/ata/libata-eh.c | |||
@@ -1434,7 +1434,7 @@ void ata_eh_about_to_do(struct ata_link *link, struct ata_device *dev, | |||
1434 | 1434 | ||
1435 | /** | 1435 | /** |
1436 | * ata_eh_done - EH action complete | 1436 | * ata_eh_done - EH action complete |
1437 | * @ap: target ATA port | 1437 | * @link: ATA link for which EH actions are complete |
1438 | * @dev: target ATA dev for per-dev action (can be NULL) | 1438 | * @dev: target ATA dev for per-dev action (can be NULL) |
1439 | * @action: action just completed | 1439 | * @action: action just completed |
1440 | * | 1440 | * |
@@ -1576,7 +1576,7 @@ unsigned int atapi_eh_tur(struct ata_device *dev, u8 *r_sense_key) | |||
1576 | 1576 | ||
1577 | /** | 1577 | /** |
1578 | * ata_eh_request_sense - perform REQUEST_SENSE_DATA_EXT | 1578 | * ata_eh_request_sense - perform REQUEST_SENSE_DATA_EXT |
1579 | * @dev: device to perform REQUEST_SENSE_SENSE_DATA_EXT to | 1579 | * @qc: qc to perform REQUEST_SENSE_SENSE_DATA_EXT to |
1580 | * @cmd: scsi command for which the sense code should be set | 1580 | * @cmd: scsi command for which the sense code should be set |
1581 | * | 1581 | * |
1582 | * Perform REQUEST_SENSE_DATA_EXT after the device reported CHECK | 1582 | * Perform REQUEST_SENSE_DATA_EXT after the device reported CHECK |