* [PATCH] libata kernel-doc fixes
@ 2005-11-02 5:29 Randy.Dunlap
2005-11-09 6:11 ` Jeff Garzik
0 siblings, 1 reply; 4+ messages in thread
From: Randy.Dunlap @ 2005-11-02 5:29 UTC (permalink / raw)
To: linux-ide; +Cc: jgarzik
From: Randy Dunlap <rdunlap@xenotime.net>
Fix all reported kernel-doc errors in libata.
Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
---
drivers/scsi/libata-core.c | 4 ++--
drivers/scsi/libata-scsi.c | 7 ++++---
2 files changed, 6 insertions(+), 5 deletions(-)
diff -Naurp linux-2614-g4/drivers/scsi/libata-core.c~kdoc_libata linux-2614-g4/drivers/scsi/libata-core.c
--- linux-2614-g4/drivers/scsi/libata-core.c~kdoc_libata 2005-11-01 20:35:13.000000000 -0800
+++ linux-2614-g4/drivers/scsi/libata-core.c 2005-11-01 21:17:42.000000000 -0800
@@ -2620,7 +2620,7 @@ static int ata_sg_setup(struct ata_queue
/**
* ata_poll_qc_complete - turn irq back on and finish qc
* @qc: Command to complete
- * @drv_stat: ATA status register content
+ * @err_mask: ATA status register content
*
* LOCKING:
* None. (grabs host lock)
@@ -3385,7 +3385,7 @@ void ata_qc_free(struct ata_queued_cmd *
/**
* ata_qc_complete - Complete an active ATA command
* @qc: Command to complete
- * @drv_stat: ATA Status register contents
+ * @err_mask: ATA Status register contents
*
* Indicate to the mid and upper layers that an ATA
* command has completed, with either an ok or not-ok status.
diff -Naurp linux-2614-g4/drivers/scsi/libata-scsi.c~kdoc_libata linux-2614-g4/drivers/scsi/libata-scsi.c
--- linux-2614-g4/drivers/scsi/libata-scsi.c~kdoc_libata 2005-11-01 20:35:13.000000000 -0800
+++ linux-2614-g4/drivers/scsi/libata-scsi.c 2005-11-01 21:20:46.000000000 -0800
@@ -131,7 +131,7 @@ int ata_std_bios_param(struct scsi_devic
/**
* ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
- * @dev: Device to whom we are issuing command
+ * @scsidev: Device to which we are issuing command
* @arg: User provided data for issuing command
*
* LOCKING:
@@ -217,7 +217,7 @@ error:
/**
* ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
- * @dev: Device to whom we are issuing command
+ * @scsidev: Device to which we are issuing command
* @arg: User provided data for issuing command
*
* LOCKING:
@@ -416,6 +416,7 @@ void ata_dump_status(unsigned id, struct
/**
* ata_to_sense_error - convert ATA error to SCSI error
+ * @id: ATA device number
* @drv_stat: value contained in ATA status register
* @drv_err: value contained in ATA error register
* @sk: the sense key we'll fill out
@@ -2221,7 +2222,7 @@ ata_scsi_map_proto(u8 byte1)
/**
* ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
* @qc: command structure to be initialized
- * @cmd: SCSI command to convert
+ * @scsicmd: SCSI command to convert
*
* Handles either 12 or 16-byte versions of the CDB.
*
---
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH] libata kernel-doc fixes
@ 2005-10-25 5:26 Randy.Dunlap
2005-10-25 5:44 ` Jeff Garzik
0 siblings, 1 reply; 4+ messages in thread
From: Randy.Dunlap @ 2005-10-25 5:26 UTC (permalink / raw)
To: linux-ide; +Cc: jgarzik
From: Randy Dunlap <rdunlap@xenotime.net>
Correct some function names in kernel-doc.
Add some kernel-doc descriptions.
Fix some typos.
Remove a few blank lines.
Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
---
drivers/scsi/libata-core.c | 36 +++++++++++++----------------------
1 files changed, 14 insertions(+), 22 deletions(-)
diff -Naurp linux-2614-rc5/drivers/scsi/libata-core.c~kdoc_libata linux-2614-rc5/drivers/scsi/libata-core.c
--- linux-2614-rc5/drivers/scsi/libata-core.c~kdoc_libata 2005-10-20 18:55:34.000000000 -0700
+++ linux-2614-rc5/drivers/scsi/libata-core.c 2005-10-24 21:57:44.000000000 -0700
@@ -85,7 +85,7 @@ MODULE_LICENSE("GPL");
MODULE_VERSION(DRV_VERSION);
/**
- * ata_tf_load - send taskfile registers to host controller
+ * ata_tf_load_pio - send taskfile registers to host controller
* @ap: Port to which output is sent
* @tf: ATA taskfile register set
*
@@ -2413,13 +2413,13 @@ void ata_poll_qc_complete(struct ata_que
/**
* ata_pio_poll -
- * @ap:
+ * @ap: the target ata_port
*
* LOCKING:
* None. (executing in kernel thread context)
*
* RETURNS:
- *
+ * timeout value to use
*/
static unsigned long ata_pio_poll(struct ata_port *ap)
@@ -2460,8 +2460,8 @@ static unsigned long ata_pio_poll(struct
}
/**
- * ata_pio_complete -
- * @ap:
+ * ata_pio_complete - check if drive is busy or idle
+ * @ap: the target ata_port
*
* LOCKING:
* None. (executing in kernel thread context)
@@ -2513,7 +2513,7 @@ static int ata_pio_complete (struct ata_
/**
- * swap_buf_le16 -
+ * swap_buf_le16 - swap halves of 16-words in place
* @buf: Buffer to swap
* @buf_words: Number of 16-bit words in buffer.
*
@@ -2522,6 +2522,7 @@ static int ata_pio_complete (struct ata_
* vice-versa.
*
* LOCKING:
+ * Inherited from caller.
*/
void swap_buf_le16(u16 *buf, unsigned int buf_words)
{
@@ -2544,7 +2545,6 @@ void swap_buf_le16(u16 *buf, unsigned in
*
* LOCKING:
* Inherited from caller.
- *
*/
static void ata_mmio_data_xfer(struct ata_port *ap, unsigned char *buf,
@@ -2590,7 +2590,6 @@ static void ata_mmio_data_xfer(struct at
*
* LOCKING:
* Inherited from caller.
- *
*/
static void ata_pio_data_xfer(struct ata_port *ap, unsigned char *buf,
@@ -2630,7 +2629,6 @@ static void ata_pio_data_xfer(struct ata
*
* LOCKING:
* Inherited from caller.
- *
*/
static void ata_data_xfer(struct ata_port *ap, unsigned char *buf,
@@ -2783,7 +2781,6 @@ next_sg:
*
* LOCKING:
* Inherited from caller.
- *
*/
static void atapi_pio_bytes(struct ata_queued_cmd *qc)
@@ -2819,8 +2816,8 @@ err_out:
}
/**
- * ata_pio_sector -
- * @ap:
+ * ata_pio_block - start PIO on a block
+ * @ap: the target ata_port
*
* LOCKING:
* None. (executing in kernel thread context)
@@ -2832,7 +2829,7 @@ static void ata_pio_block(struct ata_por
u8 status;
/*
- * This is purely hueristic. This is a fast path.
+ * This is purely heuristic. This is a fast path.
* Sometimes when we enter, BSY will be cleared in
* a chk-status or two. If not, the drive is probably seeking
* or something. Snooze for a couple msecs, then
@@ -3201,7 +3198,6 @@ static void __ata_qc_complete(struct ata
*
* LOCKING:
* spin_lock_irqsave(host_set lock)
- *
*/
void ata_qc_free(struct ata_queued_cmd *qc)
{
@@ -3221,7 +3217,6 @@ void ata_qc_free(struct ata_queued_cmd *
*
* LOCKING:
* spin_lock_irqsave(host_set lock)
- *
*/
void ata_qc_complete(struct ata_queued_cmd *qc, u8 drv_stat)
@@ -3715,7 +3710,6 @@ idle_irq:
*
* RETURNS:
* IRQ_NONE or IRQ_HANDLED.
- *
*/
irqreturn_t ata_interrupt (int irq, void *dev_instance, struct pt_regs *regs)
@@ -3827,6 +3821,7 @@ err_out:
* May be used as the port_start() entry in ata_port_operations.
*
* LOCKING:
+ * Inherited from caller.
*/
int ata_port_start (struct ata_port *ap)
@@ -3852,6 +3847,7 @@ int ata_port_start (struct ata_port *ap)
* May be used as the port_stop() entry in ata_port_operations.
*
* LOCKING:
+ * Inherited from caller.
*/
void ata_port_stop (struct ata_port *ap)
@@ -3874,6 +3870,7 @@ void ata_host_stop (struct ata_host_set
* @do_unregister: 1 if we fully unregister, 0 to just stop the port
*
* LOCKING:
+ * Inherited from caller.
*/
static void ata_host_remove(struct ata_port *ap, unsigned int do_unregister)
@@ -3901,7 +3898,6 @@ static void ata_host_remove(struct ata_p
*
* LOCKING:
* Inherited from caller.
- *
*/
static void ata_host_init(struct ata_port *ap, struct Scsi_Host *host,
@@ -3962,7 +3958,6 @@ static void ata_host_init(struct ata_por
*
* RETURNS:
* New ata_port on success, for NULL on error.
- *
*/
static struct ata_port * ata_host_add(struct ata_probe_ent *ent,
@@ -4010,7 +4005,6 @@ err_out:
*
* RETURNS:
* Number of ports registered. Zero on error (no ports registered).
- *
*/
int ata_device_add(struct ata_probe_ent *ent)
@@ -4142,7 +4136,6 @@ err_out:
* Inherited from calling layer (may sleep).
*/
-
void ata_host_set_remove(struct ata_host_set *host_set)
{
struct ata_port *ap;
@@ -4374,7 +4367,6 @@ ata_pci_init_legacy_mode(struct pci_dev
*
* RETURNS:
* Zero on success, negative on errno-based value on error.
- *
*/
int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
@@ -4505,7 +4497,7 @@ err_out:
* @pdev: PCI device that was removed
*
* PCI layer indicates to libata via this hook that
- * hot-unplug or module unload event has occured.
+ * hot-unplug or module unload event has occurred.
* Handle this by unregistering all objects associated
* with this PCI device. Free those objects. Then finally
* release PCI resources and disable device.
---
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2005-11-09 6:11 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2005-11-02 5:29 [PATCH] libata kernel-doc fixes Randy.Dunlap
2005-11-09 6:11 ` Jeff Garzik
-- strict thread matches above, loose matches on Subject: below --
2005-10-25 5:26 Randy.Dunlap
2005-10-25 5:44 ` Jeff Garzik
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).