Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
scsi: documentation: Clean up scsi_mid_low_api.rst
- Update the format (txt to rst) and location of this document
(archive.org to docs.kernel.org)
- Change url to URL
- Spell out "lk" (Linux Kernel)
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20240408025425.18778-2-rdunlap@infradead.org
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
authored by
Randy Dunlap
and committed by
Martin K. Petersen
c3bf7774
4cece764
+10
-10
+10
-10
Documentation/scsi/scsi_mid_low_api.rst
+10
-10
Documentation/scsi/scsi_mid_low_api.rst
···
42
42
Documentation
43
43
=============
44
44
There is a SCSI documentation directory within the kernel source tree,
45
-
typically Documentation/scsi . Most documents are in plain
46
-
(i.e. ASCII) text. This file is named scsi_mid_low_api.txt and can be
45
+
typically Documentation/scsi . Most documents are in reStructuredText
46
+
format. This file is named scsi_mid_low_api.rst and can be
47
47
found in that directory. A more recent copy of this document may be found
48
-
at http://web.archive.org/web/20070107183357rn_1/sg.torque.net/scsi/.
49
-
Many LLDs are documented there (e.g. aic7xxx.txt). The SCSI mid-level is
50
-
briefly described in scsi.txt which contains a url to a document
51
-
describing the SCSI subsystem in the lk 2.4 series. Two upper level
52
-
drivers have documents in that directory: st.txt (SCSI tape driver) and
53
-
scsi-generic.txt (for the sg driver).
48
+
at https://docs.kernel.org/scsi/scsi_mid_low_api.html. Many LLDs are
49
+
documented in Documentation/scsi (e.g. aic7xxx.rst). The SCSI mid-level is
50
+
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
52
+
drivers have documents in that directory: st.rst (SCSI tape driver) and
53
+
scsi-generic.rst (for the sg driver).
54
54
55
-
Some documentation (or urls) for LLDs may be found in the C source code
56
-
or in the same directory as the C source code. For example to find a url
55
+
Some documentation (or URLs) for LLDs may be found in the C source code
56
+
or in the same directory as the C source code. For example to find a URL
57
57
about the USB mass storage driver see the
58
58
/usr/src/linux/drivers/usb/storage directory.
59
59