Magellan Linux

Annotation of /alx-src/trunk/kernel26-alx/linux/Documentation/00-INDEX

Parent Directory Parent Directory | Revision Log Revision Log


Revision 628 - (hide annotations) (download)
Wed Mar 4 10:48:58 2009 UTC (15 years, 2 months ago) by niro
File size: 10173 byte(s)
import linux sources based on 2.6.12-alx-r9:
 -using linux-2.6.12.6
 -using 2.6.12-ck6 patch set
 -using fbsplash-0.9.2-r3
 -using vesafb-tng-0.9-rc7
 -using squashfs-2.2
 -added cddvd-cmdfilter-drop.patch as ck dropped it
 -added via-epia-dri (cle266) patch
 -added zd1211-svn-32 wlan driver (http://zd1211.ath.cx/download/)
 -added debian patches to zd1211 for wep256 etc

1 niro 628
2     This is a brief list of all the files in ./linux/Documentation and what
3     they contain. If you add a documentation file, please list it here in
4     alphabetical order as well, or risk being hunted down like a rabid dog.
5     Please try and keep the descriptions small enough to fit on one line.
6     Thanks -- Paul G.
7    
8     Following translations are available on the WWW:
9    
10     - Japanese, maintained by the JF Project (JF@linux.or.jp), at
11     http://www.linux.or.jp/JF/
12    
13     00-INDEX
14     - this file.
15     BUG-HUNTING
16     - brute force method of doing binary search of patches to find bug.
17     Changes
18     - list of changes that break older software packages.
19     CodingStyle
20     - how the boss likes the C code in the kernel to look.
21     DMA-API.txt
22     - DMA API, pci_ API & extensions for non-consistent memory machines.
23     DMA-mapping.txt
24     - info for PCI drivers using DMA portably across all platforms.
25     DocBook/
26     - directory with DocBook templates etc. for kernel documentation.
27     IO-mapping.txt
28     - how to access I/O mapped memory from within device drivers.
29     IPMI.txt
30     - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
31     IRQ-affinity.txt
32     - how to select which CPU(s) handle which interrupt events on SMP.
33     ManagementStyle
34     - how to (attempt to) manage kernel hackers.
35     MSI-HOWTO.txt
36     - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
37     RCU/
38     - directory with info on RCU (read-copy update).
39     README.DAC960
40     - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
41     SAK.txt
42     - info on Secure Attention Keys.
43     SubmittingDrivers
44     - procedure to get a new driver source included into the kernel tree.
45     SubmittingPatches
46     - procedure to get a source patch included into the kernel tree.
47     VGA-softcursor.txt
48     - how to change your VGA cursor from a blinking underscore.
49     arm/
50     - directory with info about Linux on the ARM architecture.
51     basic_profiling.txt
52     - basic instructions for those who wants to profile Linux kernel.
53     binfmt_misc.txt
54     - info on the kernel support for extra binary formats.
55     block/
56     - info on the Block I/O (BIO) layer.
57     cachetlb.txt
58     - describes the cache/TLB flushing interfaces Linux uses.
59     cciss.txt
60     - info, major/minor #'s for Compaq's SMART Array Controllers.
61     cdrom/
62     - directory with information on the CD-ROM drivers that Linux has.
63     cli-sti-removal.txt
64     - cli()/sti() removal guide.
65     computone.txt
66     - info on Computone Intelliport II/Plus Multiport Serial Driver.
67     cpqarray.txt
68     - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
69     cpu-freq/
70     - info on CPU frequency and voltage scaling.
71     cris/
72     - directory with info about Linux on CRIS architecture.
73     crypto/
74     - directory with info on the Crypto API.
75     debugging-modules.txt
76     - some notes on debugging modules after Linux 2.6.3.
77     device-mapper/
78     - directory with info on Device Mapper.
79     devices.txt
80     - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
81     digiepca.txt
82     - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
83     dnotify.txt
84     - info about directory notification in Linux.
85     driver-model/
86     - directory with info about Linux driver model.
87     dvb/
88     - info on Linux Digital Video Broadcast (DVB) subsystem.
89     early-userspace/
90     - info about initramfs, klibc, and userspace early during boot.
91     eisa.txt
92     - info on EISA bus support.
93     exception.txt
94     - how Linux v2.2 handles exceptions without verify_area etc.
95     fb/
96     - directory with info on the frame buffer graphics abstraction layer.
97     filesystems/
98     - directory with info on the various filesystems that Linux supports.
99     firmware_class/
100     - request_firmware() hotplug interface info.
101     floppy.txt
102     - notes and driver options for the floppy disk driver.
103     ftape.txt
104     - notes about the floppy tape device driver.
105     hayes-esp.txt
106     - info on using the Hayes ESP serial driver.
107     highuid.txt
108     - notes on the change from 16 bit to 32 bit user/group IDs.
109     hpet.txt
110     - High Precision Event Timer Driver for Linux.
111     hw_random.txt
112     - info on Linux support for random number generator in i8xx chipsets.
113     i2c/
114     - directory with info about the I2C bus/protocol (2 wire, kHz speed).
115     i2o/
116     - directory with info about the Linux I2O subsystem.
117     i386/
118     - directory with info about Linux on Intel 32 bit architecture.
119     ia64/
120     - directory with info about Linux on Intel 64 bit architecture.
121     ide.txt
122     - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS).
123     initrd.txt
124     - how to use the RAM disk as an initial/temporary root filesystem.
125     input/
126     - info on Linux input device support.
127     io_ordering.txt
128     - info on ordering I/O writes to memory-mapped addresses.
129     ioctl-number.txt
130     - how to implement and register device/driver ioctl calls.
131     iostats.txt
132     - info on I/O statistics Linux kernel provides.
133     isapnp.txt
134     - info on Linux ISA Plug & Play support.
135     isdn/
136     - directory with info on the Linux ISDN support, and supported cards.
137     java.txt
138     - info on the in-kernel binary support for Java(tm).
139     kbuild/
140     - directory with info about the kernel build process.
141     kernel-doc-nano-HOWTO.txt
142     - mini HowTo on generation and location of kernel documentation files.
143     kernel-docs.txt
144     - listing of various WWW + books that document kernel internals.
145     kernel-parameters.txt
146     - summary listing of command line / boot prompt args for the kernel.
147     kobject.txt
148     - info of the kobject infrastructure of the Linux kernel.
149     laptop-mode.txt
150     - How to conserve battery power using laptop-mode.
151     ldm.txt
152     - a brief description of LDM (Windows Dynamic Disks).
153     locks.txt
154     - info on file locking implementations, flock() vs. fcntl(), etc.
155     logo.gif
156     - Full colour GIF image of Linux logo (penguin).
157     logo.txt
158     - Info on creator of above logo & site to get additional images from.
159     m68k/
160     - directory with info about Linux on Motorola 68k architecture.
161     magic-number.txt
162     - list of magic numbers used to mark/protect kernel data structures.
163     mandatory.txt
164     - info on the Linux implementation of Sys V mandatory file locking.
165     mca.txt
166     - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
167     md.txt
168     - info on boot arguments for the multiple devices driver.
169     memory.txt
170     - info on typical Linux memory problems.
171     mips/
172     - directory with info about Linux on MIPS architecture.
173     mono.txt
174     - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
175     moxa-smartio
176     - info on installing/using Moxa multiport serial driver.
177     mtrr.txt
178     - how to use PPro Memory Type Range Registers to increase performance.
179     nbd.txt
180     - info on a TCP implementation of a network block device.
181     networking/
182     - directory with info on various aspects of networking with Linux.
183     nfsroot.txt
184     - short guide on setting up a diskless box with NFS root filesystem.
185     nmi_watchdog.txt
186     - info on NMI watchdog for SMP systems.
187     numastat.txt
188     - info on how to read Numa policy hit/miss statistics in sysfs.
189     oops-tracing.txt
190     - how to decode those nasty internal kernel error dump messages.
191     paride.txt
192     - information about the parallel port IDE subsystem.
193     parisc/
194     - directory with info on using Linux on PA-RISC architecture.
195     parport.txt
196     - how to use the parallel-port driver.
197     parport-lowlevel.txt
198     - description and usage of the low level parallel port functions.
199     pci.txt
200     - info on the PCI subsystem for device driver authors.
201     pm.txt
202     - info on Linux power management support.
203     pnp.txt
204     - Linux Plug and Play documentation.
205     power/
206     - directory with info on Linux PCI power management.
207     powerpc/
208     - directory with info on using Linux with the PowerPC.
209     preempt-locking.txt
210     - info on locking under a preemptive kernel.
211     ramdisk.txt
212     - short guide on how to set up and use the RAM disk.
213     riscom8.txt
214     - notes on using the RISCom/8 multi-port serial driver.
215     rocket.txt
216     - info on the Comtrol RocketPort multiport serial driver.
217     rpc-cache.txt
218     - introduction to the caching mechanisms in the sunrpc layer.
219     rtc.txt
220     - notes on how to use the Real Time Clock (aka CMOS clock) driver.
221     s390/
222     - directory with info on using Linux on the IBM S390.
223     sched-coding.txt
224     - reference for various scheduler-related methods in the O(1) scheduler.
225     sched-design.txt
226     - goals, design and implementation of the Linux O(1) scheduler.
227     sched-domains.txt
228     - information on scheduling domains.
229     sched-stats.txt
230     - information on schedstats (Linux Scheduler Statistics).
231     scsi/
232     - directory with info on Linux scsi support.
233     serial/
234     - directory with info on the low level serial API.
235     serial-console.txt
236     - how to set up Linux with a serial line console as the default.
237     sgi-visws.txt
238     - short blurb on the SGI Visual Workstations.
239     sh/
240     - directory with info on porting Linux to a new architecture.
241     smart-config.txt
242     - description of the Smart Config makefile feature.
243     smp.txt
244     - a few notes on symmetric multi-processing.
245     sonypi.txt
246     - info on Linux Sony Programmable I/O Device support.
247     sound/
248     - directory with info on sound card support.
249     sparc/
250     - directory with info on using Linux on Sparc architecture.
251     specialix.txt
252     - info on hardware/driver for specialix IO8+ multiport serial card.
253     spinlocks.txt
254     - info on using spinlocks to provide exclusive access in kernel.
255     stallion.txt
256     - info on using the Stallion multiport serial driver.
257     svga.txt
258     - short guide on selecting video modes at boot via VGA BIOS.
259     sx.txt
260     - info on the Specialix SX/SI multiport serial driver.
261     sysctl/
262     - directory with info on the /proc/sys/* files.
263     sysrq.txt
264     - info on the magic SysRq key.
265     telephony/
266     - directory with info on telephony (e.g. voice over IP) support.
267     time_interpolators.txt
268     - info on time interpolators.
269     tipar.txt
270     - information about Parallel link cable for Texas Instruments handhelds.
271     tty.txt
272     - guide to the locking policies of the tty layer.
273     unicode.txt
274     - info on the Unicode character/font mapping used in Linux.
275     uml/
276     - directory with infomation about User Mode Linux.
277     usb/
278     - directory with info regarding the Universal Serial Bus.
279     video4linux/
280     - directory with info regarding video/TV/radio cards and linux.
281     vm/
282     - directory with info on the Linux vm code.
283     voyager.txt
284     - guide to running Linux on the Voyager architecture.
285     watchdog/
286     - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
287     x86_64/
288     - directory with info on Linux support for AMD x86-64 (Hammer) machines.
289     xterm-linux.xpm
290     - XPM image of penguin logo (see logo.txt) sitting on an xterm.
291     zorro.txt
292     - info on writing drivers for Zorro bus devices found on Amigas.