diff options
| author |  Randy Dunlap <rdunlap@infradead.org>
| 2024-04-07 19:54:18 -0700 |
|---|---|---|
| committer |  Martin K. Petersen <martin.petersen@oracle.com>
| 2024-04-08 22:10:05 -0400 |
| commit | c3bf7774fa24f9c919947cd20dd7211bdf98b113 (patch) | |
| tree | d4fcd9f8e43f3ae377036529f61ad7cdd3fd2213 /Documentation/scsi | |
| parent | Linux 6.9-rc1 (diff) | |
| download | linux-c3bf7774fa24f9c919947cd20dd7211bdf98b113.tar.gz linux-c3bf7774fa24f9c919947cd20dd7211bdf98b113.tar.bz2 linux-c3bf7774fa24f9c919947cd20dd7211bdf98b113.zip | |
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>
Diffstat (limited to 'Documentation/scsi')
| -rw-r--r-- | Documentation/scsi/scsi_mid_low_api.rst | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/Documentation/scsi/scsi_mid_low_api.rst b/Documentation/scsi/scsi_mid_low_api.rst index 022198c51350..2df29b92e196 100644 --- a/Documentation/scsi/scsi_mid_low_api.rst +++ b/Documentation/scsi/scsi_mid_low_api.rst @@ -42,18 +42,18 @@ This version of the document roughly matches linux kernel version 2.6.8 . Documentation ============= There is a SCSI documentation directory within the kernel source tree, -typically Documentation/scsi . Most documents are in plain -(i.e. ASCII) text. This file is named scsi_mid_low_api.txt and can be +typically Documentation/scsi . Most documents are in reStructuredText +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 -at http://web.archive.org/web/20070107183357rn_1/sg.torque.net/scsi/. -Many LLDs are documented there (e.g. aic7xxx.txt). The SCSI mid-level is -briefly described in scsi.txt which contains a url to a document -describing the SCSI subsystem in the lk 2.4 series. Two upper level -drivers have documents in that directory: st.txt (SCSI tape driver) and -scsi-generic.txt (for the sg driver). - -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 +at https://docs.kernel.org/scsi/scsi_mid_low_api.html. Many LLDs are +documented in Documentation/scsi (e.g. aic7xxx.rst). The SCSI mid-level is +briefly described in scsi.rst which contains a URL to a document describing +the SCSI subsystem in the Linux Kernel 2.4 series. Two upper level +drivers have documents in that directory: st.rst (SCSI tape driver) and +scsi-generic.rst (for the sg driver). + +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 about the USB mass storage driver see the /usr/src/linux/drivers/usb/storage directory. |