From 56d7e6f454f68438b28ced680c87e59d4fb94f28 Mon Sep 17 00:00:00 2001 From: Andrew Morton Date: Mon, 29 Dec 2003 23:49:36 -0800 Subject: [PATCH] [PATCH] Fix 2.6.0's broken documentation references From: Hans Ulrich Niedermann I've noted that 2.6.0 contains broken references to documentation. I got sufficiently annoyed chasing doc files in the wrong place that I wrote a script to check the references to documentation files. Some documentation files have moved (e.g. Documentation/modules.txt to Documentation/kbuild/modules.txt). I adapted the references with a script. --- Documentation/block/biodoc.txt | 4 ++-- Documentation/fb/aty128fb.txt | 2 +- Documentation/fb/matroxfb.txt | 2 +- Documentation/input/input.txt | 2 +- Documentation/kbuild/modules.txt | 2 +- Documentation/kernel-parameters.txt | 2 +- .../sound/alsa/DocBook/writing-an-alsa-driver.tmpl | 2 +- Documentation/sound/oss/CMI8330 | 2 +- Documentation/sound/oss/INSTALL.awe | 2 +- Documentation/sound/oss/Introduction | 2 +- Documentation/sound/oss/PAS16 | 8 ++++---- Documentation/sound/oss/SoundPro | 2 +- Documentation/sound/oss/Wavefront | 2 +- arch/arm/mach-sa1100/Kconfig | 2 +- arch/m68k/Kconfig | 2 +- arch/mips/Kconfig | 6 +++--- arch/sh/Kconfig | 2 +- arch/x86_64/Kconfig | 2 +- drivers/net/cs89x0.c | 2 +- drivers/net/wan/Kconfig | 4 ++-- drivers/usb/image/scanner.c | 2 +- include/asm-s390/ccwdev.h | 2 +- kernel/power/Kconfig | 2 +- kernel/power/swsusp.c | 2 +- net/bridge/netfilter/Kconfig | 2 +- sound/oss/Kconfig | 2 +- sound/oss/dmasound/Kconfig | 8 ++++---- sound/oss/vwsnd.c | 2 +- 28 files changed, 38 insertions(+), 38 deletions(-) diff --git a/Documentation/block/biodoc.txt b/Documentation/block/biodoc.txt index 13691ba9967d3..f24dbcaca4927 100644 --- a/Documentation/block/biodoc.txt +++ b/Documentation/block/biodoc.txt @@ -323,7 +323,7 @@ involved. In the latter case, the driver would modify and manage the request->buffer, request->sector and request->nr_sectors or request->current_nr_sectors fields itself rather than using the block layer end_request or end_that_request_first completion interfaces. -(See 2.3 or Documentation/bio/request.txt for a brief explanation of +(See 2.3 or Documentation/block/request.txt for a brief explanation of the request structure fields) [TBD: end_that_request_last should be usable even in this case; @@ -517,7 +517,7 @@ request structure. Only some relevant fields (mainly those which changed or may be referred to in some of the discussion here) are listed below, not necessarily in the order in which they occur in the structure (see include/linux/blkdev.h) -Refer to Documentation/bio/request.txt for details about all the request +Refer to Documentation/block/request.txt for details about all the request structure fields and a quick reference about the layers which are supposed to use or modify those fields. diff --git a/Documentation/fb/aty128fb.txt b/Documentation/fb/aty128fb.txt index 3382565909141..069262fb619df 100644 --- a/Documentation/fb/aty128fb.txt +++ b/Documentation/fb/aty128fb.txt @@ -32,7 +32,7 @@ resolutions. You should compile in both vgacon (to boot if you remove your Rage128 from box) and aty128fb (for graphics mode). You should not compile-in vesafb unless you have primary display on non-Rage128 VBE2.0 device (see -Documentation/vesafb.txt for details). +Documentation/fb/vesafb.txt for details). X11 diff --git a/Documentation/fb/matroxfb.txt b/Documentation/fb/matroxfb.txt index 2747d59881eb5..621e3b3e40df3 100644 --- a/Documentation/fb/matroxfb.txt +++ b/Documentation/fb/matroxfb.txt @@ -31,7 +31,7 @@ pass to the kernel this command line: "video=matroxfb:vesa:0x1BB". You should compile in both vgacon (to boot if you remove you Matrox from box) and matroxfb (for graphics mode). You should not compile-in vesafb unless you have primary display on non-Matrox VBE2.0 device (see -Documentation/vesafb.txt for details). +Documentation/fb/vesafb.txt for details). Currently supported video modes are (through vesa:... interface, PowerMac has [as addon] compatibility code): diff --git a/Documentation/input/input.txt b/Documentation/input/input.txt index 6e081453414b8..a2aef3619789a 100644 --- a/Documentation/input/input.txt +++ b/Documentation/input/input.txt @@ -255,7 +255,7 @@ driver. is also emulated, characters should appear if you move it. You can test the joystick emulation with the 'jstest' utility, -available in the joystick package (see Documentation/joystick.txt). +available in the joystick package (see Documentation/input/joystick.txt). You can test the event devices with the 'evtest' utility available in the LinuxConsole project CVS archive (see the URL below). diff --git a/Documentation/kbuild/modules.txt b/Documentation/kbuild/modules.txt index e9b3f0250f1f0..bcda6f42fe85d 100644 --- a/Documentation/kbuild/modules.txt +++ b/Documentation/kbuild/modules.txt @@ -1,4 +1,4 @@ -For now this is a raw copy from the old Documentation/modules.txt, +For now this is a raw copy from the old Documentation/kbuild/modules.txt, which was removed in 2.6.0-test5. The information herein is correct but not complete. diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt index 4ecee95067bdd..46b80e3ce0e2c 100644 --- a/Documentation/kernel-parameters.txt +++ b/Documentation/kernel-parameters.txt @@ -1150,7 +1150,7 @@ running once the system is up. See header of drivers/scsi/wd7000.c. wdt= [WDT] Watchdog - See Documentation/watchdog.txt. + See Documentation/watchdog/watchdog.txt. xd= [HW,XT] Original XT pre-IDE (RLL encoded) disks. xd_geo= See header of drivers/block/xd.c. diff --git a/Documentation/sound/alsa/DocBook/writing-an-alsa-driver.tmpl b/Documentation/sound/alsa/DocBook/writing-an-alsa-driver.tmpl index c2c3d8d7b4b49..37a82e9597195 100644 --- a/Documentation/sound/alsa/DocBook/writing-an-alsa-driver.tmpl +++ b/Documentation/sound/alsa/DocBook/writing-an-alsa-driver.tmpl @@ -3623,7 +3623,7 @@ struct _snd_pcm_runtime { More precise information can be found in - alsa-kernel/Documentation/ControlNames.txt. + alsa-kernel/Documentation/sound/alsa/ControlNames.txt. diff --git a/Documentation/sound/oss/CMI8330 b/Documentation/sound/oss/CMI8330 index 28779988406a5..add986ddec2d2 100644 --- a/Documentation/sound/oss/CMI8330 +++ b/Documentation/sound/oss/CMI8330 @@ -2,7 +2,7 @@ Documentation for CMI 8330 (SoundPRO) ------------------------------------- Alessandro Zummo -( Be sure to read Documentation/sound/SoundPro too ) +( Be sure to read Documentation/sound/oss/SoundPro too ) This adapter is now directly supported by the sb driver. diff --git a/Documentation/sound/oss/INSTALL.awe b/Documentation/sound/oss/INSTALL.awe index 72219acb27906..3bf7861acb191 100644 --- a/Documentation/sound/oss/INSTALL.awe +++ b/Documentation/sound/oss/INSTALL.awe @@ -114,7 +114,7 @@ See INSTALL.RH for more details. # insmod awe_wave (Be sure to load awe_wave after sb!) - See /usr/src/linux/Documentation/sound/AWE32 for + See /usr/src/linux/Documentation/sound/oss/AWE32 for more details. 9. (only for obsolete systems) If you don't have /dev/sequencer diff --git a/Documentation/sound/oss/Introduction b/Documentation/sound/oss/Introduction index 3e649dc173c4b..a267792b8ec6f 100644 --- a/Documentation/sound/oss/Introduction +++ b/Documentation/sound/oss/Introduction @@ -24,7 +24,7 @@ History: ======== 0.1.0 11/20/1998 First version, draft 1.0.0 11/1998 Alan Cox changes, incorporation in 2.2.0 - as /usr/src/linux/Documentation/sound/Introduction + as /usr/src/linux/Documentation/sound/oss/Introduction 1.1.0 6/30/1999 Second version, added notes on making the drivers, added info on multiple sound cards of similar types,] added more diagnostics info, added info about esd. diff --git a/Documentation/sound/oss/PAS16 b/Documentation/sound/oss/PAS16 index 7a42ad7b66905..0fbf716d81bfd 100644 --- a/Documentation/sound/oss/PAS16 +++ b/Documentation/sound/oss/PAS16 @@ -9,7 +9,7 @@ and others whose names I could not find. This documentation is relevant for the PAS16 driver (pas2_card.c and friends) under kernel version 2.3.99 and later. If you are unfamiliar with configuring sound under Linux, please read the -Sound-HOWTO, linux/Documentation/sound/Introduction and other +Sound-HOWTO, linux/Documentation/sound/oss/Introduction and other relevant docs first. The following information is relevant information from README.OSS @@ -73,8 +73,8 @@ CONFIG_SOUND You want to read the Sound-HOWTO, available from http://www.tldp.org/docs.html#howto . General information about the modular sound system is contained in the files - Documentation/sound/Introduction. The file - Documentation/sound/README.OSS contains some slightly outdated but + Documentation/sound/oss/Introduction. The file + Documentation/sound/oss/README.OSS contains some slightly outdated but still useful information as well. OSS sound modules @@ -119,7 +119,7 @@ CONFIG_SOUND_YM3812 cards may have software (TSR) FM emulation. Enabling FM support with these cards may cause trouble (I don't currently know of any such cards, however). - Please read the file Documentation/sound/OPL3 if your card has an + Please read the file Documentation/sound/oss/OPL3 if your card has an OPL3 chip. If you compile the driver into the kernel, you have to add "opl3=" to the kernel command line. diff --git a/Documentation/sound/oss/SoundPro b/Documentation/sound/oss/SoundPro index 61b9a91973bf9..9d4db1f29d3ce 100644 --- a/Documentation/sound/oss/SoundPro +++ b/Documentation/sound/oss/SoundPro @@ -1,7 +1,7 @@ Documentation for the SoundPro CMI8330 extensions in the WSS driver (ad1848.o) ------------------------------------------------------------------------------ -( Be sure to read Documentation/sound/CMI8330 too ) +( Be sure to read Documentation/sound/oss/CMI8330 too ) Ion Badulescu, ionut@cs.columbia.edu February 24, 1999 diff --git a/Documentation/sound/oss/Wavefront b/Documentation/sound/oss/Wavefront index 803ffd408c2aa..b2389bdcf14f6 100644 --- a/Documentation/sound/oss/Wavefront +++ b/Documentation/sound/oss/Wavefront @@ -105,7 +105,7 @@ design and implementation of the driver. drivers/sound/wf_midi.c -- the "uart401" driver to support virtual MIDI mode. include/wavefront.h -- the header file - Documentation/sound/Tropez+ -- short docs on configuration + Documentation/sound/oss/Tropez+ -- short docs on configuration ********************************************************************** 4) How do I compile/install/use it ? diff --git a/arch/arm/mach-sa1100/Kconfig b/arch/arm/mach-sa1100/Kconfig index f409cb95c50eb..39c13fc3b8246 100644 --- a/arch/arm/mach-sa1100/Kconfig +++ b/arch/arm/mach-sa1100/Kconfig @@ -304,7 +304,7 @@ config SA1100_YOPY depends on ARCH_SA1100 help Say Y here to support the Yopy PDA. Product information at - . See Documentation/arm/SA110/Yopy + . See Documentation/arm/SA1100/Yopy for more. config SA1100_STORK diff --git a/arch/m68k/Kconfig b/arch/m68k/Kconfig index 1663507328084..074b1150d7b06 100644 --- a/arch/m68k/Kconfig +++ b/arch/m68k/Kconfig @@ -1025,7 +1025,7 @@ config WATCHDOG implementation entirely in software (which can sometimes fail to reboot the machine) and a driver for hardware watchdog boards, which are more robust and can also keep track of the temperature inside - your computer. For details, read + your computer. For details, read in the kernel source. The watchdog is usually used together with the watchdog daemon diff --git a/arch/mips/Kconfig b/arch/mips/Kconfig index 277ba41d5cbb0..edb286f9d4837 100644 --- a/arch/mips/Kconfig +++ b/arch/mips/Kconfig @@ -1261,8 +1261,8 @@ config SOUND You want to read the Sound-HOWTO, available from . General information about the modular sound system is contained in the files - . The file - contains some slightly + . The file + contains some slightly outdated but still useful information as well. If you have a PnP sound card and you want to configure it at boot @@ -1270,7 +1270,7 @@ config SOUND ), then you need to compile the sound card support as a module and load that module after the PnP configuration is finished. To do this, choose M here - and read ; the module + and read ; the module will be called soundcore. I'm told that even without a sound card, you can make your computer diff --git a/arch/sh/Kconfig b/arch/sh/Kconfig index 8cf479a497425..e301b1a117b72 100644 --- a/arch/sh/Kconfig +++ b/arch/sh/Kconfig @@ -1053,7 +1053,7 @@ config WATCHDOG implementation entirely in software (which can sometimes fail to reboot the machine) and a driver for hardware watchdog boards, which are more robust and can also keep track of the temperature inside - your computer. For details, read + your computer. For details, read in the kernel source. The watchdog is usually used together with the watchdog daemon diff --git a/arch/x86_64/Kconfig b/arch/x86_64/Kconfig index 55d1c4824a7d5..3226443a42a73 100644 --- a/arch/x86_64/Kconfig +++ b/arch/x86_64/Kconfig @@ -314,7 +314,7 @@ config SOFTWARE_SUSPEND This option is close to getting stable. However there is still some absence of features. - For more information take a look at Documentation/swsusp.txt. + For more information take a look at Documentation/power/swsusp.txt. source "drivers/acpi/Kconfig" diff --git a/drivers/net/cs89x0.c b/drivers/net/cs89x0.c index af8b183799b0b..dd2abd4dc089c 100644 --- a/drivers/net/cs89x0.c +++ b/drivers/net/cs89x0.c @@ -47,7 +47,7 @@ : ) : Don't call netif_wake_queue() in net_send_packet() : Fixed an out-of-mem bug in dma_rx() - : Updated Documentation/cs89x0.txt + : Updated Documentation/networking/cs89x0.txt Andrew Morton : andrewm@uow.edu.au / Kernel 2.3.99-pre1 : Use skb_reserve to longword align IP header (two places) diff --git a/drivers/net/wan/Kconfig b/drivers/net/wan/Kconfig index 1d07059661c49..052864b6f2c2f 100644 --- a/drivers/net/wan/Kconfig +++ b/drivers/net/wan/Kconfig @@ -334,7 +334,7 @@ config WANXL If you want to compile the driver as a module ( = code which can be inserted in and removed from the running kernel whenever you want), - say M here and read . The module + say M here and read . The module will be called wanxl. If unsure, say N here. @@ -467,7 +467,7 @@ config SDLA Say Y here if you need a driver for the Sangoma S502A, S502E, and S508 Frame Relay Access Devices. These are multi-protocol cards, but only frame relay is supported by the driver at this time. Please - read . + read . To compile this driver as a module, choose M here: the module will be called sdla. diff --git a/drivers/usb/image/scanner.c b/drivers/usb/image/scanner.c index 3e914d66dc4a3..1ddfec5a08897 100644 --- a/drivers/usb/image/scanner.c +++ b/drivers/usb/image/scanner.c @@ -282,7 +282,7 @@ * for common error messages rather than the maintainer. * * 0.4.7 11/28/2001 - * - Fixed typo in Documentation/scanner.txt. Thanks to + * - Fixed typo in Documentation/usb/scanner.txt. Thanks to * Karel for pointing it out. * - Added ID's for a Memorex 6136u. Thanks to Álvaro Gaspar de * Valenzuela" . diff --git a/include/asm-s390/ccwdev.h b/include/asm-s390/ccwdev.h index 25dabfd2a596d..f447ac2d193e4 100644 --- a/include/asm-s390/ccwdev.h +++ b/include/asm-s390/ccwdev.h @@ -69,7 +69,7 @@ ccw_device_id_match(const struct ccw_device_id *array, /* The struct ccw device is our replacement for the globally accessible * ioinfo array. ioinfo will mutate into a subchannel device later. * - * Reference: Documentation/driver-model.txt */ + * Reference: Documentation/s390/driver-model.txt */ struct ccw_device { spinlock_t *ccwlock; struct ccw_device_private *private; /* cio private information */ diff --git a/kernel/power/Kconfig b/kernel/power/Kconfig index 48946187c9419..033eea403f26a 100644 --- a/kernel/power/Kconfig +++ b/kernel/power/Kconfig @@ -40,7 +40,7 @@ config SOFTWARE_SUSPEND involved in suspending. Also in this case there is a risk that buffers on disk won't match with saved ones. - For more information take a look at Documentation/swsusp.txt. + For more information take a look at Documentation/power/swsusp.txt. config PM_DISK bool "Suspend-to-Disk Support" diff --git a/kernel/power/swsusp.c b/kernel/power/swsusp.c index 281422d044548..09ae0d3c464d0 100644 --- a/kernel/power/swsusp.c +++ b/kernel/power/swsusp.c @@ -33,7 +33,7 @@ * * More state savers are welcome. Especially for the scsi layer... * - * For TODOs,FIXMEs also look in Documentation/swsusp.txt + * For TODOs,FIXMEs also look in Documentation/power/swsusp.txt */ #include diff --git a/net/bridge/netfilter/Kconfig b/net/bridge/netfilter/Kconfig index 4ed9e04fb1d9e..b0e9f66269ee4 100644 --- a/net/bridge/netfilter/Kconfig +++ b/net/bridge/netfilter/Kconfig @@ -92,7 +92,7 @@ config BRIDGE_EBT_LIMIT equivalent of the iptables limit match. If you want to compile it as a module, say M here and read - . If unsure, say `N'. + . If unsure, say `N'. config BRIDGE_EBT_MARK tristate "ebt: mark filter support" diff --git a/sound/oss/Kconfig b/sound/oss/Kconfig index 5e834833b7fe3..82a0833f29397 100644 --- a/sound/oss/Kconfig +++ b/sound/oss/Kconfig @@ -195,7 +195,7 @@ config SOUND_ES1371 Ensoniq was bought by Creative Labs, Sound Blaster 64/PCI models are either ES1370 or ES1371 based. This driver differs slightly from OSS/Free, so PLEASE READ - . + . config SOUND_ESSSOLO1 tristate "ESS Technology Solo1" diff --git a/sound/oss/dmasound/Kconfig b/sound/oss/dmasound/Kconfig index f7ded6a19607a..0ffb0821618a4 100644 --- a/sound/oss/dmasound/Kconfig +++ b/sound/oss/dmasound/Kconfig @@ -10,7 +10,7 @@ config DMASOUND_ATARI This driver is also available as a module ( = code which can be inserted in and removed from the running kernel whenever you want). If you want to compile it as a module, say M here and read - . + . config DMASOUND_PMAC tristate "PowerMac DMA sound support" @@ -24,7 +24,7 @@ config DMASOUND_PMAC This driver is also available as a module ( = code which can be inserted in and removed from the running kernel whenever you want). If you want to compile it as a module, say M here and read - . + . config DMASOUND_PAULA tristate "Amiga DMA sound support" @@ -38,7 +38,7 @@ config DMASOUND_PAULA This driver is also available as a module ( = code which can be inserted in and removed from the running kernel whenever you want). If you want to compile it as a module, say M here and read - . + . config DMASOUND_Q40 tristate "Q40 sound support" @@ -52,7 +52,7 @@ config DMASOUND_Q40 This driver is also available as a module ( = code which can be inserted in and removed from the running kernel whenever you want). If you want to compile it as a module, say M here and read - . + . config DMASOUND tristate diff --git a/sound/oss/vwsnd.c b/sound/oss/vwsnd.c index b7ee3d1ae1495..5c4038f18ccf9 100644 --- a/sound/oss/vwsnd.c +++ b/sound/oss/vwsnd.c @@ -1,6 +1,6 @@ /* * Sound driver for Silicon Graphics 320 and 540 Visual Workstations' - * onboard audio. See notes in ../../Documentation/sound/vwsnd . + * onboard audio. See notes in ../../Documentation/sound/oss/vwsnd . * * Copyright 1999 Silicon Graphics, Inc. All rights reserved. * -- 2.53.0