Browse files

doc: fix broken references

There are numerous broken references to Documentation files (in other
Documentation files, in comments, etc.). These broken references are
caused by typo's in the references, and by renames or removals of the
Documentation files. Some broken references are simply odd.

Fix these broken references, sometimes by dropping the irrelevant text
they were part of.

Signed-off-by: Paul Bolle <>
Signed-off-by: Jiri Kosina <>
  • Loading branch information...
1 parent e060c38 commit 395cf9691d72173d8cdaa613c5f0255f993af94b @pebolle pebolle committed with Jiri Kosina Aug 15, 2011
Showing with 125 additions and 179 deletions.
  1. +1 −1 Documentation/PCI/pci.txt
  2. +1 −1 Documentation/blackfin/bfin-gpio-notes.txt
  3. +1 −1 Documentation/block/biodoc.txt
  4. +1 −1 Documentation/bus-virt-phys-mapping.txt
  5. +1 −1 Documentation/cdrom/packet-writing.txt
  6. +1 −1 Documentation/development-process/4.Coding
  7. +1 −1 Documentation/devicetree/bindings/gpio/led.txt
  8. +3 −3 Documentation/filesystems/caching/object.txt
  9. +6 −5 Documentation/filesystems/locks.txt
  10. +1 −1 Documentation/filesystems/nfs/idmapper.txt
  11. +3 −2 Documentation/filesystems/pohmelfs/design_notes.txt
  12. +1 −1 Documentation/filesystems/proc.txt
  13. +0 −3 Documentation/filesystems/vfs.txt
  14. +0 −6 Documentation/frv/booting.txt
  15. +1 −1 Documentation/input/input.txt
  16. +2 −2 Documentation/kernel-docs.txt
  17. +6 −6 Documentation/kernel-parameters.txt
  18. +2 −2 Documentation/laptops/thinkpad-acpi.txt
  19. +2 −2 Documentation/media-framework.txt
  20. +1 −1 Documentation/memory-barriers.txt
  21. +1 −1 Documentation/networking/scaling.txt
  22. +1 −1 Documentation/power/basic-pm-debugging.txt
  23. +2 −1 Documentation/power/userland-swsusp.txt
  24. +1 −2 Documentation/rfkill.txt
  25. +1 −1 Documentation/scsi/aic7xxx_old.txt
  26. +0 −5 Documentation/scsi/scsi_mid_low_api.txt
  27. +2 −1 Documentation/security/keys-trusted-encrypted.txt
  28. +1 −2 Documentation/sound/oss/PAS16
  29. +2 −2 Documentation/spi/pxa2xx
  30. +1 −1 Documentation/timers/highres.txt
  31. +3 −3 Documentation/usb/dma.txt
  32. +1 −1 Documentation/virtual/lguest/lguest.c
  33. +2 −2 Documentation/vm/numa
  34. +1 −1 Documentation/vm/slub.txt
  35. +2 −3 arch/alpha/kernel/srm_env.c
  36. +1 −1 arch/arm/Kconfig
  37. +1 −1 arch/arm/include/asm/io.h
  38. +1 −2 arch/arm/mach-pxa/xcep.c
  39. +6 −6 arch/ia64/hp/common/sba_iommu.c
  40. +1 −1 arch/m68k/q40/README
  41. +1 −1 arch/microblaze/include/asm/dma-mapping.h
  42. +2 −4 arch/mips/include/asm/lasat/lasat.h
  43. +1 −1 arch/mn10300/Kconfig
  44. +0 −1 arch/mn10300/kernel/irq.c
  45. +1 −1 arch/openrisc/Kconfig
  46. +1 −1 arch/openrisc/include/asm/dma-mapping.h
  47. +1 −1 arch/parisc/include/asm/dma-mapping.h
  48. +1 −1 arch/parisc/kernel/pci-dma.c
  49. +1 −1 arch/powerpc/include/asm/qe.h
  50. +1 −1 arch/powerpc/sysdev/qe_lib/qe.c
  51. +1 −1 arch/unicore32/include/asm/io.h
  52. +1 −1 arch/x86/Kconfig
  53. +1 −1 arch/x86/Kconfig.debug
  54. +1 −1 arch/x86/boot/header.S
  55. +1 −1 arch/x86/include/asm/dma-mapping.h
  56. +1 −1 arch/x86/kernel/amd_gart_64.c
  57. +0 −2 arch/x86/kernel/apm_32.c
  58. +2 −2 arch/x86/kernel/pci-dma.c
  59. +1 −4 drivers/char/apm-emulation.c
  60. +1 −1 drivers/input/misc/rotary_encoder.c
  61. +1 −1 drivers/leds/Kconfig
  62. +1 −1 drivers/media/dvb/dvb-usb/af9005-remote.c
  63. +1 −1 drivers/media/dvb/dvb-usb/af9005.c
  64. +1 −1 drivers/media/dvb/frontends/dib3000.h
  65. +1 −1 drivers/media/dvb/frontends/dib3000mb.c
  66. +1 −1 drivers/mtd/Kconfig
  67. +1 −2 drivers/net/Kconfig
  68. +1 −1 drivers/net/can/sja1000/sja1000_of_platform.c
  69. +0 −3 drivers/net/tulip/21142.c
  70. +0 −2 drivers/net/tulip/eeprom.c
  71. +0 −3 drivers/net/tulip/interrupt.c
  72. +0 −3 drivers/net/tulip/media.c
  73. +0 −3 drivers/net/tulip/pnic.c
  74. +0 −3 drivers/net/tulip/pnic2.c
  75. +0 −3 drivers/net/tulip/timer.c
  76. +0 −3 drivers/net/tulip/tulip.h
  77. +0 −3 drivers/net/tulip/tulip_core.c
  78. +8 −8 drivers/parisc/sba_iommu.c
  79. +1 −4 drivers/platform/x86/Kconfig
  80. +1 −1 drivers/scsi/megaraid/megaraid_mbox.c
  81. +1 −2 drivers/staging/cxt1e1/Kconfig
  82. +1 −1 drivers/usb/serial/digi_acceleport.c
  83. +1 −1 drivers/video/igafb.c
  84. +1 −1 drivers/watchdog/smsc37b787_wdt.c
  85. +2 −1 fs/configfs/inode.c
  86. +1 −1 fs/configfs/item.c
  87. +1 −1 fs/locks.c
  88. +3 −3 fs/squashfs/Kconfig
  89. +1 −1 include/linux/io-mapping.h
  90. +1 −1 include/linux/isdn.h
  91. +1 −1 include/linux/platform_data/ntc_thermistor.h
  92. +1 −1 include/media/videobuf-dma-sg.h
  93. +2 −2 include/target/configfs_macros.h
  94. +1 −1 net/netfilter/Kconfig
  95. +1 −3 sound/oss/Kconfig
  96. +2 −2 tools/perf/util/config.c
@@ -314,7 +314,7 @@ from the PCI device config space. Use the values in the pci_dev structure
as the PCI "bus address" might have been remapped to a "host physical"
address by the arch/chip-set specific kernel support.
-See Documentation/IO-mapping.txt for how to access device registers
+See Documentation/io-mapping.txt for how to access device registers
or device memory.
The device driver needs to call pci_request_region() to verify
@@ -1,5 +1,5 @@
- * File: Documentation/blackfin/bfin-gpio-note.txt
+ * File: Documentation/blackfin/bfin-gpio-notes.txt
* Based on:
* Author:
@@ -186,7 +186,7 @@ a virtual address mapping (unlike the earlier scheme of virtual address
do not have a corresponding kernel virtual address space mapping) and
low-memory pages.
-Note: Please refer to Documentation/PCI/PCI-DMA-mapping.txt for a discussion
+Note: Please refer to Documentation/DMA-API-HOWTO.txt for a discussion
on PCI high mem DMA aspects and mapping of scatter gather lists, and support
for 64 bit PCI.
@@ -1,6 +1,6 @@
[ NOTE: The virt_to_bus() and bus_to_virt() functions have been
superseded by the functionality provided by the PCI DMA interface
- (see Documentation/PCI/PCI-DMA-mapping.txt). They continue
+ (see Documentation/DMA-API-HOWTO.txt). They continue
to be documented below for historical purposes, but new code
must not use them. --davidm 00/12/12 ]
@@ -109,7 +109,7 @@ this interface. (see )
For a description of the sysfs interface look into the file:
- Documentation/ABI/testing/sysfs-block-pktcdvd
+ Documentation/ABI/testing/sysfs-class-pktcdvd
Using the pktcdvd debugfs interface
@@ -278,7 +278,7 @@ enabled, a configurable percentage of memory allocations will be made to
fail; these failures can be restricted to a specific range of code.
Running with fault injection enabled allows the programmer to see how the
code responds when things go badly. See
-Documentation/fault-injection/fault-injection.text for more information on
+Documentation/fault-injection/fault-injection.txt for more information on
how to use this facility.
Other kinds of errors can be found with the "sparse" static analysis tool.
@@ -8,7 +8,7 @@ node's name represents the name of the corresponding LED.
LED sub-node properties:
- gpios : Should specify the LED's GPIO, see "Specifying GPIO information
- for devices" in Documentation/powerpc/booting-without-of.txt. Active
+ for devices" in Documentation/devicetree/booting-without-of.txt. Active
low LEDs should be indicated using flags in the GPIO specifier.
- label : (optional) The label for this LED. If omitted, the label is
taken from the node name (excluding the unit address).
@@ -127,9 +127,9 @@ fscache_enqueue_object()).
-The work to be done by the various states is given CPU time by the threads of
-the slow work facility (see Documentation/slow-work.txt). This is used in
-preference to the workqueue facility because:
+The work to be done by the various states was given CPU time by the threads of
+the slow work facility. This was used in preference to the workqueue facility
(1) Threads may be completely occupied for very long periods of time by a
particular work item. These state actions may be doing sequences of
@@ -53,11 +53,12 @@ fcntl(), with all the problems that implies.
1.3 Mandatory Locking As A Mount Option
-Mandatory locking, as described in 'Documentation/filesystems/mandatory.txt'
-was prior to this release a general configuration option that was valid for
-all mounted filesystems. This had a number of inherent dangers, not the
-least of which was the ability to freeze an NFS server by asking it to read
-a file for which a mandatory lock existed.
+Mandatory locking, as described in
+'Documentation/filesystems/mandatory-locking.txt' was prior to this release a
+general configuration option that was valid for all mounted filesystems. This
+had a number of inherent dangers, not the least of which was the ability to
+freeze an NFS server by asking it to read a file for which a mandatory lock
From this release of the kernel, mandatory locking can be turned on and off
on a per-filesystem basis, using the mount options 'mand' and 'nomand'.
@@ -47,7 +47,7 @@ request-key will find the first matching line and corresponding program. In
this case, /some/other/program will handle all uid lookups and
/usr/sbin/nfs.idmap will handle gid, user, and group lookups.
-See <file:Documentation/security/keys-request-keys.txt> for more information
+See <file:Documentation/security/keys-request-key.txt> for more information
about the request-key function.
@@ -58,8 +58,9 @@ data transfers.
POHMELFS clients operate with a working set of servers and are capable of balancing read-only
operations (like lookups or directory listings) between them according to IO priorities.
Administrators can add or remove servers from the set at run-time via special commands (described
-in Documentation/pohmelfs/info.txt file). Writes are replicated to all servers, which are connected
-with write permission turned on. IO priority and permissions can be changed in run-time.
+in Documentation/filesystems/pohmelfs/info.txt file). Writes are replicated to all servers, which
+are connected with write permission turned on. IO priority and permissions can be changed in
POHMELFS is capable of full data channel encryption and/or strong crypto hashing.
One can select any kernel supported cipher, encryption mode, hash type and operation mode
@@ -1263,7 +1263,7 @@ review the kernel documentation in the directory /usr/src/linux/Documentation.
This chapter is heavily based on the documentation included in the pre 2.2
kernels, and became part of it in version 2.2.1 of the Linux kernel.
-Please see: Documentation/sysctls/ directory for descriptions of these
+Please see: Documentation/sysctl/ directory for descriptions of these
@@ -1053,9 +1053,6 @@ manipulate dentries:
and the dentry is returned. The caller must use dput()
to free the dentry when it finishes using it.
-For further information on dentry locking, please refer to the document
Mount Options
@@ -180,9 +180,3 @@ separated by spaces:
This tells the kernel what program to run initially. By default this is
/sbin/init, but /sbin/sash or /bin/sh are common alternatives.
- (*) vdc=...
- This option configures the MB93493 companion chip visual display
- driver. Please see Documentation/frv/mb93493/vdc.txt for more
- information.
@@ -111,7 +111,7 @@ LCDs and many other purposes.
The monitor and speaker controls should be easy to add to the hid/input
interface, but for the UPSs and LCDs it doesn't make much sense. For this,
-the hiddev interface was designed. See Documentation/usb/hiddev.txt
+the hiddev interface was designed. See Documentation/hid/hiddev.txt
for more information about it.
The usage of the usbhid module is very simple, it takes no parameters,
@@ -300,7 +300,7 @@
* Title: "The Kernel Hacking HOWTO"
Author: Various Talented People, and Rusty.
- Location: in kernel tree, Documentation/DocBook/kernel-hacking/
+ Location: in kernel tree, Documentation/DocBook/kernel-hacking.tmpl
(must be built as "make {htmldocs | psdocs | pdfdocs})
Keywords: HOWTO, kernel contexts, deadlock, locking, modules,
symbols, return conventions.
@@ -351,7 +351,7 @@
* Title: "Linux Kernel Locking HOWTO"
Author: Various Talented People, and Rusty.
- Location: in kernel tree, Documentation/DocBook/kernel-locking/
+ Location: in kernel tree, Documentation/DocBook/kernel-locking.tmpl
(must be built as "make {htmldocs | psdocs | pdfdocs})
Keywords: locks, locking, spinlock, semaphore, atomic, race
condition, bottom halves, tasklets, softirqs.
@@ -163,7 +163,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
rsdt -- prefer RSDT over (default) XSDT
copy_dsdt -- copy DSDT to memory
- See also Documentation/power/pm.txt, pci=noacpi
+ See also Documentation/power/runtime_pm.txt, pci=noacpi
acpi_rsdp= [ACPI,EFI,KEXEC]
Pass the RSDP address to the kernel, mostly used
@@ -319,7 +319,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted. [HW,JOY] Amiga joystick support
Map of devices attached to JOY0DAT and JOY1DAT
Format: <a>,<b>
- See also Documentation/kernel/input/joystick.txt
+ See also Documentation/input/joystick.txt [HW,JOY] Analog joystick and gamepad support
Specifies type or capabilities of an analog joystick
@@ -408,7 +408,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted. Most important insmod options are available as
kernel args too.
bttv.pll= See Documentation/video4linux/bttv/Insmod-options
- bttv.tuner= and Documentation/video4linux/bttv/CARDLIST
+ bttv.tuner=
bulk_remove=off [PPC] This parameter disables the use of the pSeries
firmware feature for flushing multiple hpte entries
@@ -724,7 +724,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
elevator= [IOSCHED]
Format: {"cfq" | "deadline" | "noop"}
- See Documentation/block/as-iosched.txt and
+ See Documentation/block/cfq-iosched.txt and
Documentation/block/deadline-iosched.txt for details.
elfcorehdr= [IA-64,PPC,SH,X86]
@@ -765,7 +765,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
General fault injection mechanism.
Format: <interval>,<probability>,<space>,<times>
- See also /Documentation/fault-injection/.
+ See also Documentation/fault-injection/.
floppy= [HW]
See Documentation/blockdev/floppy.txt.
@@ -2375,7 +2375,7 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
Format: <integer>
sonypi.*= [HW] Sony Programmable I/O Control Device driver
- See Documentation/sonypi.txt
+ See Documentation/laptops/sonypi.txt
specialix= [HW,SERIAL] Specialix multi-serial port adapter
See Documentation/serial/specialix.txt.
@@ -736,7 +736,7 @@ status as "unknown". The available commands are:
sysfs notes:
The ThinkLight sysfs interface is documented by the LED class
-documentation, in Documentation/leds-class.txt. The ThinkLight LED name
+documentation, in Documentation/leds/leds-class.txt. The ThinkLight LED name
is "tpacpi::thinklight".
Due to limitations in the sysfs LED class, if the status of the ThinkLight
@@ -833,7 +833,7 @@ All of the above can be turned on and off and can be made to blink.
sysfs notes:
The ThinkPad LED sysfs interface is described in detail by the LED class
-documentation, in Documentation/leds-class.txt.
+documentation, in Documentation/leds/leds-class.txt.
The LEDs are named (in LED ID order, from 0 to 12):
"tpacpi::power", "tpacpi:orange:batt", "tpacpi:green:batt",
@@ -9,8 +9,8 @@ Introduction
The media controller API is documented in DocBook format in
-Documentation/DocBook/v4l/media-controller.xml. This document will focus on
-the kernel-side implementation of the media framework.
+Documentation/DocBook/media/v4l/media-controller.xml. This document will focus
+on the kernel-side implementation of the media framework.
Abstract media device model
@@ -438,7 +438,7 @@ There are certain things that the Linux kernel memory barriers do not guarantee:
[*] For information on bus mastering DMA and coherency please read:
- Documentation/PCI/PCI-DMA-mapping.txt
+ Documentation/DMA-API-HOWTO.txt
@@ -73,7 +73,7 @@ of queues to IRQs can be determined from /proc/interrupts. By default,
an IRQ may be handled on any CPU. Because a non-negligible part of packet
processing takes place in receive interrupt handling, it is advantageous
to spread receive interrupts between CPUs. To manually adjust the IRQ
-affinity of each interrupt see Documentation/IRQ-affinity. Some systems
+affinity of each interrupt see Documentation/IRQ-affinity.txt. Some systems
will be running irqbalance, a daemon that dynamically optimizes IRQ
assignments and as a result may override any manual settings.
@@ -173,7 +173,7 @@ kernel messages using the serial console. This may provide you with some
information about the reasons of the suspend (resume) failure. Alternatively,
it may be possible to use a FireWire port for debugging with firescope
( On x86 it is also possible to
-use the PM_TRACE mechanism documented in Documentation/s2ram.txt .
+use the PM_TRACE mechanism documented in Documentation/power/s2ram.txt .
2. Testing suspend to RAM (STR)
@@ -77,7 +77,8 @@ SNAPSHOT_SET_SWAP_AREA - set the resume partition and the offset (in <PAGE_SIZE>
resume_swap_area, as defined in kernel/power/suspend_ioctls.h,
containing the resume device specification and the offset); for swap
partitions the offset is always 0, but it is different from zero for
- swap files (see Documentation/swsusp-and-swap-files.txt for details).
+ swap files (see Documentation/power/swsusp-and-swap-files.txt for
+ details).
SNAPSHOT_PLATFORM_SUPPORT - enable/disable the hibernation platform support,
depending on the argument value (enable, if the argument is nonzero)
@@ -117,5 +117,4 @@ The contents of these variables corresponds to the "name", "state" and
"type" sysfs files explained above.
-For further details consult Documentation/ABI/stable/dev-rfkill and
+For further details consult Documentation/ABI/stable/sysfs-class-rfkill.
@@ -444,7 +444,7 @@ linux-1.1.x and fairly stable since linux-1.2.x, and are also in FreeBSD
Kernel Compile options
The various kernel compile time options for this driver are now fairly
- well documented in the file Documentation/ In order to
+ well documented in the file drivers/scsi/Kconfig. In order to
see this documentation, you need to use one of the advanced configuration
programs (menuconfig and xconfig). If you are using the "make menuconfig"
method of configuring your kernel, then you would simply highlight the
@@ -55,11 +55,6 @@ or in the same directory as the C source code. For example to find a url
about the USB mass storage driver see the
/usr/src/linux/drivers/usb/storage directory.
-The Linux kernel source Documentation/DocBook/scsidrivers.tmpl file
-refers to this file. With the appropriate DocBook tool-set, this permits
-users to generate html, ps and pdf renderings of information within this
-file (e.g. the interface functions).
Driver structure
Traditionally an LLD for the SCSI subsystem has been at least two files in
@@ -156,4 +156,5 @@ Load an encrypted key "evm" from saved blob:
Other uses for trusted and encrypted keys, such as for disk and file encryption
are anticipated. In particular the new format 'ecryptfs' has been defined in
in order to use encrypted keys to mount an eCryptfs filesystem. More details
-about the usage can be found in the file 'Documentation/keys-ecryptfs.txt'.
+about the usage can be found in the file
@@ -60,8 +60,7 @@ With PAS16 you can use two audio device files at the same time. /dev/dsp (and
The new stuff for 2.3.99 and later
-The following configuration options from Documentation/
-are relevant to configuring the PAS16:
+The following configuration options are relevant to configuring the PAS16:
Sound card support
@@ -2,7 +2,7 @@ PXA2xx SPI on SSP driver HOWTO
This a mini howto on the pxa2xx_spi driver. The driver turns a PXA2xx
synchronous serial port into a SPI master controller
-(see Documentation/spi/spi_summary). The driver has the following features
+(see Documentation/spi/spi-summary). The driver has the following features
- Support for any PXA2xx SSP
- SSP PIO and SSP DMA data transfers.
@@ -85,7 +85,7 @@ Declaring Slave Devices
Typically each SPI slave (chip) is defined in the arch/.../mach-*/board-*.c
using the "spi_board_info" structure found in "linux/spi/spi.h". See
-"Documentation/spi/spi_summary" for additional information.
+"Documentation/spi/spi-summary" for additional information.
Each slave device attached to the PXA must provide slave specific configuration
information via the structure "pxa2xx_spi_chip" found in
@@ -30,7 +30,7 @@ hrtimer base infrastructure
The hrtimer base infrastructure was merged into the 2.6.16 kernel. Details of
-the base implementation are covered in Documentation/hrtimers/hrtimer.txt. See
+the base implementation are covered in Documentation/timers/hrtimers.txt. See
also figure #2 (OLS slides p. 15)
The main differences to the timer wheel, which holds the armed timer_list type
@@ -7,7 +7,7 @@ API OVERVIEW
The big picture is that USB drivers can continue to ignore most DMA issues,
though they still must provide DMA-ready buffers (see
-Documentation/PCI/PCI-DMA-mapping.txt). That's how they've worked through
+Documentation/DMA-API-HOWTO.txt). That's how they've worked through
the 2.4 (and earlier) kernels.
OR: they can now be DMA-aware.
@@ -57,7 +57,7 @@ and effects like cache-trashing can impose subtle penalties.
force a consistent memory access ordering by using memory barriers. It's
not using a streaming DMA mapping, so it's good for small transfers on
systems where the I/O would otherwise thrash an IOMMU mapping. (See
- Documentation/PCI/PCI-DMA-mapping.txt for definitions of "coherent" and
+ Documentation/DMA-API-HOWTO.txt for definitions of "coherent" and
"streaming" DMA mappings.)
Asking for 1/Nth of a page (as well as asking for N pages) is reasonably
Existing buffers aren't usable for DMA without first being mapped into the
DMA address space of the device. However, most buffers passed to your
driver can safely be used with such DMA mapping. (See the first section
-of Documentation/PCI/PCI-DMA-mapping.txt, titled "What memory is DMA-able?")
+of Documentation/DMA-API-HOWTO.txt, titled "What memory is DMA-able?")
- When you're using scatterlists, you can map everything at once. On some
systems, this kicks in an IOMMU and turns the scatterlists into single
@@ -436,7 +436,7 @@ static unsigned long load_bzimage(int fd)
* Go back to the start of the file and read the header. It should be
- * a Linux boot header (see Documentation/x86/i386/boot.txt)
+ * a Linux boot header (see Documentation/x86/boot.txt)
lseek(fd, 0, SEEK_SET);
read(fd, &boot, sizeof(boot));
Oops, something went wrong.

0 comments on commit 395cf96

Please sign in to comment.