public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
* [RFC] Clean up scsi documentation
@ 2002-11-09 22:01 Rolf Eike Beer
  0 siblings, 0 replies; 2+ messages in thread
From: Rolf Eike Beer @ 2002-11-09 22:01 UTC (permalink / raw)
  To: linux-kernel

Hi,

currently the documentation for scsi is not completely located where it should 
IMHO be: in Documentation/

There are a few files in Documentation and much more files in drivers/scsi/ . 
I think this should be fixed. Any thougts?

My way would be:

1) create a directory Documentation/scsi/
2) move everything to this location
3) rename some of the docs (currently the names look like "README.drivername" 
but "drivername.txt" is more common in Documentation/*)
4) fix up the references
5) add a 00-INDEX file to Documentation/scsi

Linus, Marcello: would you apply such a patch? In which form would you like to 
get them? One big patch? One patch that moves the files and one to fix the 
references? A patch to move the files and a patch for the references?

I found also some minor bugs in some docs: trailing newlines, strange 
characters etc. This will be an extra patch.

Eike

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [RFC] Clean up scsi documentation
@ 2002-11-09 22:49 Douglas Gilbert
  0 siblings, 0 replies; 2+ messages in thread
From: Douglas Gilbert @ 2002-11-09 22:49 UTC (permalink / raw)
  To: linux-kernel; +Cc: linux-scsi, Rolf Eike Beer

Eike Beer <eike@bilbo.math.uni-mannheim.de> wrote:
 > currently the documentation for scsi is not completely located
 > where it should IMHO be: in Documentation/
 >
 > There are a few files in Documentation and much more files in
 > drivers/scsi/ .
 > I think this should be fixed. Any thougts?
 >
 > My way would be:
 >
 > 1) create a directory Documentation/scsi/
 > 2) move everything to this location
 > 3) rename some of the docs (currently the names look
 > like "README.drivername"
 > but "drivername.txt" is more common in Documentation/*)
 > 4) fix up the references
 > 5) add a 00-INDEX file to Documentation/scsi
<snip/>

Yes, this would be a positive step and has been proposed by
others on the linux-scsi list. It may be a bit late for the
2.4 series but the time would be right for the 2.5 series.

James Bottomley <James.Bottomley@steeleye.com> and Doug Ledford
<dledford@redhat.com> are maintaining BK repositories for the
scsi subsystem in the 2.5 series. If you could submit your
patches to them, then they will find their way to Linus
in an orderly fashion.

Doug Gilbert



^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2002-11-09 22:44 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2002-11-09 22:49 [RFC] Clean up scsi documentation Douglas Gilbert
  -- strict thread matches above, loose matches on Subject: below --
2002-11-09 22:01 Rolf Eike Beer

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox