Commit dc8875e1 authored by Randy Dunlap's avatar Randy Dunlap Committed by James Bottomley

[SCSI] docbook and kernel-doc updates

- Change title to remove "Mid-Layer" since the doc is about all of the
SCSI layers.
- Use "SCSI" instead of "scsi" in docbook text.
- Use "*/" to end kernel-doc notation blocks.
- A few other minor typo fixes.
Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarJames Bottomley <James.Bottomley@HansenPartnership.com>
parent c93ff979
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
<book id="scsimid"> <book id="scsimid">
<bookinfo> <bookinfo>
<title>SCSI Mid Layer Guide</title> <title>SCSI Interfaces Guide</title>
<authorgroup> <authorgroup>
<author> <author>
...@@ -92,7 +92,7 @@ ...@@ -92,7 +92,7 @@
The SCSI subsystem uses a three layer design, with upper, mid, and low The SCSI subsystem uses a three layer design, with upper, mid, and low
layers. Every operation involving the SCSI subsystem (such as reading layers. Every operation involving the SCSI subsystem (such as reading
a sector from a disk) uses one driver at each of the 3 levels: one a sector from a disk) uses one driver at each of the 3 levels: one
upper layer driver, one lower layer driver, and the scsi midlayer. upper layer driver, one lower layer driver, and the SCSI midlayer.
</para> </para>
<para> <para>
The SCSI upper layer provides the interface between userspace and the The SCSI upper layer provides the interface between userspace and the
...@@ -154,7 +154,7 @@ ...@@ -154,7 +154,7 @@
<sect2 id="scsi.c"> <sect2 id="scsi.c">
<title>drivers/scsi/scsi.c</title> <title>drivers/scsi/scsi.c</title>
<para>Main file for the scsi midlayer.</para> <para>Main file for the SCSI midlayer.</para>
!Edrivers/scsi/scsi.c !Edrivers/scsi/scsi.c
</sect2> </sect2>
<sect2 id="scsicam.c"> <sect2 id="scsicam.c">
...@@ -182,7 +182,7 @@ ...@@ -182,7 +182,7 @@
<sect2 id="scsi_ioctl.c"> <sect2 id="scsi_ioctl.c">
<title>drivers/scsi/scsi_ioctl.c</title> <title>drivers/scsi/scsi_ioctl.c</title>
<para> <para>
Handle ioctl() calls for scsi devices. Handle ioctl() calls for SCSI devices.
</para> </para>
!Edrivers/scsi/scsi_ioctl.c !Edrivers/scsi/scsi_ioctl.c
</sect2> </sect2>
...@@ -287,7 +287,7 @@ ...@@ -287,7 +287,7 @@
<sect1 id="Transport_classes"> <sect1 id="Transport_classes">
<title>Transport classes</title> <title>Transport classes</title>
<para> <para>
Transport classes are service libraries for drivers in the scsi Transport classes are service libraries for drivers in the SCSI
lower layer, which expose transport attributes in sysfs. lower layer, which expose transport attributes in sysfs.
</para> </para>
<sect2 id="Fibre_Channel_transport"> <sect2 id="Fibre_Channel_transport">
......
...@@ -960,7 +960,7 @@ EXPORT_SYMBOL(__starget_for_each_device); ...@@ -960,7 +960,7 @@ EXPORT_SYMBOL(__starget_for_each_device);
* reference. You must hold the host's host_lock over this call and * reference. You must hold the host's host_lock over this call and
* any access to the returned scsi_device. * any access to the returned scsi_device.
* *
* Note: The only reason why drivers would want to use this is because * Note: The only reason why drivers should use this is because
* they need to access the device list in irq context. Otherwise you * they need to access the device list in irq context. Otherwise you
* really want to use scsi_device_lookup_by_target instead. * really want to use scsi_device_lookup_by_target instead.
**/ **/
......
This diff is collapsed.
...@@ -185,11 +185,10 @@ static int srp_host_match(struct attribute_container *cont, struct device *dev) ...@@ -185,11 +185,10 @@ static int srp_host_match(struct attribute_container *cont, struct device *dev)
/** /**
* srp_rport_add - add a SRP remote port to the device hierarchy * srp_rport_add - add a SRP remote port to the device hierarchy
*
* @shost: scsi host the remote port is connected to. * @shost: scsi host the remote port is connected to.
* @ids: The port id for the remote port. * @ids: The port id for the remote port.
* *
* publishes a port to the rest of the system * Publishes a port to the rest of the system.
*/ */
struct srp_rport *srp_rport_add(struct Scsi_Host *shost, struct srp_rport *srp_rport_add(struct Scsi_Host *shost,
struct srp_rport_identifiers *ids) struct srp_rport_identifiers *ids)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment