Commit 2f60e1ab authored Jul 30, 2017 by Jonathan Corbet Committed by Tejun Heo Jul 31, 2017

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>

parent 59a5e266

drivers/ata/libata-eh.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -1434,7 +1434,7 @@ void ata_eh_about_to_do(struct ata_link link, struct ata_device dev,

		/**
		* ata_eh_done - EH action complete
		* @ap: target ATA port
		* @link: ATA link for which EH actions are complete
		* @dev: target ATA dev for per-dev action (can be NULL)
		* @action: action just completed
		*
		@@ -1576,7 +1576,7 @@ unsigned int atapi_eh_tur(struct ata_device dev, u8 r_sense_key)

		/**
		* ata_eh_request_sense - perform REQUEST_SENSE_DATA_EXT
		* @dev: device to perform REQUEST_SENSE_SENSE_DATA_EXT to
		* @qc: qc to perform REQUEST_SENSE_SENSE_DATA_EXT to
		* @cmd: scsi command for which the sense code should be set
		*
		* Perform REQUEST_SENSE_DATA_EXT after the device reported CHECK

Admin message