Commit 98766fbe authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

[PATCH] kernel Doc/ URL corrections

Correct lots of URLs in Documentation/ Also a few minor whitespace cleanups
and typo/spello fixes.  Sadly there are still a lot of bad URLs remaining.
Signed-off-by: default avatarRandy Dunlap <>
Signed-off-by: default avatarAndrew Morton <>
Signed-off-by: default avatarLinus Torvalds <>
parent 6c52f137
......@@ -12,7 +12,7 @@ This release has been validated against the SoftFloat-2b library by
John R. Hauser using the TestFloat-2a test suite. Details of this
library and test suite can be found at:
The operations which have been tested with this package are:
......@@ -60,7 +60,6 @@ Some very frequently asked questions about linuxtv-dvb
Metzler Bros. DVB development; alternate drivers and
DVB utilities, include dvb-mpegtools and tuxzap.
Dave Chapman's dvbtools package, including
dvbstream and dvbtune
......@@ -216,4 +216,4 @@ due to an incompatibility with the Amiga floppy controller.
If you are interested in an Amiga Emulator for Linux, look at
......@@ -369,9 +369,8 @@ The kernel source file:/usr/src/linux/fs/ext2/
e2fsprogs (e2fsck)
Design & Implementation
Journaling (ext3)
Hashed Directories
Filesystem Resizing
Compression (*)
Compression (*)
Implementations for:
Windows 95/98/NT/2000
......@@ -4,7 +4,7 @@ FAQ list:
A FAQ list may be found in the fdutils package (see below), and also
at <>.
LILO configuration options (Thinkpad users, read this)
......@@ -217,10 +217,10 @@ It also contains additional documentation about the floppy driver.
The latest version can be found at fdutils homepage:
The fdutils-5.4 release can be found at:
The fdutils releases can be found at:
Reporting problems about the floppy driver
......@@ -133,7 +133,7 @@ Code Seq# Include File Comments
'l' 00-3F linux/tcfs_fs.h transparent cryptographic file system
'l' 40-7F linux/udf_fs_i.h in development:
'm' all linux/mtio.h conflict!
'm' all linux/soundcard.h conflict!
'm' all linux/synclink.h conflict!
......@@ -196,7 +196,7 @@
* Title: "Writing Linux Device Drivers"
Author: Michael K. Johnson.
Keywords: files, VFS, file operations, kernel interface, character
vs block devices, I/O access, hardware interrupts, DMA, access to
user memory, memory allocation, timers.
......@@ -284,7 +284,7 @@
* Title: "Linux Kernel Module Programming Guide"
Author: Ori Pomerantz.
Keywords: modules, GPL book, /proc, ioctls, system calls,
interrupt handlers .
Description: Very nice 92 pages GPL book on the topic of modules
......@@ -292,7 +292,7 @@
* Title: "Device File System (devfs) Overview"
Author: Richard Gooch.
Keywords: filesystem, /dev, devfs, dynamic devices, major/minor
allocation, device management.
Description: Document describing Richard Gooch's controversial
......@@ -316,9 +316,8 @@
* Title: "The Kernel Hacking HOWTO"
Author: Various Talented People, and Rusty.
Location: in kernel tree, Documentation/DocBook/kernel-hacking/
(must be built as "make {htmldocs | psdocs | pdfdocs})
Keywords: HOWTO, kernel contexts, deadlock, locking, modules,
symbols, return conventions.
Description: From the Introduction: "Please understand that I
......@@ -332,13 +331,13 @@
originally written for the 2.3 kernels, but nearly all of it
applies to 2.2 too; 2.0 is slightly different".
* Title: "ALSA 0.5.0 Developer documentation"
Author: Stephan 'Jumpy' Bartels .
* Title: "Writing an ALSA Driver"
Author: Takashi Iwai <>
Keywords: ALSA, sound, soundcard, driver, lowlevel, hardware.
Description: Advanced Linux Sound Architecture for developers,
both at kernel and user-level sides. Work in progress. ALSA is
supposed to be Linux's next generation sound architecture.
both at kernel and user-level sides. ALSA is the Linux kernel
sound architecture in the 2.6 kernel version.
* Title: "Programming Guide for Linux USB Device Drivers"
Author: Detlef Fliegl.
......@@ -369,8 +368,8 @@
filesystems, IPC and Networking Code.
* Title: "Linux Kernel Mailing List Glossary"
Author: John Levon.
Author: various
Keywords: glossary, terms, linux-kernel.
Description: From the introduction: "This glossary is intended as
a brief description of some of the acronyms and terms you may hear
......@@ -378,9 +377,8 @@
* Title: "Linux Kernel Locking HOWTO"
Author: Various Talented People, and Rusty.
Location: in kernel tree, Documentation/DocBook/kernel-locking/
(must be built as "make {htmldocs | psdocs | pdfdocs})
Keywords: locks, locking, spinlock, semaphore, atomic, race
condition, bottom halves, tasklets, softirqs.
Description: The title says it all: document describing the
......@@ -490,7 +488,7 @@
* Title: "Get those boards talking under Linux."
Author: Alex Ivchenko.
Keywords: data-acquisition boards, drivers, modules, interrupts,
memory allocation.
Description: Article written for people wishing to make their data
......@@ -498,7 +496,7 @@
overview on writing drivers, from the naming of functions to
interrupt handling.
Notes: Two-parts article. Part II is at
* Title: "Linux PCMCIA Programmer's Guide"
Author: David Hinds.
......@@ -529,7 +527,7 @@
definitive guide for hackers, virus coders and system
Author: pragmatic/THC.
Keywords: syscalls, intercept, hide, abuse, symbol table.
Description: Interesting paper on how to abuse the Linux kernel in
order to intercept and modify syscalls, make
......@@ -537,8 +535,7 @@
write kernel modules based virus... and solutions for admins to
avoid all those abuses.
Notes: For 2.0.x kernels. Gives guidances to port it to 2.2.x
kernels. Also available in txt format at
BOOKS: (Not on-line)
......@@ -557,7 +554,17 @@
ISBN: 0-59600-008-1
Notes: Further information in
* Title: "Linux Device Drivers, 3nd Edition"
Authors: Jonathan Corbet, Alessandro Rubini, and Greg Kroah-Hartman
Publisher: O'Reilly & Associates.
Date: 2005.
Pages: 636.
ISBN: 0-596-00590-3
Notes: Further information in
PDF format, URL:
* Title: "Linux Kernel Internals"
Author: Michael Beck.
Publisher: Addison-Wesley.
......@@ -766,12 +773,15 @@
documents, FAQs...
* Name: "linux-kernel mailing list archives and search engines"
Keywords: linux-kernel, archives, search.
Description: Some of the linux-kernel mailing list archivers. If
you have a better/another one, please let me know.
Document last updated on Thu Jun 28 15:09:39 CEST 2001
Document last updated on Sat 2005-NOV-19
......@@ -252,7 +252,7 @@ their names here, but I don't have a list handy. Check the MCA Linux
home page (URL below) for a perpetually out-of-date list.
MCA Linux Home Page:
MCA Linux Home Page:
Christophe Beauregard
Documents about softnet driver issues in general can be found
Document about softnet driver issues
Transmit path guidelines:
......@@ -22,7 +22,7 @@ The features and limitations of this driver are as follows:
- All variants of Interphase ATM PCI (i)Chip adapter cards are supported,
including x575 (OC3, control memory 128K , 512K and packet memory 128K,
512K and 1M), x525 (UTP25) and x531 (DS3 and E3). See
for details.
- Only x86 platforms are supported.
- SMP is supported.
......@@ -3,12 +3,8 @@ of the IrDA Utilities. More detailed information about these and associated
programs can be found on
For more information about how to use the IrDA protocol stack, see the
Linux Infared HOWTO (
by Werner Heuser <>
Linux Infrared HOWTO by Werner Heuser <>:
There is an active mailing list for discussing Linux-IrDA matters called
......@@ -29,8 +29,7 @@ with nondefault parameters, they can be edited in
will find them all.
Information on card services is available at:
Card services user programs are still required for PCMCIA devices.
......@@ -11,7 +11,7 @@ The driver was written by Donald Becker <>
Don is no longer the prime maintainer of this version of the driver.
Please report problems to one or more of:
Andrew Morton <>
Andrew Morton <>
Netdev mailing list <>
Linux kernel mailing list <>
......@@ -274,24 +274,24 @@ Details of the device driver implementation are at the top of the source file.
Additional documentation is available at Don Becker's Linux Drivers site:
Donald Becker's driver development site:
Donald's vortex-diag program is useful for inspecting the NIC's state:
Donald's mii-diag program may be used for inspecting and manipulating
the NIC's Media Independent Interface subsystem:
Donald's wake-on-LAN page:
3Com's documentation for many NICs, including the ones supported by
this driver is available at
......@@ -305,7 +305,7 @@ this driver is available at
Driver updates and a detailed changelog for the modifications which
were made for the 2.3/2,4 series kernel is available at
Autonegotiation notes
......@@ -434,8 +434,8 @@ steps you should take:
send all logs to the maintainer.
3) Download you card's diagnostic tool from Donald
Backer's website Download
mii-diag.c as well. Build these.
Becker's website <>.
Download mii-diag.c as well. Build these.
a) Run 'vortex-diag -aaee' and 'mii-diag -v' when the card is
working correctly. Save the output.
......@@ -443,8 +443,8 @@ steps you should take:
b) Run the above commands when the card is malfunctioning. Send
both sets of output.
Finally, please be patient and be prepared to do some work. You may end up working on
this problem for a week or more as the maintainer asks more questions, asks for more
tests, asks for patches to be applied, etc. At the end of it all, the problem may even
remain unresolved.
Finally, please be patient and be prepared to do some work. You may
end up working on this problem for a week or more as the maintainer
asks more questions, asks for more tests, asks for patches to be
applied, etc. At the end of it all, the problem may even remain
......@@ -335,5 +335,5 @@ this on the whole.
PCI Local Bus Specification
PCI Bus Power Management Interface Specification
......@@ -1108,7 +1108,7 @@
A: You have to activate MCA bus support, first.
Q: Where can I find the latest info about this driver?
A: See the file MAINTAINERS for the current WWW-address, which offers
updates, info and Q/A lists. At this files' origin, the webaddress
updates, info and Q/A lists. At this file's origin, the webaddress
Q: My SCSI-adapter is not recognized by the driver, what can I do?
A: Just force it to be recognized by kernel parameters. See section 5.1.
......@@ -1248,7 +1248,7 @@
The address of the IBM SCSI-subsystem supporting WWW-page is:
Here you can find info about the background of this driver, patches,
troubleshooting support, news and a bugreport form. Please check that
......@@ -28,8 +28,8 @@ SUPPORTED CAMERAS:
Xirlink "C-It" camera, also known as "IBM PC Camera".
The device uses proprietary ASIC (and compression method);
it is manufactured by Xirlink. See or for
details and pictures.
(renamed to,,
or for details and pictures.
This very chipset ("X Chip", as marked at the factory)
is used in several other cameras, and they are supported
......@@ -22,8 +22,8 @@ WHAT YOU NEED:
- A Video4Linux compatible frame grabber program (I recommend vidcat and xawtv)
vidcat is part of the w3cam package:
xawtv is available at:
vidcat is part of the w3cam package:
xawtv is available at:
......@@ -46,9 +46,9 @@ Contact information:
The main page for the project is hosted at in the following
address: You can also go to the sourceforge
project page at: There is
also a mailing list:
URL: <>. You can also go to the project's
sourceforge home page at: <>.
There is also a mailing list:
......@@ -76,8 +76,11 @@ activates the GRAB bit. A few ms later the VSYNC (re-)rises and
the zoran starts to work on a new and freshly broadcasted frame....
For pointers I used the specs of both chips. Below are the URLs:
Some alternatives for the Philips SAA 7110 datasheet are:
The documentation has very little on absolute numbers or timings
needed for the various modes/resolutions, but there are other
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment