2002-03-21 07:36:01

by Rolf Eike Beer

[permalink] [raw]
Subject: [PATCH] 2.5.7 Documentation/00-INDEX

This patch updates Documentation/00-INDEX. It removes some lines describing
files that have been removed/moved to subdirectories. Also it adds some lines
on new files/directories.

Eike

--- linux-2.5.7/Documentation/00-INDEX.orig Thu Mar 21 08:04:54 2002
+++ linux-2.5.7/Documentation/00-INDEX Thu Mar 21 08:29:08 2002
@@ -12,14 +12,14 @@

00-INDEX
- this file.
+BK-usage/
+ - directory with info on BitKeeper.
BUG-HUNTING
- brute force method of doing binary search of patches to find bug.
Changes
- list of changes that break older software packages.
CodingStyle
- how the boss likes the C code in the kernel to look.
-Configure.help
- - text file that is used for help when you run "make config"
DMA-mapping.txt
- info for PCI drivers using DMA portably across all platforms.
DocBook/
@@ -34,6 +34,10 @@
- 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
- procedure to get a new driver source included into the kernel tree.
SubmittingPatches
@@ -44,6 +48,8 @@
- directory with info about Linux on the ARM architecture.
binfmt_misc.txt
- info on the kernel support for extra binary formats.
+block/
+ - info on the Block I/O (BIO) layer.
cachetlb.txt
- describes the cache/TLB flushing interfaces Linux uses.
cciss.txt
@@ -54,6 +60,8 @@
- info on Computone Intelliport II/Plus Multiport Serial Driver
cpqarray.txt
- info on using Compaq's SMART2 Intelligent Disk Array Controllers.
+cris/
+ - directory with info about Linux on CRIS architecture.
devices.txt
- plain ASCII listing of all the nodes in /dev/ with major minor #'s
digiboard.txt
@@ -62,6 +70,8 @@
- info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
dnotify.txt
- info about directory notification in Linux.
+driver.txt
+ - info about Linux driver modell.
exception.txt
- how Linux v2.2 handles exceptions without verify_area etc.
fb/
@@ -80,12 +90,16 @@
- directory with info about the I2C bus/protocol (2 wire, kHz speed)
i386/
- directory with info about Linux on intel 32 bit architecture.
+i810_rng.txt
+ - info on Linux support for random number generator in i8xx chipsets.
ia64/
- directory with info about Linux on intel 64 bit architecture.
ide.txt
- important info for users of ATA devices (IDE/EIDE disks and CD-ROMS)
initrd.txt
- how to use the RAM disk as an initial/temporary root filesystem.
+input/
+ - info on Linux input device support.
ioctl-number.txt
- how to implement and register device/driver ioctl calls.
isapnp.txt
@@ -94,12 +108,6 @@
- directory with info on the Linux ISDN support, and supported cards.
java.txt
- info on the in-kernel binary support for Java(tm)
-joystick-api.txt
- - API specification for applications that will be using the joystick.
-joystick-parport.txt
- - info on how to hook joysticks/gamepads to the parallel port.
-joystick.txt
- - info on using joystick devices (and driver) with Linux.
kbuild/
- directory with info about the kernel build process
kernel-doc-nano-HOWTO.txt
@@ -128,6 +136,8 @@
- info on boot arguments for the multiple devices driver
memory.txt
- info on typical Linux memory problems.
+mips/
+ - directory with info about Linux on MIPS architecture.
mkdev.cciss
- script to make /dev entries for SMART controllers (see cciss.txt)
mkdev.ida
@@ -161,9 +171,13 @@
pcwd-watchdog.txt
- info and sample code for using with the PC Watchdog reset card.
pm.txt
- - info on Linux power management support
+ - info on Linux power management support.
+power/
+ - directory with info on Linux PCI Powermanagement.
powerpc/
- directory with info on using Linux with the PowerPC.
+preempt-locking.txt
+ - info on locking under a preemptive kernel.
ramdisk.txt
- short guide on how to set up and use the RAM disk.
riscom8.txt
@@ -172,6 +186,8 @@
- notes on how to use the Real Time Clock (aka CMOS clock) driver.
s390/
- 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
@@ -186,6 +202,8 @@
- LaTeX document describing implementation of Multiprocessor Linux
smp.txt
- a few more notes on symmetric multi-processing
+sonypi.txt
+ - info on Linux Sony Programmable I/O Device support.
sound/
- directory with info on sound card support
sparc/
@@ -216,6 +234,8 @@
- directory with info on the Linux vm code.
watchdog.txt
- how to auto-reboot Linux if it has "fallen and can't get up". ;-)
+x86_64/
+ - directory with info on Linux support for 64 bit x86 machines.
xterm-linux.xpm
- XPM image of penguin logo (see logo.txt) sitting on an xterm.
zorro.txt


