[PATCH 0/2] clean up scsi documentation

[PATCH 0/2] clean up scsi documentation

[Rolf Eike Beer]

Hi,

here are my patches to clean up the scsi documentation. It is split in three
parts:

0) Do the work. A small script that does the following things:
-create Documentation/scsi/
-move all the scsi documentation from Documentation/ and drivers/scsi/ to this
location
-kill ChangeLog.serverraid. It's a duplication from ChangeLog.ips but is
missing some bits (got ok from maintainer to do this)
-rename README.drivername to drivername.txt which is more common in
Documentation/*
NOTE: start this script on the top level of the source tree (/usr/src/linux or
whereever you put it).

1) Fix up references. A patch doing the following:
-fix up all the references (hope I got them all)
-introduce Documentation/scsi/00-INDEX

2) Clean up. Just a bit cosmetics:
-kill unneeded trailing new lines
-kill one not-ascii character from FlashPoint.txt
-kill unneeded patch instruction from cpqfc.txt: noone needs this because the
driver is already in the kernel as everybody can see.

Eike

PS: please CC me, I'm not on this list and I'm only reading this via google
sometimes.

---------Here we go: the script----------
#!/bin/bash

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

Re: [PATCH 0/2] clean up scsi documentation

[Christoph Hellwig]

On Mon, Nov 11, 2002 at 04:33:55PM +0100, Rolf Eike Beer wrote:
> Hi,
> 
> here are my patches to clean up the scsi documentation. It is split in three
> parts:
> 
> 0) Do the work. A small script that does the following things:
> -create Documentation/scsi/
> -move all the scsi documentation from Documentation/ and drivers/scsi/ to this
> location
> -kill ChangeLog.serverraid. It's a duplication from ChangeLog.ips but is
> missing some bits (got ok from maintainer to do this)
> -rename README.drivername to drivername.txt which is more common in
> Documentation/*
> NOTE: start this script on the top level of the source tree (/usr/src/linux or
> whereever you put it).
> 
> 1) Fix up references. A patch doing the following:
> -fix up all the references (hope I got them all)
> -introduce Documentation/scsi/00-INDEX
> 
> 2) Clean up. Just a bit cosmetics:
> -kill unneeded trailing new lines
> -kill one not-ascii character from FlashPoint.txt
> -kill unneeded patch instruction from cpqfc.txt: noone needs this because the
> driver is already in the kernel as everybody can see.

Sounds good to me.  Would be nice to separate the steps so BK notices
the file moves and keeps history.

Re: [PATCH 0/2] clean up scsi documentation

[Rolf Eike Beer]

> > here are my patches to clean up the scsi documentation. It is split in
> > three parts:

[...]

> Sounds good to me.  Would be nice to separate the steps so BK notices
> the file moves and keeps history.

Ok. What would be the best way of doing this? Move the files one by one? One 
patch per file? Or a better script?

Eike

Re: [PATCH 0/2] clean up scsi documentation

[Christoph Hellwig]

On Mon, Nov 11, 2002 at 04:50:06PM +0100, Rolf Eike Beer wrote:
> > > here are my patches to clean up the scsi documentation. It is split in
> > > three parts:
> 
> [...]
> 
> > Sounds good to me.  Would be nice to separate the steps so BK notices
> > the file moves and keeps history.
> 
> Ok. What would be the best way of doing this? Move the files one by one? One 
> patch per file? Or a better script?

Let some BK user (e.g. james or me) do the move and then apply your fixup
patches.  We can do all moves as one cset without problems.

Re: [PATCH 0/2] clean up scsi documentation

[Rolf Eike Beer]

> > > > here are my patches to clean up the scsi documentation. It is split
> > > > in three parts:
> >
> > [...]
> >
> > > Sounds good to me.  Would be nice to separate the steps so BK notices
> > > the file moves and keeps history.
> >
> > Ok. What would be the best way of doing this? Move the files one by one?
> > One patch per file? Or a better script?
>
> Let some BK user (e.g. james or me) do the move and then apply your fixup
> patches.  We can do all moves as one cset without problems.

That's why I sent them here. Or did I misunderstood you, Douglas?

Please do it.

Eike

Re: [PATCH 0/2] clean up scsi documentation

[J.E.J. Bottomley]

eike@bilbo.math.uni-mannheim.de said:
> Ok. What would be the best way of doing this? Move the files one by
> one? One  patch per file? Or a better script? 

I've already converted this to a BK script and applied it.

Except for the removal of ChangeLog.serverraid (I renamed this ChangeLog.ips).

James

Re: [PATCH 0/2] clean up scsi documentation

[Rolf Eike Beer]

Am Montag, 11. November 2002 16:58 schrieb J.E.J. Bottomley:
> eike@bilbo.math.uni-mannheim.de said:
> > Ok. What would be the best way of doing this? Move the files one by
> > one? One  patch per file? Or a better script?
>
> I've already converted this to a BK script and applied it.
>
> Except for the removal of ChangeLog.serverraid (I renamed this
> ChangeLog.ips).

I asked someone from Adaptec some time ago and he said this one is obsolete. 
Can you explain me the idea behind this?

Thanks,

Eike