Skip to contentSkip to conversation

2.5.7 Documentation/scsi

PATCH New Rolf Eike Beer 1 participant 1 message Mar 25, 2002

Subsystems (7)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 2.5.7 Documentation/scsi

This skript'n'patch creates Documentation/scsi and moves the scsi-related documentation into. The docs are collected from Documentation/ and drivers/scsi/*.

It also does:
-kill Changelog.serverraid. It's an older copy of Changelog.ids, -fixes the references to the docs in drivers and Config.help, -renames the files from README.* to *.txt to look the same way like the other Documentation directories.
-makes some minor changes (all but one cosmetic) to the docs. The one not cosmetic is the patch to cpqfc.txt, which kills 2 lines describing how to include the driver into the kernel.

Depends on my patch to Documentation/00-INDEX!

Eike

Here comes the script:
---------------------
#!/bin/bash

mkdir Documentation/scsi
mv drivers/scsi/README.* Documentation/scsi/
rm drivers/scsi/ChangeLog.serverraid
mv drivers/scsi/ChangeLog.* Documentation/scsi/
mv drivers/scsi/LICENSE.FlashPoint Documentation/scsi/
mv drivers/scsi/aic7xxx_old/README.aic7xxx Documentation/scsi/README.aic7xxx_old mv drivers/scsi/sym53c8xx_2/ChangeLog.txt Documentation/scsi/ChangeLog.sym53c8xx_2 mv drivers/scsi/sym53c8xx_2/Documentation.txt Documentation/scsi/README.sym53c8xx_2 mv drivers/scsi/cpqfc.Readme Documentation/scsi/cpqfc.txt
mv Documentation/scsi.txt Documentation/scsi/
mv Documentation/scsi-generic.txt Documentation/scsi/
mv Documentation/README.nsp_cs.eng Documentation/scsi/NinjaSCSI.txt
cd Documentation/scsi
for i in README.*; do
mv $i echo $i| sed 's/README\.//'.txt
done
cd ../..

---------------------

Documentation/00-INDEX +2 -6
diff -Naur linux-2.5.7-scsi-doc-moved/Documentation/00-INDEX linux-2.5.7-scsi-doc/Documentation/00-INDEX
@@ -34,8 +34,6 @@
 	- info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux
 README.moxa
 	- release notes for Moxa mutiport serial card.
-README.nsp_cs.eng
-	- info on WorkBiT NinjaSCSI-3/32Bi driver.
 SAK.txt
 	- info on Secure Attention Keys.
 SubmittingDrivers
@@ -188,10 +186,8 @@
 	- directory with info on using Linux on the IBM S390.
 sh/
 	- directory with info on porting Linux to a new architecture.
-scsi-generic.txt
-	- info on the sg driver for generic (non-disk/CD/tape) SCSI devices.
-scsi.txt
-	- short blurb on using SCSI support as a module.
+scsi/
+	- directory with info on Linux scsi support.
 serial-console.txt
 	- how to set up Linux with a serial line console as the default.
 sgi-visws.txt
Documentation/scsi/00-INDEX +66 -0

66 lines not on this page · raw message

Documentation/scsi/ChangeLog.ips +0 -1
diff -Naur linux-2.5.7-scsi-doc-moved/Documentation/scsi/ChangeLog.ips linux-2.5.7-scsi-doc/Documentation/scsi/ChangeLog.ips
@@ -86,4 +86,3 @@
                 - Fixed read/write errors when the adapter is using an
                   8K stripe size.
 
-
\ No newline at end of file
Documentation/scsi/ChangeLog.sym53c8xx_2 +0 -4
diff -Naur linux-2.5.7-scsi-doc-moved/Documentation/scsi/ChangeLog.sym53c8xx_2 linux-2.5.7-scsi-doc/Documentation/scsi/ChangeLog.sym53c8xx_2
@@ -142,7 +142,3 @@
 	  consistent with what archs are expecting.
 	- Use MMIO per default for Power PC instead of some fake normal IO,
 	  as Paul Mackerras stated that MMIO works fine now on this arch.
-
-
-
-
Documentation/scsi/FlashPoint.txt +1 -1
diff -Naur linux-2.5.7-scsi-doc-moved/Documentation/scsi/FlashPoint.txt linux-2.5.7-scsi-doc/Documentation/scsi/FlashPoint.txt
@@ -60,7 +60,7 @@
 Mylex Corp.
 510/796-6100
 [email protected]
-
+
 			       ANNOUNCEMENT
 	       BusLogic FlashPoint LT/BT-948 Upgrade Program
 			      1 February 1996
Documentation/scsi/cpqfc.txt +0 -2
diff -Naur linux-2.5.7-scsi-doc-moved/Documentation/scsi/cpqfc.txt linux-2.5.7-scsi-doc/Documentation/scsi/cpqfc.txt
@@ -91,8 +91,6 @@
 using "qa_test" (esp. io_test script) suite modified from Unix tests.
 	
 Installation:
-copy file cpqfcTS.patch to /usr/src/linux
-patch -p1 < cpqfcTS.patch
 make menuconfig
   (select SCSI low-level, Compaq FC HBA)
 make dep
Documentation/scsi/dtc3x80.txt +0 -2
diff -Naur linux-2.5.7-scsi-doc-moved/Documentation/scsi/dtc3x80.txt linux-2.5.7-scsi-doc/Documentation/scsi/dtc3x80.txt
@@ -41,5 +41,3 @@
 nowhere, I give up.  So.....This driver does NOT use interrupts, even
 if you have the card jumpered to an IRQ.  Probably nobody will ever
 care.
-
-
drivers/scsi/Config.help +43 -42

252 lines not on this page · raw message

drivers/scsi/FlashPoint.c +2 -1
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/FlashPoint.c linux-2.5.7-scsi-doc/drivers/scsi/FlashPoint.c
@@ -11,7 +11,8 @@
   Copyright 1995-1996 by Mylex Corporation.  All Rights Reserved
 
   This file is available under both the GNU General Public License
-  and a BSD-style copyright; see LICENSE.FlashPoint for details.
+  and a BSD-style copyright; see Documentation/scsi/LICENSE.FlashPoint for
+  details.
 
 */
 
