Kernel/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-12-29 17:25:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

scsi: documentation: Clean up scsi_mid_low_api.rst

Browse Source 
- 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>
This commit is contained in:
Randy Dunlap 2024-04-07 19:54:18 -07:00 committed by Martin K. Petersen
parent 4cece76496
commit c3bf7774fa
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/scsi/scsi_mid_low_api.rst
View File

@ -42,18 +42,18 @@ This version of the document roughly matches linux kernel version 2.6.8 .
Documentation Documentation
============= =============
There is a SCSI documentation directory within the kernel source tree, There is a SCSI documentation directory within the kernel source tree,
typically Documentation/scsi . Most documents are in plain typically Documentation/scsi . Most documents are in reStructuredText
(i.e. ASCII) text. This file is named scsi_mid_low_api.txt and can be format. This file is named scsi_mid_low_api.rst and can be
found in that directory. A more recent copy of this document may be found found in that directory. A more recent copy of this document may be found
at http://web.archive.org/web/20070107183357rn_1/sg.torque.net/scsi/. at https://docs.kernel.org/scsi/scsi_mid_low_api.html. Many LLDs are
Many LLDs are documented there (e.g. aic7xxx.txt). The SCSI mid-level is documented in Documentation/scsi (e.g. aic7xxx.rst). The SCSI mid-level is
briefly described in scsi.txt which contains a url to a document briefly described in scsi.rst which contains a URL to a document describing
describing the SCSI subsystem in the lk 2.4 series. Two upper level the SCSI subsystem in the Linux Kernel 2.4 series. Two upper level
drivers have documents in that directory: st.txt (SCSI tape driver) and drivers have documents in that directory: st.rst (SCSI tape driver) and
scsi-generic.txt (for the sg driver). scsi-generic.rst (for the sg driver).
Some documentation (or urls) for LLDs may be found in the C source code Some documentation (or URLs) for LLDs may be found in the C source code
or in the same directory as the C source code. For example to find a url or in the same directory as the C source code. For example to find a URL
about the USB mass storage driver see the about the USB mass storage driver see the
/usr/src/linux/drivers/usb/storage directory. /usr/src/linux/drivers/usb/storage directory.