Skip to content

Commit 7334969

Browse files
rddunlapmartinkpetersen
authored andcommitted
scsi: docs: Clean up some style in scsi_mid_low_api
Capitalize Linux but not "kernel." Spell out Linux instead of using "lk". Hyphenate "system-wide." Hyphenate "32-bit". End a sentence with a period (full stop). Change "double linked" to "doubly linked" list. Use SCSI or scsi but not Scsi. Signed-off-by: Randy Dunlap <[email protected]> Link: https://lore.kernel.org/r/[email protected] Cc: James E.J. Bottomley <[email protected]> Cc: Martin K. Petersen <[email protected]> Cc: [email protected] Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Martin K. Petersen <[email protected]>
1 parent e256821 commit 7334969

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Documentation/scsi/scsi_mid_low_api.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ ISA adapters).]
3737
The SCSI mid level isolates an LLD from other layers such as the SCSI
3838
upper layer drivers and the block layer.
3939

40-
This version of the document roughly matches linux kernel version 2.6.8 .
40+
This version of the document roughly matches Linux kernel version 2.6.8 .
4141

4242
Documentation
4343
=============
@@ -48,7 +48,7 @@ found in that directory. A more recent copy of this document may be found
4848
at https://docs.kernel.org/scsi/scsi_mid_low_api.html. Many LLDs are
4949
documented in Documentation/scsi (e.g. aic7xxx.rst). The SCSI mid-level is
5050
briefly described in scsi.rst which contains a URL to a document describing
51-
the SCSI subsystem in the Linux Kernel 2.4 series. Two upper level
51+
the SCSI subsystem in the Linux kernel 2.4 series. Two upper level
5252
drivers have documents in that directory: st.rst (SCSI tape driver) and
5353
scsi-generic.rst (for the sg driver).
5454

@@ -75,7 +75,7 @@ It is probably best to study how existing LLDs are organized.
7575
As the 2.5 series development kernels evolve into the 2.6 series
7676
production series, changes are being introduced into this interface. An
7777
example of this is driver initialization code where there are now 2 models
78-
available. The older one, similar to what was found in the lk 2.4 series,
78+
available. The older one, similar to what was found in the Linux 2.4 series,
7979
is based on hosts that are detected at HBA driver load time. This will be
8080
referred to the "passive" initialization model. The newer model allows HBAs
8181
to be hot plugged (and unplugged) during the lifetime of the LLD and will
@@ -1026,7 +1026,7 @@ initialized from the driver's struct scsi_host_template instance. Members
10261026
of interest:
10271027

10281028
host_no
1029-
- system wide unique number that is used for identifying
1029+
- system-wide unique number that is used for identifying
10301030
this host. Issued in ascending order from 0.
10311031
can_queue
10321032
- must be greater than 0; do not send more than can_queue
@@ -1053,7 +1053,7 @@ of interest:
10531053
- pointer to driver's struct scsi_host_template from which
10541054
this struct Scsi_Host instance was spawned
10551055
hostt->proc_name
1056-
- name of LLD. This is the driver name that sysfs uses
1056+
- name of LLD. This is the driver name that sysfs uses.
10571057
transportt
10581058
- pointer to driver's struct scsi_transport_template instance
10591059
(if any). FC and SPI transports currently supported.
@@ -1067,7 +1067,7 @@ The scsi_host structure is defined in include/scsi/scsi_host.h
10671067
struct scsi_device
10681068
------------------
10691069
Generally, there is one instance of this structure for each SCSI logical unit
1070-
on a host. Scsi devices connected to a host are uniquely identified by a
1070+
on a host. SCSI devices connected to a host are uniquely identified by a
10711071
channel number, target id and logical unit number (lun).
10721072
The structure is defined in include/scsi/scsi_device.h
10731073

@@ -1091,7 +1091,7 @@ Members of interest:
10911091
- should be set by LLD prior to calling 'done'. A value
10921092
of 0 implies a successfully completed command (and all
10931093
data (if any) has been transferred to or from the SCSI
1094-
target device). 'result' is a 32 bit unsigned integer that
1094+
target device). 'result' is a 32-bit unsigned integer that
10951095
can be viewed as 2 related bytes. The SCSI status value is
10961096
in the LSB. See include/scsi/scsi.h status_byte() and
10971097
host_byte() macros and related constants.
@@ -1180,8 +1180,8 @@ may get out of synchronization. This is why it is best for the LLD
11801180
to perform autosense.
11811181

11821182

1183-
Changes since lk 2.4 series
1184-
===========================
1183+
Changes since Linux kernel 2.4 series
1184+
=====================================
11851185
io_request_lock has been replaced by several finer grained locks. The lock
11861186
relevant to LLDs is struct Scsi_Host::host_lock and there is
11871187
one per SCSI host.

0 commit comments

Comments
 (0)