drivers/scsi/aha152x.c +2 -2
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/aha152x.c linux-2.5.7-scsi-doc/drivers/scsi/aha152x.c
@@ -211,7 +211,7 @@
  *
  **************************************************************************
  
- see README.aha152x for configuration details
+ see Documentation/scsi/aha152x.txt for configuration details
 
  **************************************************************************/
 
@@ -1834,7 +1834,7 @@
 				       "aha152x: unable to verify geometry for disk with >1GB.\n"
 				       "         Using default translation. Please verify yourself.\n"
 				       "         Perhaps you need to enable extended translation in the driver.\n"
-				       "         See /usr/src/linux/drivers/scsi/README.aha152x for details.\n");
+				       "         See /usr/src/linux/Documentation/scsi/aha152x.txt for details.\n");
 			}
 		} else {
 			info_array[0] = info[0];
drivers/scsi/aic7xxx/aic7xxx_linux.c +1 -1
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/aic7xxx/aic7xxx_linux.c linux-2.5.7-scsi-doc/drivers/scsi/aic7xxx/aic7xxx_linux.c
@@ -1076,7 +1076,7 @@
 		aic7xxx_setup(aic7xxx);
 	if (dummy_buffer[0] != 'P')
 		printk(KERN_WARNING
-"aic7xxx: Please read the file /usr/src/linux/drivers/scsi/README.aic7xxx\n"
+"aic7xxx: Please read the file /usr/src/linux/Documentation/scsi/aic7xxx.txt\n"
 "aic7xxx: to see the proper way to specify options to the aic7xxx module\n"
 "aic7xxx: Specifically, don't use any commas when passing arguments to\n"
 "aic7xxx: insmod or else it might trash certain memory areas.\n");
drivers/scsi/aic7xxx_old.c +2 -2
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/aic7xxx_old.c linux-2.5.7-scsi-doc/drivers/scsi/aic7xxx_old.c
@@ -9487,8 +9487,8 @@
   if(aic7xxx)
     aic7xxx_setup(aic7xxx);
   if(dummy_buffer[0] != 'P')
-    printk(KERN_WARNING "aic7xxx: Please read the file /usr/src/linux/drivers"
-      "/scsi/README.aic7xxx\n"
+    printk(KERN_WARNING "aic7xxx: Please read the file /usr/src/linux"
+      "Documentation/scsi/aic7xxx_old.txt\n"
       "aic7xxx: to see the proper way to specify options to the aic7xxx "
       "module\n"
       "aic7xxx: Specifically, don't use any commas when passing arguments to\n"
drivers/scsi/dpt/dpti_ioctl.h +2 -1
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/dpt/dpti_ioctl.h linux-2.5.7-scsi-doc/drivers/scsi/dpt/dpti_ioctl.h
@@ -5,7 +5,8 @@
     copyright            : (C) 2001 by Adaptec
     email                : [email protected]
 
-    See README.dpti for history, notes, license info, and credits
+    See Documentation/scsi/dpti.txt for history, notes, license info and
+    credits
  ***************************************************************************/
 
 /***************************************************************************
drivers/scsi/dpt_i2o.c +2 -1
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/dpt_i2o.c linux-2.5.7-scsi-doc/drivers/scsi/dpt_i2o.c
@@ -8,7 +8,8 @@
     			   July 30, 2001 First version being submitted
 			   for inclusion in the kernel.  V2.4
 
-    See README.dpti for history, notes, license info, and credits
+    See Documentation/scsi/dpti.txt for history, notes, license info and
+    credits
  ***************************************************************************/
 
 /***************************************************************************
drivers/scsi/dpti.h +2 -1
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/dpti.h linux-2.5.7-scsi-doc/drivers/scsi/dpti.h
@@ -5,7 +5,8 @@
     copyright            : (C) 2001 by Adaptec
     email                : [email protected]
 
-    See README.dpti for history, notes, license info, and credits
+    See Documentation/scsi/dpti.txt for history, notes, license info and
+    credits
  ***************************************************************************/
 
 /***************************************************************************
drivers/scsi/ibmmca.c +2 -2
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/ibmmca.c linux-2.5.7-scsi-doc/drivers/scsi/ibmmca.c
@@ -4,8 +4,8 @@
  Copyright (c) 1995 Strom Systems, Inc. under the terms of the GNU
  General Public License. Written by Martin Kolinek, December 1995.
  Further development by: Chris Beauregard, Klaus Kudielka, Michael Lang
- See the file README.ibmmca for a detailed description of this driver,
- the commandline arguments and the history of its development.
+ See the file Documentation/scsi/ibmmca.txt for a detailed description of
+ this driver, the commandline arguments and the history of its development.
  See the WWW-page: http://www.uni-mainz.de/~langm000/linux.html for latest
  updates, info and ADF-files for adapters supported by this driver.
 */
drivers/scsi/ibmmca.h +4 -3
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/ibmmca.h linux-2.5.7-scsi-doc/drivers/scsi/ibmmca.h
@@ -1,8 +1,9 @@
 /* 
  * Low Level Driver for the IBM Microchannel SCSI Subsystem
- * (Headerfile, see README.ibmmca for description of the IBM MCA SCSI-driver
- * For use under the GNU General Public License within the Linux-kernel project.
- * This include file works only correctly with kernel 2.4.0 or higher!!! */
+ * (Headerfile, see Documentation/scsi/ibmmca.txt for description of the
+ * IBM MCA SCSI-driver For use under the GNU General Public License within
+ * the Linux-kernel project. This include file works only correctly with
+ * kernel 2.4.0 or higher!!! */
 
 #ifndef _IBMMCA_H
 #define _IBMMCA_H
drivers/scsi/ncr53c8xx.c +1 -1
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/ncr53c8xx.c linux-2.5.7-scsi-doc/drivers/scsi/ncr53c8xx.c
@@ -1625,7 +1625,7 @@
 	**	Possible data corruption during Memory Write and Invalidate.
 	**	This work-around resets the addressing logic prior to the 
 	**	start of the first MOVE of a DATA IN phase.
-	**	(See README.ncr53c8xx for more information)
+	**	(See Documentation/scsi/ncr53c8xx.txt for more information)
 	*/
 	SCR_JUMPR ^ IFFALSE (IF (SCR_DATA_IN)),
 		20,
drivers/scsi/osst.c +1 -1
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/osst.c linux-2.5.7-scsi-doc/drivers/scsi/osst.c
@@ -1,6 +1,6 @@
 /*
   SCSI Tape Driver for Linux version 1.1 and newer. See the accompanying
-  file README.st for more information.
+  file Documentation/scsi/st.txt for more information.
 
   History:
 
drivers/scsi/qla1280.c +2 -2
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/qla1280.c linux-2.5.7-scsi-doc/drivers/scsi/qla1280.c
@@ -776,8 +776,8 @@
     if(options)
         qla1280_setup(options, NULL);
     if(dummy_buffer[0] != 'P')
-        printk(KERN_WARNING "qla1280: Please read the file /usr/src/linux/drivers"
-                "/scsi/README.qla1280\n"
+        printk(KERN_WARNING "qla1280: Please read the file /usr/src/linux"
+                "/Documentation/scsi/qla1280.txt\n"
                 "qla1280: to see the proper way to specify options to the qla1280 "
                 "module\n"
                 "qla1280: Specifically, don't use any commas when passing arguments to\n"
drivers/scsi/st.c +2 -2
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/st.c linux-2.5.7-scsi-doc/drivers/scsi/st.c
@@ -1,6 +1,6 @@
 /*
    SCSI Tape Driver for Linux version 1.1 and newer. See the accompanying
-   file README.st for more information.
+   file Documentation/scsi/st.txt for more information.
 
    History:
    Rewritten from Dwayne Forsyth's SCSI tape driver by Kai Makisara.
@@ -3638,7 +3638,7 @@
 }
 
 #ifndef MODULE
-/* Set the boot options. Syntax is defined in README.st.
+/* Set the boot options. Syntax is defined in Documentation/scsi/st.txt.
  */
 static int __init st_setup(char *str)
 {
drivers/scsi/tmscsim.c +3 -2
diff -Naur linux-2.5.7-scsi-doc-moved/drivers/scsi/tmscsim.c linux-2.5.7-scsi-doc/drivers/scsi/tmscsim.c
@@ -5,7 +5,8 @@
  *		     Bus Master Host Adapter			       *
  * (C)Copyright 1995-1996 Tekram Technology Co., Ltd.		       *
  ***********************************************************************/
-/* (C) Copyright: put under GNU GPL in 10/96  (see README.tmscsim)	*
+/* (C) Copyright: put under GNU GPL in 10/96				*
+ *			(see Documentation/scsi/tmscsim.txt)		*
 *************************************************************************/
 /* $Id: tmscsim.c,v 2.60.2.30 2000/12/20 01:07:12 garloff Exp $		*/
 /*	Enhancements and bugfixes by					*
@@ -1523,7 +1524,7 @@
     DC390_write32 (DMA_ScsiBusCtrl, EN_INT_ON_PCI_ABORT);
     PDEVSET1; PCI_READ_CONFIG_WORD(PDEV, PCI_STATUS, &pstat);
     printk ("DC390: Register dump: PCI Status: %04x\n", pstat);
-    printk ("DC390: In case of driver trouble read linux/drivers/scsi/README.tmscsim\n");
+    printk ("DC390: In case of driver trouble read linux/Documentation/scsi/tmscsim.txt\n");
 };