2002-03-21 08:12:36

by Andreas Jaeger

[permalink] [raw]
Subject: Re: [PATCH] 2.5.7 Documentation/00-INDEX

Rolf Eike Beer <[email protected]> writes:

> This patch updates Documentation/00-INDEX. It removes some lines describing
> files that have been removed/moved to subdirectories. Also it adds some lines
> on new files/directories.
>
> Eike
>
> --- linux-2.5.7/Documentation/00-INDEX.orig Thu Mar 21 08:04:54 2002
> +++ linux-2.5.7/Documentation/00-INDEX Thu Mar 21 08:29:08 2002

[..]
> +x86_64/
> + - directory with info on Linux support for 64 bit x86 machines.

x86-64 is it's own archtitecture, please don't call it 64 bit x86
machines. Just write:
directory with info on Linux support for AMD x86-64 (Hammer) machines.

Andreas
--
Andreas Jaeger
SuSE Labs [email protected]
private [email protected]
http://www.suse.de/~aj

2002-03-21 08:22:47

by Rolf Eike Beer

[permalink] [raw]
Subject: Re: [PATCH] 2.5.7 Documentation/00-INDEX

Am Thursday 21 March 2002 09:12 schrieben Sie:
> Rolf Eike Beer <[email protected]> writes:
> > This patch updates Documentation/00-INDEX. It removes some lines
> > describing files that have been removed/moved to subdirectories. Also it
> > adds some lines on new files/directories.

> > +x86_64/
> > + - directory with info on Linux support for 64 bit x86 machines.
>
> x86-64 is it's own archtitecture, please don't call it 64 bit x86
> machines. Just write:
> directory with info on Linux support for AMD x86-64 (Hammer) machines.

Done. Here is the new patch.

Eike

--- linux-2.5.7/Documentation/00-INDEX.orig Thu Mar 21 08:04:54 2002
+++ linux-2.5.7/Documentation/00-INDEX Thu Mar 21 09:20:57 2002
@@ -12,14 +12,14 @@

00-INDEX
- this file.
+BK-usage/
+ - directory with info on BitKeeper.
BUG-HUNTING
- brute force method of doing binary search of patches to find bug.
Changes
- list of changes that break older software packages.
CodingStyle
- how the boss likes the C code in the kernel to look.
-Configure.help
- - text file that is used for help when you run "make config"
DMA-mapping.txt
- info for PCI drivers using DMA portably across all platforms.
DocBook/
@@ -34,6 +34,10 @@
- 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
- procedure to get a new driver source included into the kernel tree.
SubmittingPatches
@@ -44,6 +48,8 @@
- directory with info about Linux on the ARM architecture.
binfmt_misc.txt
- info on the kernel support for extra binary formats.
+block/
+ - info on the Block I/O (BIO) layer.
cachetlb.txt
- describes the cache/TLB flushing interfaces Linux uses.
cciss.txt
@@ -54,6 +60,8 @@
- info on Computone Intelliport II/Plus Multiport Serial Driver
cpqarray.txt
- info on using Compaq's SMART2 Intelligent Disk Array Controllers.
+cris/
+ - directory with info about Linux on CRIS architecture.
devices.txt
- plain ASCII listing of all the nodes in /dev/ with major minor #'s
digiboard.txt
@@ -62,6 +70,8 @@
- info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
dnotify.txt
- info about directory notification in Linux.
+driver.txt
+ - info about Linux driver modell.
exception.txt
- how Linux v2.2 handles exceptions without verify_area etc.
fb/
@@ -80,12 +90,16 @@
- directory with info about the I2C bus/protocol (2 wire, kHz speed)
i386/
- directory with info about Linux on intel 32 bit architecture.
+i810_rng.txt
+ - info on Linux support for random number generator in i8xx chipsets.
ia64/
- directory with info about Linux on intel 64 bit architecture.
ide.txt
- important info for users of ATA devices (IDE/EIDE disks and CD-ROMS)
initrd.txt
- how to use the RAM disk as an initial/temporary root filesystem.
+input/
+ - info on Linux input device support.
ioctl-number.txt
- how to implement and register device/driver ioctl calls.
isapnp.txt
@@ -94,12 +108,6 @@
- directory with info on the Linux ISDN support, and supported cards.
java.txt
- info on the in-kernel binary support for Java(tm)
-joystick-api.txt
- - API specification for applications that will be using the joystick.
-joystick-parport.txt
- - info on how to hook joysticks/gamepads to the parallel port.
-joystick.txt
- - info on using joystick devices (and driver) with Linux.
kbuild/
- directory with info about the kernel build process
kernel-doc-nano-HOWTO.txt
@@ -128,6 +136,8 @@
- info on boot arguments for the multiple devices driver
memory.txt
- info on typical Linux memory problems.
+mips/
+ - directory with info about Linux on MIPS architecture.
mkdev.cciss
- script to make /dev entries for SMART controllers (see cciss.txt)
mkdev.ida
@@ -161,9 +171,13 @@
pcwd-watchdog.txt
- info and sample code for using with the PC Watchdog reset card.
pm.txt
- - info on Linux power management support
+ - info on Linux power management support.
+power/
+ - directory with info on Linux PCI Powermanagement.
powerpc/
- directory with info on using Linux with the PowerPC.
+preempt-locking.txt
+ - info on locking under a preemptive kernel.
ramdisk.txt
- short guide on how to set up and use the RAM disk.
riscom8.txt
@@ -172,6 +186,8 @@
- notes on how to use the Real Time Clock (aka CMOS clock) driver.
s390/
- 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
@@ -186,6 +202,8 @@
- LaTeX document describing implementation of Multiprocessor Linux
smp.txt
- a few more notes on symmetric multi-processing
+sonypi.txt
+ - info on Linux Sony Programmable I/O Device support.
sound/
- directory with info on sound card support
sparc/
@@ -216,6 +234,8 @@
- directory with info on the Linux vm code.
watchdog.txt
- how to auto-reboot Linux if it has "fallen and can't get up". ;-)
+x86_64/
+ - directory with info on Linux support for AMD x86-64 (Hammer) machines.
xterm-linux.xpm
- XPM image of penguin logo (see logo.txt) sitting on an xterm.
zorro.txt

2002-03-21 14:00:23

by Mr. James W. Laferriere

[permalink] [raw]
Subject: Re: [PATCH] 2.5.7 Documentation/00-INDEX


Hello Rolf & all ,

On Thu, 21 Mar 2002, Rolf Eike Beer wrote:
> Am Thursday 21 March 2002 09:12 schrieben Sie:
> > Rolf Eike Beer <[email protected]> writes:

> -Configure.help
> - - text file that is used for help when you run "make config"
Why are we loosing the help file ?
What are we replacing it with ? Tia , JimL


+------------------------------------------------------------------+
| James W. Laferriere | System Techniques | Give me VMS |
| Network Engineer | P.O. Box 854 | Give me Linux |
| [email protected] | Coudersport PA 16915 | only on AXP |
+------------------------------------------------------------------+

2002-03-21 15:38:46

by Steven Cole

[permalink] [raw]
Subject: Re: [PATCH] 2.5.7 Documentation/00-INDEX

On Thu, 2002-03-21 at 06:58, Mr. James W. Laferriere wrote:
>
> Hello Rolf & all ,
>
> On Thu, 21 Mar 2002, Rolf Eike Beer wrote:
> > Am Thursday 21 March 2002 09:12 schrieben Sie:
> > > Rolf Eike Beer <[email protected]> writes:
>
> > -Configure.help
> > - - text file that is used for help when you run "make config"
> Why are we loosing the help file ?
> What are we replacing it with ? Tia , JimL

The Documentation/Configure.help file has been replaced with 107
Config.help files in 2.5.7 (109 files in 2.5.7-dj1). Do this:

find . -name Config.help

Steven


2002-03-22 13:46:08

by Paul Gortmaker

[permalink] [raw]
Subject: Re: [PATCH] 2.5.7 Documentation/00-INDEX

Rolf Eike Beer wrote:
>
> This patch updates Documentation/00-INDEX. It removes some lines describing
> files that have been removed/moved to subdirectories. Also it adds some lines
> on new files/directories.
>
> Eike

Hey, thanks. In case you haven't automated this check already, see my $0.02
script attached below that I try to run over 00-INDEX every now and again.

> +driver.txt
> + - info about Linux driver modell.

Should be driver-model.txt IIRC, and s/ll/l/ too.

Paul.
--

#!/bin/sh
# For keeping an eye on 00-INDEX files in the linux/Documentation/ dir.

echo Checking for unreferenced files...
for i in *
do
grep -q $i 00-INDEX
if [ $? = 1 ];then
echo $i is not in 00-INDEX
fi
done

echo -------------------------------------------

echo Checking for orphaned entries...

for i in `awk '/^\t- / {print FNR-1}' 00-INDEX`
do
FNAME=`awk FNR==$i 00-INDEX`
if [ ! -e "$FNAME" ];then
echo $FNAME is in 00-INDEX but does not exist
fi
done

echo Done.