Commit a7ddcea58ae22d85d94eabfdd3de75c3742e376b

Authored by Henrik Austad
Committed by Jonathan Corbet
1 parent 9d92e4835f

Drop all 00-INDEX files from Documentation/

This is a respin with a wider audience (all that get_maintainer returned)
and I know this spams a *lot* of people. Not sure what would be the correct
way, so my apologies for ruining your inbox.

The 00-INDEX files are supposed to give a summary of all files present
in a directory, but these files are horribly out of date and their
usefulness is brought into question. Often a simple "ls" would reveal
the same information as the filenames are generally quite descriptive as
a short introduction to what the file covers (it should not surprise
anyone what Documentation/sched/sched-design-CFS.txt covers)

A few years back it was mentioned that these files were no longer really
needed, and they have since then grown further out of date, so perhaps
it is time to just throw them out.

A short status yields the following _outdated_ 00-INDEX files, first
counter is files listed in 00-INDEX but missing in the directory, last
is files present but not listed in 00-INDEX.

List of outdated 00-INDEX:
Documentation: (4/10)
Documentation/sysctl: (0/1)
Documentation/timers: (1/0)
Documentation/blockdev: (3/1)
Documentation/w1/slaves: (0/1)
Documentation/locking: (0/1)
Documentation/devicetree: (0/5)
Documentation/power: (1/1)
Documentation/powerpc: (0/5)
Documentation/arm: (1/0)
Documentation/x86: (0/9)
Documentation/x86/x86_64: (1/1)
Documentation/scsi: (4/4)
Documentation/filesystems: (2/9)
Documentation/filesystems/nfs: (0/2)
Documentation/cgroup-v1: (0/2)
Documentation/kbuild: (0/4)
Documentation/spi: (1/0)
Documentation/virtual/kvm: (1/0)
Documentation/scheduler: (0/2)
Documentation/fb: (0/1)
Documentation/block: (0/1)
Documentation/networking: (6/37)
Documentation/vm: (1/3)

Then there are 364 subdirectories in Documentation/ with several files that
are missing 00-INDEX alltogether (and another 120 with a single file and no
00-INDEX).

I don't really have an opinion to whether or not we /should/ have 00-INDEX,
but the above 00-INDEX should either be removed or be kept up to date. If
we should keep the files, I can try to keep them updated, but I rather not
if we just want to delete them anyway.

As a starting point, remove all index-files and references to 00-INDEX and
see where the discussion is going.

Signed-off-by: Henrik Austad <henrik@austad.us>
Acked-by: "Paul E. McKenney" <paulmck@linux.vnet.ibm.com>
Just-do-it-by: Steven Rostedt <rostedt@goodmis.org>
Reviewed-by: Jens Axboe <axboe@kernel.dk>
Acked-by: Paul Moore <paul@paul-moore.com>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: Mark Brown <broonie@kernel.org>
Acked-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
Cc: [Almost everybody else]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

Showing 50 changed files with 8 additions and 1896 deletions Side-by-side Diff

Documentation/00-INDEX
1   -
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 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@listserv.linux.or.jp), at
11   - http://linuxjf.sourceforge.jp/
12   -
13   -00-INDEX
14   - - this file.
15   -ABI/
16   - - info on kernel <-> userspace ABI and relative interface stability.
17   -CodingStyle
18   - - nothing here, just a pointer to process/coding-style.rst.
19   -DMA-API.txt
20   - - DMA API, pci_ API & extensions for non-consistent memory machines.
21   -DMA-API-HOWTO.txt
22   - - Dynamic DMA mapping Guide
23   -DMA-ISA-LPC.txt
24   - - How to do DMA with ISA (and LPC) devices.
25   -DMA-attributes.txt
26   - - listing of the various possible attributes a DMA region can have
27   -EDID/
28   - - directory with info on customizing EDID for broken gfx/displays.
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   -IRQ-domain.txt
34   - - info on interrupt numbering and setting up IRQ domains.
35   -IRQ.txt
36   - - description of what an IRQ is.
37   -Intel-IOMMU.txt
38   - - basic info on the Intel IOMMU virtualization support.
39   -Makefile
40   - - It's not of interest for those who aren't touching the build system.
41   -PCI/
42   - - info related to PCI drivers.
43   -RCU/
44   - - directory with info on RCU (read-copy update).
45   -SAK.txt
46   - - info on Secure Attention Keys.
47   -SM501.txt
48   - - Silicon Motion SM501 multimedia companion chip
49   -SubmittingPatches
50   - - nothing here, just a pointer to process/coding-style.rst.
51   -accounting/
52   - - documentation on accounting and taskstats.
53   -acpi/
54   - - info on ACPI-specific hooks in the kernel.
55   -admin-guide/
56   - - info related to Linux users and system admins.
57   -aoe/
58   - - description of AoE (ATA over Ethernet) along with config examples.
59   -arm/
60   - - directory with info about Linux on the ARM architecture.
61   -arm64/
62   - - directory with info about Linux on the 64 bit ARM architecture.
63   -auxdisplay/
64   - - misc. LCD driver documentation (cfag12864b, ks0108).
65   -backlight/
66   - - directory with info on controlling backlights in flat panel displays
67   -block/
68   - - info on the Block I/O (BIO) layer.
69   -blockdev/
70   - - info on block devices & drivers
71   -bt8xxgpio.txt
72   - - info on how to modify a bt8xx video card for GPIO usage.
73   -btmrvl.txt
74   - - info on Marvell Bluetooth driver usage.
75   -bus-devices/
76   - - directory with info on TI GPMC (General Purpose Memory Controller)
77   -bus-virt-phys-mapping.txt
78   - - how to access I/O mapped memory from within device drivers.
79   -cdrom/
80   - - directory with information on the CD-ROM drivers that Linux has.
81   -cgroup-v1/
82   - - cgroups v1 features, including cpusets and memory controller.
83   -cma/
84   - - Continuous Memory Area (CMA) debugfs interface.
85   -conf.py
86   - - It's not of interest for those who aren't touching the build system.
87   -connector/
88   - - docs on the netlink based userspace<->kernel space communication mod.
89   -console/
90   - - documentation on Linux console drivers.
91   -core-api/
92   - - documentation on kernel core components.
93   -cpu-freq/
94   - - info on CPU frequency and voltage scaling.
95   -cpu-hotplug.txt
96   - - document describing CPU hotplug support in the Linux kernel.
97   -cpu-load.txt
98   - - document describing how CPU load statistics are collected.
99   -cpuidle/
100   - - info on CPU_IDLE, CPU idle state management subsystem.
101   -cputopology.txt
102   - - documentation on how CPU topology info is exported via sysfs.
103   -crc32.txt
104   - - brief tutorial on CRC computation
105   -crypto/
106   - - directory with info on the Crypto API.
107   -dcdbas.txt
108   - - information on the Dell Systems Management Base Driver.
109   -debugging-modules.txt
110   - - some notes on debugging modules after Linux 2.6.3.
111   -debugging-via-ohci1394.txt
112   - - how to use firewire like a hardware debugger memory reader.
113   -dell_rbu.txt
114   - - document demonstrating the use of the Dell Remote BIOS Update driver.
115   -dev-tools/
116   - - directory with info on development tools for the kernel.
117   -device-mapper/
118   - - directory with info on Device Mapper.
119   -dmaengine/
120   - - the DMA engine and controller API guides.
121   -devicetree/
122   - - directory with info on device tree files used by OF/PowerPC/ARM
123   -digsig.txt
124   - -info on the Digital Signature Verification API
125   -dma-buf-sharing.txt
126   - - the DMA Buffer Sharing API Guide
127   -docutils.conf
128   - - nothing here. Just a configuration file for docutils.
129   -dontdiff
130   - - file containing a list of files that should never be diff'ed.
131   -driver-api/
132   - - the Linux driver implementer's API guide.
133   -driver-model/
134   - - directory with info about Linux driver model.
135   -early-userspace/
136   - - info about initramfs, klibc, and userspace early during boot.
137   -efi-stub.txt
138   - - How to use the EFI boot stub to bypass GRUB or elilo on EFI systems.
139   -eisa.txt
140   - - info on EISA bus support.
141   -extcon/
142   - - directory with porting guide for Android kernel switch driver.
143   -isa.txt
144   - - info on EISA bus support.
145   -fault-injection/
146   - - dir with docs about the fault injection capabilities infrastructure.
147   -fb/
148   - - directory with info on the frame buffer graphics abstraction layer.
149   -features/
150   - - status of feature implementation on different architectures.
151   -filesystems/
152   - - info on the vfs and the various filesystems that Linux supports.
153   -firmware_class/
154   - - request_firmware() hotplug interface info.
155   -flexible-arrays.txt
156   - - how to make use of flexible sized arrays in linux
157   -fmc/
158   - - information about the FMC bus abstraction
159   -fpga/
160   - - FPGA Manager Core.
161   -futex-requeue-pi.txt
162   - - info on requeueing of tasks from a non-PI futex to a PI futex
163   -gcc-plugins.txt
164   - - GCC plugin infrastructure.
165   -gpio/
166   - - gpio related documentation
167   -gpu/
168   - - directory with information on GPU driver developer's guide.
169   -hid/
170   - - directory with information on human interface devices
171   -highuid.txt
172   - - notes on the change from 16 bit to 32 bit user/group IDs.
173   -hwspinlock.txt
174   - - hardware spinlock provides hardware assistance for synchronization
175   -timers/
176   - - info on the timer related topics
177   -hw_random.txt
178   - - info on Linux support for random number generator in i8xx chipsets.
179   -hwmon/
180   - - directory with docs on various hardware monitoring drivers.
181   -i2c/
182   - - directory with info about the I2C bus/protocol (2 wire, kHz speed).
183   -x86/i386/
184   - - directory with info about Linux on Intel 32 bit architecture.
185   -ia64/
186   - - directory with info about Linux on Intel 64 bit architecture.
187   -ide/
188   - - Information regarding the Enhanced IDE drive.
189   -iio/
190   - - info on industrial IIO configfs support.
191   -index.rst
192   - - main index for the documentation at ReST format.
193   -infiniband/
194   - - directory with documents concerning Linux InfiniBand support.
195   -input/
196   - - info on Linux input device support.
197   -intel_txt.txt
198   - - info on intel Trusted Execution Technology (intel TXT).
199   -io-mapping.txt
200   - - description of io_mapping functions in linux/io-mapping.h
201   -io_ordering.txt
202   - - info on ordering I/O writes to memory-mapped addresses.
203   -ioctl/
204   - - directory with documents describing various IOCTL calls.
205   -iostats.txt
206   - - info on I/O statistics Linux kernel provides.
207   -irqflags-tracing.txt
208   - - how to use the irq-flags tracing feature.
209   -isapnp.txt
210   - - info on Linux ISA Plug & Play support.
211   -isdn/
212   - - directory with info on the Linux ISDN support, and supported cards.
213   -kbuild/
214   - - directory with info about the kernel build process.
215   -kdump/
216   - - directory with mini HowTo on getting the crash dump code to work.
217   -doc-guide/
218   - - how to write and format reStructuredText kernel documentation
219   -kernel-per-CPU-kthreads.txt
220   - - List of all per-CPU kthreads and how they introduce jitter.
221   -kobject.txt
222   - - info of the kobject infrastructure of the Linux kernel.
223   -kprobes.txt
224   - - documents the kernel probes debugging feature.
225   -kref.txt
226   - - docs on adding reference counters (krefs) to kernel objects.
227   -laptops/
228   - - directory with laptop related info and laptop driver documentation.
229   -ldm.txt
230   - - a brief description of LDM (Windows Dynamic Disks).
231   -leds/
232   - - directory with info about LED handling under Linux.
233   -livepatch/
234   - - info on kernel live patching.
235   -locking/
236   - - directory with info about kernel locking primitives
237   -lockup-watchdogs.txt
238   - - info on soft and hard lockup detectors (aka nmi_watchdog).
239   -logo.gif
240   - - full colour GIF image of Linux logo (penguin - Tux).
241   -logo.txt
242   - - info on creator of above logo & site to get additional images from.
243   -lsm.txt
244   - - Linux Security Modules: General Security Hooks for Linux
245   -lzo.txt
246   - - kernel LZO decompressor input formats
247   -m68k/
248   - - directory with info about Linux on Motorola 68k architecture.
249   -mailbox.txt
250   - - How to write drivers for the common mailbox framework (IPC).
251   -md/
252   - - directory with info about Linux Software RAID
253   -media/
254   - - info on media drivers: uAPI, kAPI and driver documentation.
255   -memory-barriers.txt
256   - - info on Linux kernel memory barriers.
257   -memory-devices/
258   - - directory with info on parts like the Texas Instruments EMIF driver
259   -memory-hotplug.txt
260   - - Hotpluggable memory support, how to use and current status.
261   -men-chameleon-bus.txt
262   - - info on MEN chameleon bus.
263   -mic/
264   - - Intel Many Integrated Core (MIC) architecture device driver.
265   -mips/
266   - - directory with info about Linux on MIPS architecture.
267   -misc-devices/
268   - - directory with info about devices using the misc dev subsystem
269   -mmc/
270   - - directory with info about the MMC subsystem
271   -mtd/
272   - - directory with info about memory technology devices (flash)
273   -namespaces/
274   - - directory with various information about namespaces
275   -netlabel/
276   - - directory with information on the NetLabel subsystem.
277   -networking/
278   - - directory with info on various aspects of networking with Linux.
279   -nfc/
280   - - directory relating info about Near Field Communications support.
281   -nios2/
282   - - Linux on the Nios II architecture.
283   -nommu-mmap.txt
284   - - documentation about no-mmu memory mapping support.
285   -numastat.txt
286   - - info on how to read Numa policy hit/miss statistics in sysfs.
287   -ntb.txt
288   - - info on Non-Transparent Bridge (NTB) drivers.
289   -nvdimm/
290   - - info on non-volatile devices.
291   -nvmem/
292   - - info on non volatile memory framework.
293   -output/
294   - - default directory where html/LaTeX/pdf files will be written.
295   -padata.txt
296   - - An introduction to the "padata" parallel execution API
297   -parisc/
298   - - directory with info on using Linux on PA-RISC architecture.
299   -parport-lowlevel.txt
300   - - description and usage of the low level parallel port functions.
301   -pcmcia/
302   - - info on the Linux PCMCIA driver.
303   -percpu-rw-semaphore.txt
304   - - RCU based read-write semaphore optimized for locking for reading
305   -perf/
306   - - info about the APM X-Gene SoC Performance Monitoring Unit (PMU).
307   -phy/
308   - - ino on Samsung USB 2.0 PHY adaptation layer.
309   -phy.txt
310   - - Description of the generic PHY framework.
311   -pi-futex.txt
312   - - documentation on lightweight priority inheritance futexes.
313   -pinctrl.txt
314   - - info on pinctrl subsystem and the PINMUX/PINCONF and drivers
315   -platform/
316   - - List of supported hardware by compal and Dell laptop.
317   -pnp.txt
318   - - Linux Plug and Play documentation.
319   -power/
320   - - directory with info on Linux PCI power management.
321   -powerpc/
322   - - directory with info on using Linux with the PowerPC.
323   -prctl/
324   - - directory with info on the priveledge control subsystem
325   -preempt-locking.txt
326   - - info on locking under a preemptive kernel.
327   -process/
328   - - how to work with the mainline kernel development process.
329   -pps/
330   - - directory with information on the pulse-per-second support
331   -pti/
332   - - directory with info on Intel MID PTI.
333   -ptp/
334   - - directory with info on support for IEEE 1588 PTP clocks in Linux.
335   -pwm.txt
336   - - info on the pulse width modulation driver subsystem
337   -rapidio/
338   - - directory with info on RapidIO packet-based fabric interconnect
339   -rbtree.txt
340   - - info on what red-black trees are and what they are for.
341   -remoteproc.txt
342   - - info on how to handle remote processor (e.g. AMP) offloads/usage.
343   -rfkill.txt
344   - - info on the radio frequency kill switch subsystem/support.
345   -robust-futex-ABI.txt
346   - - documentation of the robust futex ABI.
347   -robust-futexes.txt
348   - - a description of what robust futexes are.
349   -rpmsg.txt
350   - - info on the Remote Processor Messaging (rpmsg) Framework
351   -rtc.txt
352   - - notes on how to use the Real Time Clock (aka CMOS clock) driver.
353   -s390/
354   - - directory with info on using Linux on the IBM S390.
355   -scheduler/
356   - - directory with info on the scheduler.
357   -scsi/
358   - - directory with info on Linux scsi support.
359   -security/
360   - - directory that contains security-related info
361   -serial/
362   - - directory with info on the low level serial API.
363   -sgi-ioc4.txt
364   - - description of the SGI IOC4 PCI (multi function) device.
365   -sh/
366   - - directory with info on porting Linux to a new architecture.
367   -smsc_ece1099.txt
368   - -info on the smsc Keyboard Scan Expansion/GPIO Expansion device.
369   -sound/
370   - - directory with info on sound card support.
371   -spi/
372   - - overview of Linux kernel Serial Peripheral Interface (SPI) support.
373   -sphinx/
374   - - no documentation here, just files required by Sphinx toolchain.
375   -sphinx-static/
376   - - no documentation here, just files required by Sphinx toolchain.
377   -static-keys.txt
378   - - info on how static keys allow debug code in hotpaths via patching
379   -svga.txt
380   - - short guide on selecting video modes at boot via VGA BIOS.
381   -sync_file.txt
382   - - Sync file API guide.
383   -sysctl/
384   - - directory with info on the /proc/sys/* files.
385   -target/
386   - - directory with info on generating TCM v4 fabric .ko modules
387   -tee.txt
388   - - info on the TEE subsystem and drivers
389   -this_cpu_ops.txt
390   - - List rationale behind and the way to use this_cpu operations.
391   -thermal/
392   - - directory with information on managing thermal issues (CPU/temp)
393   -trace/
394   - - directory with info on tracing technologies within linux
395   -translations/
396   - - translations of this document from English to another language
397   -unaligned-memory-access.txt
398   - - info on how to avoid arch breaking unaligned memory access in code.
399   -unshare.txt
400   - - description of the Linux unshare system call.
401   -usb/
402   - - directory with info regarding the Universal Serial Bus.
403   -vfio.txt
404   - - info on Virtual Function I/O used in guest/hypervisor instances.
405   -video-output.txt
406   - - sysfs class driver interface to enable/disable a video output device.
407   -virtual/
408   - - directory with information on the various linux virtualizations.
409   -vm/
410   - - directory with info on the Linux vm code.
411   -w1/
412   - - directory with documents regarding the 1-wire (w1) subsystem.
413   -watchdog/
414   - - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
415   -wimax/
416   - - directory with info about Intel Wireless Wimax Connections
417   -core-api/workqueue.rst
418   - - information on the Concurrency Managed Workqueue implementation
419   -x86/x86_64/
420   - - directory with info on Linux support for AMD x86-64 (Hammer) machines.
421   -xillybus.txt
422   - - Overview and basic ui of xillybus driver
423   -xtensa/
424   - - directory with documents relating to arch/xtensa port/implementation
425   -xz.txt
426   - - how to make use of the XZ data compression within linux kernel
427   -zorro.txt
428   - - info on writing drivers for Zorro bus devices found on Amigas.
Documentation/PCI/00-INDEX
1   -00-INDEX
2   - - this file
3   -acpi-info.txt
4   - - info on how PCI host bridges are represented in ACPI
5   -MSI-HOWTO.txt
6   - - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
7   -PCIEBUS-HOWTO.txt
8   - - a guide describing the PCI Express Port Bus driver
9   -pci-error-recovery.txt
10   - - info on PCI error recovery
11   -pci-iov-howto.txt
12   - - the PCI Express I/O Virtualization HOWTO
13   -pci.txt
14   - - info on the PCI subsystem for device driver authors
15   -pcieaer-howto.txt
16   - - the PCI Express Advanced Error Reporting Driver Guide HOWTO
17   -endpoint/pci-endpoint.txt
18   - - guide to add endpoint controller driver and endpoint function driver.
19   -endpoint/pci-endpoint-cfs.txt
20   - - guide to use configfs to configure the PCI endpoint function.
21   -endpoint/pci-test-function.txt
22   - - specification of *PCI test* function device.
23   -endpoint/pci-test-howto.txt
24   - - userguide for PCI endpoint test function.
25   -endpoint/function/binding/
26   - - binding documentation for PCI endpoint function
Documentation/RCU/00-INDEX
1   -00-INDEX
2   - - This file
3   -arrayRCU.txt
4   - - Using RCU to Protect Read-Mostly Arrays
5   -checklist.txt
6   - - Review Checklist for RCU Patches
7   -listRCU.txt
8   - - Using RCU to Protect Read-Mostly Linked Lists
9   -lockdep.txt
10   - - RCU and lockdep checking
11   -lockdep-splat.txt
12   - - RCU Lockdep splats explained.
13   -NMI-RCU.txt
14   - - Using RCU to Protect Dynamic NMI Handlers
15   -rcu_dereference.txt
16   - - Proper care and feeding of return values from rcu_dereference()
17   -rcubarrier.txt
18   - - RCU and Unloadable Modules
19   -rculist_nulls.txt
20   - - RCU list primitives for use with SLAB_TYPESAFE_BY_RCU
21   -rcuref.txt
22   - - Reference-count design for elements of lists/arrays protected by RCU
23   -rcu.txt
24   - - RCU Concepts
25   -RTFP.txt
26   - - List of RCU papers (bibliography) going back to 1980.
27   -stallwarn.txt
28   - - RCU CPU stall warnings (module parameter rcu_cpu_stall_suppress)
29   -torture.txt
30   - - RCU Torture Test Operation (CONFIG_RCU_TORTURE_TEST)
31   -UP.txt
32   - - RCU on Uniprocessor Systems
33   -whatisRCU.txt
34   - - What is RCU?
Documentation/RCU/rcu.txt
... ... @@ -87,8 +87,4 @@
87 87  
88 88 See the RTFP.txt file in this directory.
89 89 Or point your browser at http://www.rdrop.com/users/paulmck/RCU/.
90   -
91   -o What are all these files in this directory?
92   -
93   - See 00-INDEX for the list.
Documentation/admin-guide/README.rst
... ... @@ -51,8 +51,7 @@
51 51  
52 52 - There are various README files in the Documentation/ subdirectory:
53 53 these typically contain kernel-specific installation notes for some
54   - drivers for example. See Documentation/00-INDEX for a list of what
55   - is contained in each file. Please read the
  54 + drivers for example. Please read the
56 55 :ref:`Documentation/process/changes.rst <changes>` file, as it
57 56 contains information about the problems, which may result by upgrading
58 57 your kernel.
Documentation/arm/00-INDEX
1   -00-INDEX
2   - - this file
3   -Booting
4   - - requirements for booting
5   -CCN.txt
6   - - Cache Coherent Network ring-bus and perf PMU driver.
7   -Interrupts
8   - - ARM Interrupt subsystem documentation
9   -IXP4xx
10   - - Intel IXP4xx Network processor.
11   -Netwinder
12   - - Netwinder specific documentation
13   -Porting
14   - - Symbol definitions for porting Linux to a new ARM machine.
15   -Setup
16   - - Kernel initialization parameters on ARM Linux
17   -README
18   - - General ARM documentation
19   -SA1100/
20   - - SA1100 documentation
21   -Samsung-S3C24XX/
22   - - S3C24XX ARM Linux Overview
23   -SPEAr/
24   - - ST SPEAr platform Linux Overview
25   -VFP/
26   - - Release notes for Linux Kernel Vector Floating Point support code
27   -cluster-pm-race-avoidance.txt
28   - - Algorithm for CPU and Cluster setup/teardown
29   -empeg/
30   - - Ltd's Empeg MP3 Car Audio Player
31   -firmware.txt
32   - - Secure firmware registration and calling.
33   -kernel_mode_neon.txt
34   - - How to use NEON instructions in kernel mode
35   -kernel_user_helpers.txt
36   - - Helper functions in kernel space made available for userspace.
37   -mem_alignment
38   - - alignment abort handler documentation
39   -memory.txt
40   - - description of the virtual memory layout
41   -nwfpe/
42   - - NWFPE floating point emulator documentation
43   -swp_emulation
44   - - SWP/SWPB emulation handler/logging description
45   -tcm.txt
46   - - ARM Tightly Coupled Memory
47   -uefi.txt
48   - - [U]EFI configuration and runtime services documentation
49   -vlocks.txt
50   - - Voting locks, low-level mechanism relying on memory system atomic writes.
Documentation/block/00-INDEX
1   -00-INDEX
2   - - This file
3   -bfq-iosched.txt
4   - - BFQ IO scheduler and its tunables
5   -biodoc.txt
6   - - Notes on the Generic Block Layer Rewrite in Linux 2.5
7   -biovecs.txt
8   - - Immutable biovecs and biovec iterators
9   -capability.txt
10   - - Generic Block Device Capability (/sys/block/<device>/capability)
11   -cfq-iosched.txt
12   - - CFQ IO scheduler tunables
13   -cmdline-partition.txt
14   - - how to specify block device partitions on kernel command line
15   -data-integrity.txt
16   - - Block data integrity
17   -deadline-iosched.txt
18   - - Deadline IO scheduler tunables
19   -ioprio.txt
20   - - Block io priorities (in CFQ scheduler)
21   -pr.txt
22   - - Block layer support for Persistent Reservations
23   -null_blk.txt
24   - - Null block for block-layer benchmarking.
25   -queue-sysfs.txt
26   - - Queue's sysfs entries
27   -request.txt
28   - - The members of struct request (in include/linux/blkdev.h)
29   -stat.txt
30   - - Block layer statistics in /sys/block/<device>/stat
31   -switching-sched.txt
32   - - Switching I/O schedulers at runtime
33   -writeback_cache_control.txt
34   - - Control of volatile write back caches
Documentation/blockdev/00-INDEX
1   -00-INDEX
2   - - this file
3   -README.DAC960
4   - - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
5   -cciss.txt
6   - - info, major/minor #'s for Compaq's SMART Array Controllers.
7   -cpqarray.txt
8   - - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
9   -floppy.txt
10   - - notes and driver options for the floppy disk driver.
11   -mflash.txt
12   - - info on mGine m(g)flash driver for linux.
13   -nbd.txt
14   - - info on a TCP implementation of a network block device.
15   -paride.txt
16   - - information about the parallel port IDE subsystem.
17   -ramdisk.txt
18   - - short guide on how to set up and use the RAM disk.
Documentation/cdrom/00-INDEX
1   -00-INDEX
2   - - this file (info on CD-ROMs and Linux)
3   -Makefile
4   - - only used to generate TeX output from the documentation.
5   -cdrom-standard.tex
6   - - LaTeX document on standardizing the CD-ROM programming interface.
7   -ide-cd
8   - - info on setting up and using ATAPI (aka IDE) CD-ROMs.
9   -packet-writing.txt
10   - - Info on the CDRW packet writing module
Documentation/cgroup-v1/00-INDEX
1   -00-INDEX
2   - - this file
3   -blkio-controller.txt
4   - - Description for Block IO Controller, implementation and usage details.
5   -cgroups.txt
6   - - Control Groups definition, implementation details, examples and API.
7   -cpuacct.txt
8   - - CPU Accounting Controller; account CPU usage for groups of tasks.
9   -cpusets.txt
10   - - documents the cpusets feature; assign CPUs and Mem to a set of tasks.
11   -admin-guide/devices.rst
12   - - Device Whitelist Controller; description, interface and security.
13   -freezer-subsystem.txt
14   - - checkpointing; rationale to not use signals, interface.
15   -hugetlb.txt
16   - - HugeTLB Controller implementation and usage details.
17   -memcg_test.txt
18   - - Memory Resource Controller; implementation details.
19   -memory.txt
20   - - Memory Resource Controller; design, accounting, interface, testing.
21   -net_cls.txt
22   - - Network classifier cgroups details and usages.
23   -net_prio.txt
24   - - Network priority cgroups details and usages.
25   -pids.txt
26   - - Process number cgroups details and usages.
Documentation/devicetree/00-INDEX
1   -Documentation for device trees, a data structure by which bootloaders pass
2   -hardware layout to Linux in a device-independent manner, simplifying hardware
3   -probing. This subsystem is maintained by Grant Likely
4   -<grant.likely@secretlab.ca> and has a mailing list at
5   -https://lists.ozlabs.org/listinfo/devicetree-discuss
6   -
7   -00-INDEX
8   - - this file
9   -booting-without-of.txt
10   - - Booting Linux without Open Firmware, describes history and format of device trees.
11   -usage-model.txt
12   - - How Linux uses DT and what DT aims to solve.
Documentation/fb/00-INDEX
1   -Index of files in Documentation/fb. If you think something about frame
2   -buffer devices needs an entry here, needs correction or you've written one
3   -please mail me.
4   - Geert Uytterhoeven <geert@linux-m68k.org>
5   -
6   -00-INDEX
7   - - this file.
8   -api.txt
9   - - The frame buffer API between applications and buffer devices.
10   -arkfb.txt
11   - - info on the fbdev driver for ARK Logic chips.
12   -aty128fb.txt
13   - - info on the ATI Rage128 frame buffer driver.
14   -cirrusfb.txt
15   - - info on the driver for Cirrus Logic chipsets.
16   -cmap_xfbdev.txt
17   - - an introduction to fbdev's cmap structures.
18   -deferred_io.txt
19   - - an introduction to deferred IO.
20   -efifb.txt
21   - - info on the EFI platform driver for Intel based Apple computers.
22   -ep93xx-fb.txt
23   - - info on the driver for EP93xx LCD controller.
24   -fbcon.txt
25   - - intro to and usage guide for the framebuffer console (fbcon).
26   -framebuffer.txt
27   - - introduction to frame buffer devices.
28   -gxfb.txt
29   - - info on the framebuffer driver for AMD Geode GX2 based processors.
30   -intel810.txt
31   - - documentation for the Intel 810/815 framebuffer driver.
32   -intelfb.txt
33   - - docs for Intel 830M/845G/852GM/855GM/865G/915G/945G fb driver.
34   -internals.txt
35   - - quick overview of frame buffer device internals.
36   -lxfb.txt
37   - - info on the framebuffer driver for AMD Geode LX based processors.
38   -matroxfb.txt
39   - - info on the Matrox framebuffer driver for Alpha, Intel and PPC.
40   -metronomefb.txt
41   - - info on the driver for the Metronome display controller.
42   -modedb.txt
43   - - info on the video mode database.
44   -pvr2fb.txt
45   - - info on the PowerVR 2 frame buffer driver.
46   -pxafb.txt
47   - - info on the driver for the PXA25x LCD controller.
48   -s3fb.txt
49   - - info on the fbdev driver for S3 Trio/Virge chips.
50   -sa1100fb.txt
51   - - information about the driver for the SA-1100 LCD controller.
52   -sh7760fb.txt
53   - - info on the SH7760/SH7763 integrated LCDC Framebuffer driver.
54   -sisfb.txt
55   - - info on the framebuffer device driver for various SiS chips.
56   -sm501.txt
57   - - info on the framebuffer device driver for sm501 videoframebuffer.
58   -sstfb.txt
59   - - info on the frame buffer driver for 3dfx' Voodoo Graphics boards.
60   -tgafb.txt
61   - - info on the TGA (DECChip 21030) frame buffer driver.
62   -tridentfb.txt
63   - info on the framebuffer driver for some Trident chip based cards.
64   -udlfb.txt
65   - - Driver for DisplayLink USB 2.0 chips.
66   -uvesafb.txt
67   - - info on the userspace VESA (VBE2+ compliant) frame buffer device.
68   -vesafb.txt
69   - - info on the VESA frame buffer device.
70   -viafb.modes
71   - - list of modes for VIA Integration Graphic Chip.
72   -viafb.txt
73   - - info on the VIA Integration Graphic Chip console framebuffer driver.
74   -vt8623fb.txt
75   - - info on the fb driver for the graphics core in VIA VT8623 chipsets.
Documentation/filesystems/00-INDEX
1   -00-INDEX
2   - - this file (info on some of the filesystems supported by linux).
3   -Locking
4   - - info on locking rules as they pertain to Linux VFS.
5   -9p.txt
6   - - 9p (v9fs) is an implementation of the Plan 9 remote fs protocol.
7   -adfs.txt
8   - - info and mount options for the Acorn Advanced Disc Filing System.
9   -afs.txt
10   - - info and examples for the distributed AFS (Andrew File System) fs.
11   -affs.txt
12   - - info and mount options for the Amiga Fast File System.
13   -autofs-mount-control.txt
14   - - info on device control operations for autofs module.
15   -automount-support.txt
16   - - information about filesystem automount support.
17   -befs.txt
18   - - information about the BeOS filesystem for Linux.
19   -bfs.txt
20   - - info for the SCO UnixWare Boot Filesystem (BFS).
21   -btrfs.txt
22   - - info for the BTRFS filesystem.
23   -caching/
24   - - directory containing filesystem cache documentation.
25   -ceph.txt
26   - - info for the Ceph Distributed File System.
27   -cifs/
28   - - directory containing CIFS filesystem documentation and example code.
29   -coda.txt
30   - - description of the CODA filesystem.
31   -configfs/
32   - - directory containing configfs documentation and example code.
33   -cramfs.txt
34   - - info on the cram filesystem for small storage (ROMs etc).
35   -dax.txt
36   - - info on avoiding the page cache for files stored on CPU-addressable
37   - storage devices.
38   -debugfs.txt
39   - - info on the debugfs filesystem.
40   -devpts.txt
41   - - info on the devpts filesystem.
42   -directory-locking
43   - - info about the locking scheme used for directory operations.
44   -dlmfs.txt
45   - - info on the userspace interface to the OCFS2 DLM.
46   -dnotify.txt
47   - - info about directory notification in Linux.
48   -dnotify_test.c
49   - - example program for dnotify.
50   -ecryptfs.txt
51   - - docs on eCryptfs: stacked cryptographic filesystem for Linux.
52   -efivarfs.txt
53   - - info for the efivarfs filesystem.
54   -exofs.txt
55   - - info, usage, mount options, design about EXOFS.
56   -ext2.txt
57   - - info, mount options and specifications for the Ext2 filesystem.
58   -ext3.txt
59   - - info, mount options and specifications for the Ext3 filesystem.
60   -ext4.txt
61   - - info, mount options and specifications for the Ext4 filesystem.
62   -f2fs.txt
63   - - info and mount options for the F2FS filesystem.
64   -fiemap.txt
65   - - info on fiemap ioctl.
66   -files.txt
67   - - info on file management in the Linux kernel.
68   -fuse.txt
69   - - info on the Filesystem in User SpacE including mount options.
70   -gfs2-glocks.txt
71   - - info on the Global File System 2 - Glock internal locking rules.
72   -gfs2-uevents.txt
73   - - info on the Global File System 2 - uevents.
74   -gfs2.txt
75   - - info on the Global File System 2.
76   -hfs.txt
77   - - info on the Macintosh HFS Filesystem for Linux.
78   -hfsplus.txt
79   - - info on the Macintosh HFSPlus Filesystem for Linux.
80   -hpfs.txt
81   - - info and mount options for the OS/2 HPFS.
82   -inotify.txt
83   - - info on the powerful yet simple file change notification system.
84   -isofs.txt
85   - - info and mount options for the ISO 9660 (CDROM) filesystem.
86   -jfs.txt
87   - - info and mount options for the JFS filesystem.
88   -locks.txt
89   - - info on file locking implementations, flock() vs. fcntl(), etc.
90   -mandatory-locking.txt
91   - - info on the Linux implementation of Sys V mandatory file locking.
92   -nfs/
93   - - nfs-related documentation.
94   -nilfs2.txt
95   - - info and mount options for the NILFS2 filesystem.
96   -ntfs.txt
97   - - info and mount options for the NTFS filesystem (Windows NT).
98   -ocfs2.txt
99   - - info and mount options for the OCFS2 clustered filesystem.
100   -omfs.txt
101   - - info on the Optimized MPEG FileSystem.
102   -path-lookup.txt
103   - - info on path walking and name lookup locking.
104   -pohmelfs/
105   - - directory containing pohmelfs filesystem documentation.
106   -porting
107   - - various information on filesystem porting.
108   -proc.txt
109   - - info on Linux's /proc filesystem.
110   -qnx6.txt
111   - - info on the QNX6 filesystem.
112   -quota.txt
113   - - info on Quota subsystem.
114   -ramfs-rootfs-initramfs.txt
115   - - info on the 'in memory' filesystems ramfs, rootfs and initramfs.
116   -relay.txt
117   - - info on relay, for efficient streaming from kernel to user space.
118   -romfs.txt
119   - - description of the ROMFS filesystem.
120   -seq_file.txt
121   - - how to use the seq_file API.
122   -sharedsubtree.txt
123   - - a description of shared subtrees for namespaces.
124   -spufs.txt
125   - - info and mount options for the SPU filesystem used on Cell.
126   -squashfs.txt
127   - - info on the squashfs filesystem.
128   -sysfs-pci.txt
129   - - info on accessing PCI device resources through sysfs.
130   -sysfs-tagging.txt
131   - - info on sysfs tagging to avoid duplicates.
132   -sysfs.txt
133   - - info on sysfs, a ram-based filesystem for exporting kernel objects.
134   -sysv-fs.txt
135   - - info on the SystemV/V7/Xenix/Coherent filesystem.
136   -tmpfs.txt
137   - - info on tmpfs, a filesystem that holds all files in virtual memory.
138   -ubifs.txt
139   - - info on the Unsorted Block Images FileSystem.
140   -udf.txt
141   - - info and mount options for the UDF filesystem.
142   -ufs.txt
143   - - info on the ufs filesystem.
144   -vfat.txt
145   - - info on using the VFAT filesystem used in Windows NT and Windows 95.
146   -vfs.txt
147   - - overview of the Virtual File System.
148   -xfs-delayed-logging-design.txt
149   - - info on the XFS Delayed Logging Design.
150   -xfs-self-describing-metadata.txt
151   - - info on XFS Self Describing Metadata.
152   -xfs.txt
153   - - info and mount options for the XFS filesystem.
Documentation/filesystems/nfs/00-INDEX
1   -00-INDEX
2   - - this file (nfs-related documentation).
3   -Exporting
4   - - explanation of how to make filesystems exportable.
5   -fault_injection.txt
6   - - information for using fault injection on the server
7   -knfsd-stats.txt
8   - - statistics which the NFS server makes available to user space.
9   -nfs.txt
10   - - nfs client, and DNS resolution for fs_locations.
11   -nfs41-server.txt
12   - - info on the Linux server implementation of NFSv4 minor version 1.
13   -nfs-rdma.txt
14   - - how to install and setup the Linux NFS/RDMA client and server software
15   -nfsd-admin-interfaces.txt
16   - - Administrative interfaces for nfsd.
17   -nfsroot.txt
18   - - short guide on setting up a diskless box with NFS root filesystem.
19   -pnfs.txt
20   - - short explanation of some of the internals of the pnfs client code
21   -rpc-cache.txt
22   - - introduction to the caching mechanisms in the sunrpc layer.
23   -idmapper.txt
24   - - information for configuring request-keys to be used by idmapper
25   -rpc-server-gss.txt
26   - - Information on GSS authentication support in the NFS Server
Documentation/fmc/00-INDEX
1   -
2   -Documentation in this directory comes from sections of the manual we
3   -wrote for the externally-developed fmc-bus package. The complete
4   -manual as of today (2013-02) is available in PDF format at
5   -http://www.ohwr.org/projects/fmc-bus/files
6   -
7   -00-INDEX
8   - - this file.
9   -
10   -FMC-and-SDB.txt
11   - - What are FMC and SDB, basic concepts for this framework
12   -
13   -API.txt
14   - - The functions that are exported by the bus driver
15   -
16   -parameters.txt
17   - - The module parameters
18   -
19   -carrier.txt
20   - - writing a carrier (a device)
21   -
22   -mezzanine.txt
23   - - writing code for your mezzanine (a driver)
24   -
25   -identifiers.txt
26   - - how identification and matching works
27   -
28   -fmc-fakedev.txt
29   - - about drivers/fmc/fmc-fakedev.ko
30   -
31   -fmc-trivial.txt
32   - - about drivers/fmc/fmc-trivial.ko
33   -
34   -fmc-write-eeprom.txt
35   - - about drivers/fmc/fmc-write-eeprom.ko
36   -
37   -fmc-chardev.txt
38   - - about drivers/fmc/fmc-chardev.ko
Documentation/gpio/00-INDEX
1   -00-INDEX
2   - - This file
3   -sysfs.txt
4   - - Information about the GPIO sysfs interface
Documentation/ide/00-INDEX
1   -00-INDEX
2   - - this file
3   -ChangeLog.ide-cd.1994-2004
4   - - ide-cd changelog
5   -ChangeLog.ide-floppy.1996-2002
6   - - ide-floppy changelog
7   -ChangeLog.ide-tape.1995-2002
8   - - ide-tape changelog
9   -ide-tape.txt
10   - - info on the IDE ATAPI streaming tape driver
11   -ide.txt
12   - - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS).
13   -warm-plug-howto.txt
14   - - using sysfs to remove and add IDE devices.
Documentation/ioctl/00-INDEX
1   -00-INDEX
2   - - this file
3   -botching-up-ioctls.txt
4   - - how to avoid botching up ioctls
5   -cdrom.txt
6   - - summary of CDROM ioctl calls
7   -hdio.txt
8   - - summary of HDIO_ ioctl calls
9   -ioctl-decoding.txt
10   - - how to decode the bits of an IOCTL code
11   -ioctl-number.txt
12   - - how to implement and register device/driver ioctl calls
Documentation/isdn/00-INDEX
1   -00-INDEX
2   - - this file (info on ISDN implementation for Linux)
3   -CREDITS
4   - - list of the kind folks that brought you this stuff.
5   -HiSax.cert
6   - - information about the ITU approval certification of the HiSax driver.
7   -INTERFACE
8   - - description of isdn4linux Link Level and Hardware Level interfaces.
9   -INTERFACE.fax
10   - - description of the fax subinterface of isdn4linux.
11   -INTERFACE.CAPI
12   - - description of kernel CAPI Link Level to Hardware Level interface.
13   -README
14   - - general info on what you need and what to do for Linux ISDN.
15   -README.FAQ
16   - - general info for FAQ.
17   -README.HiSax
18   - - info on the HiSax driver which replaces the old teles.
19   -README.audio
20   - - info for running audio over ISDN.
21   -README.avmb1
22   - - info on driver for AVM-B1 ISDN card.
23   -README.concap
24   - - info on "CONCAP" encapsulation protocol interface used for X.25.
25   -README.diversion
26   - - info on module for isdn diversion services.
27   -README.fax
28   - - info for using Fax over ISDN.
29   -README.gigaset
30   - - info on the drivers for Siemens Gigaset ISDN adapters
31   -README.hfc-pci
32   - - info on hfc-pci based cards.
33   -README.hysdn
34   - - info on driver for Hypercope active HYSDN cards
35   -README.mISDN
36   - - info on the Modular ISDN subsystem (mISDN)
37   -README.syncppp
38   - - info on running Sync PPP over ISDN.
39   -README.x25
40   - - info for running X.25 over ISDN.
41   -syncPPP.FAQ
42   - - frequently asked questions about running PPP over ISDN.
Documentation/kbuild/00-INDEX
1   -00-INDEX
2   - - this file: info on the kernel build process
3   -headers_install.txt
4   - - how to export Linux headers for use by userspace
5   -kbuild.txt
6   - - developer information on kbuild
7   -kconfig.txt
8   - - usage help for make *config
9   -kconfig-language.txt
10   - - specification of Config Language, the language in Kconfig files
11   -makefiles.txt
12   - - developer information for linux kernel makefiles
13   -modules.txt
14   - - how to build modules and to install them
Documentation/laptops/00-INDEX
1   -00-INDEX
2   - - This file
3   -asus-laptop.txt
4   - - information on the Asus Laptop Extras driver.
5   -disk-shock-protection.txt
6   - - information on hard disk shock protection.
7   -laptop-mode.txt
8   - - how to conserve battery power using laptop-mode.
9   -sony-laptop.txt
10   - - Sony Notebook Control Driver (SNC) Readme.
11   -sonypi.txt
12   - - info on Linux Sony Programmable I/O Device support.
13   -thinkpad-acpi.txt
14   - - information on the (IBM and Lenovo) ThinkPad ACPI Extras driver.
15   -toshiba_haps.txt
16   - - information on the Toshiba HDD Active Protection Sensor driver.
Documentation/leds/00-INDEX
1   -00-INDEX
2   - - This file
3   -leds-blinkm.txt
4   - - Driver for BlinkM LED-devices.
5   -leds-class.txt
6   - - documents LED handling under Linux.
7   -leds-class-flash.txt
8   - - documents flash LED handling under Linux.
9   -leds-lm3556.txt
10   - - notes on how to use the leds-lm3556 driver.
11   -leds-lp3944.txt
12   - - notes on how to use the leds-lp3944 driver.
13   -leds-lp5521.txt
14   - - notes on how to use the leds-lp5521 driver.
15   -leds-lp5523.txt
16   - - notes on how to use the leds-lp5523 driver.
17   -leds-lp5562.txt
18   - - notes on how to use the leds-lp5562 driver.
19   -leds-lp55xx.txt
20   - - description about lp55xx common driver.
21   -leds-lm3556.txt
22   - - notes on how to use the leds-lm3556 driver.
23   -leds-mlxcpld.txt
24   - - notes on how to use the leds-mlxcpld driver.
25   -ledtrig-oneshot.txt
26   - - One-shot LED trigger for both sporadic and dense events.
27   -ledtrig-transient.txt
28   - - LED Transient Trigger, one shot timer activation.
29   -ledtrig-usbport.txt
30   - - notes on how to use the drivers/usb/core/ledtrig-usbport.c trigger.
31   -uleds.txt
32   - - notes on how to use the uleds driver.
Documentation/locking/00-INDEX
1   -00-INDEX
2   - - this file.
3   -lockdep-design.txt
4   - - documentation on the runtime locking correctness validator.
5   -lockstat.txt
6   - - info on collecting statistics on locks (and contention).
7   -mutex-design.txt
8   - - info on the generic mutex subsystem.
9   -rt-mutex-design.txt
10   - - description of the RealTime mutex implementation design.
11   -rt-mutex.txt
12   - - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
13   -spinlocks.txt
14   - - info on using spinlocks to provide exclusive access in kernel.
15   -ww-mutex-design.txt
16   - - Intro to Mutex wait/would deadlock handling.s
Documentation/m68k/00-INDEX
1   -00-INDEX
2   - - this file
3   -README.buddha
4   - - Amiga Buddha and Catweasel IDE Driver
5   -kernel-options.txt
6   - - command line options for Linux/m68k
Documentation/mips/00-INDEX
1   -00-INDEX
2   - - this file.
3   -AU1xxx_IDE.README
4   - - README for MIPS AU1XXX IDE driver.
Documentation/mmc/00-INDEX
1   -00-INDEX
2   - - this file
3   -mmc-dev-attrs.txt
4   - - info on SD and MMC device attributes
5   -mmc-dev-parts.txt
6   - - info on SD and MMC device partitions
7   -mmc-async-req.txt
8   - - info on mmc asynchronous requests
9   -mmc-tools.txt
10   - - info on mmc-utils tools
Documentation/netlabel/00-INDEX
1   -00-INDEX
2   - - this file.
3   -cipso_ipv4.txt
4   - - documentation on the IPv4 CIPSO protocol engine.
5   -draft-ietf-cipso-ipsecurity-01.txt
6   - - IETF draft of the CIPSO protocol, dated 16 July 1992.
7   -introduction.txt
8   - - NetLabel introduction, READ THIS FIRST.
9   -lsm_interface.txt
10   - - documentation on the NetLabel kernel security module API.
Documentation/netlabel/cipso_ipv4.txt
... ... @@ -6,11 +6,12 @@
6 6  
7 7 * Overview
8 8  
9   -The NetLabel CIPSO/IPv4 protocol engine is based on the IETF Commercial IP
10   -Security Option (CIPSO) draft from July 16, 1992. A copy of this draft can be
11   -found in this directory, consult '00-INDEX' for the filename. While the IETF
12   -draft never made it to an RFC standard it has become a de-facto standard for
13   -labeled networking and is used in many trusted operating systems.
  9 +The NetLabel CIPSO/IPv4 protocol engine is based on the IETF Commercial
  10 +IP Security Option (CIPSO) draft from July 16, 1992. A copy of this
  11 +draft can be found in this directory
  12 +(draft-ietf-cipso-ipsecurity-01.txt). While the IETF draft never made
  13 +it to an RFC standard it has become a de-facto standard for labeled
  14 +networking and is used in many trusted operating systems.
14 15  
15 16 * Outbound Packet Processing
16 17  
Documentation/netlabel/introduction.txt
... ... @@ -22,7 +22,7 @@
22 22 the NetLabel kernel security module API described below.
23 23  
24 24 Detailed information about each NetLabel protocol engine can be found in this
25   -directory, consult '00-INDEX' for filenames.
  25 +directory.
26 26  
27 27 * Communication Layer
28 28  
Documentation/networking/00-INDEX
1   -00-INDEX
2   - - this file
3   -3c509.txt
4   - - information on the 3Com Etherlink III Series Ethernet cards.
5   -6pack.txt
6   - - info on the 6pack protocol, an alternative to KISS for AX.25
7   -LICENSE.qla3xxx
8   - - GPLv2 for QLogic Linux Networking HBA Driver
9   -LICENSE.qlge
10   - - GPLv2 for QLogic Linux qlge NIC Driver
11   -LICENSE.qlcnic
12   - - GPLv2 for QLogic Linux qlcnic NIC Driver
13   -PLIP.txt
14   - - PLIP: The Parallel Line Internet Protocol device driver
15   -README.ipw2100
16   - - README for the Intel PRO/Wireless 2100 driver.
17   -README.ipw2200
18   - - README for the Intel PRO/Wireless 2915ABG and 2200BG driver.
19   -README.sb1000
20   - - info on General Instrument/NextLevel SURFboard1000 cable modem.
21   -altera_tse.txt
22   - - Altera Triple-Speed Ethernet controller.
23   -arcnet-hardware.txt
24   - - tons of info on ARCnet, hubs, jumper settings for ARCnet cards, etc.
25   -arcnet.txt
26   - - info on the using the ARCnet driver itself.
27   -atm.txt
28   - - info on where to get ATM programs and support for Linux.
29   -ax25.txt
30   - - info on using AX.25 and NET/ROM code for Linux
31   -baycom.txt
32   - - info on the driver for Baycom style amateur radio modems
33   -bonding.txt
34   - - Linux Ethernet Bonding Driver HOWTO: link aggregation in Linux.
35   -bridge.txt
36   - - where to get user space programs for ethernet bridging with Linux.
37   -cdc_mbim.txt
38   - - 3G/LTE USB modem (Mobile Broadband Interface Model)
39   -checksum-offloads.txt
40   - - Explanation of checksum offloads; LCO, RCO
41   -cops.txt
42   - - info on the COPS LocalTalk Linux driver
43   -cs89x0.txt
44   - - the Crystal LAN (CS8900/20-based) Ethernet ISA adapter driver
45   -cxacru.txt
46   - - Conexant AccessRunner USB ADSL Modem
47   -cxacru-cf.py
48   - - Conexant AccessRunner USB ADSL Modem configuration file parser
49   -cxgb.txt
50   - - Release Notes for the Chelsio N210 Linux device driver.
51   -dccp.txt
52   - - the Datagram Congestion Control Protocol (DCCP) (RFC 4340..42).
53   -dctcp.txt
54   - - DataCenter TCP congestion control
55   -de4x5.txt
56   - - the Digital EtherWORKS DE4?? and DE5?? PCI Ethernet driver
57   -decnet.txt
58   - - info on using the DECnet networking layer in Linux.
59   -dl2k.txt
60   - - README for D-Link DL2000-based Gigabit Ethernet Adapters (dl2k.ko).
61   -dm9000.txt
62   - - README for the Simtec DM9000 Network driver.
63   -dmfe.txt
64   - - info on the Davicom DM9102(A)/DM9132/DM9801 fast ethernet driver.
65   -dns_resolver.txt
66   - - The DNS resolver module allows kernel servies to make DNS queries.
67   -driver.txt
68   - - Softnet driver issues.
69   -ena.txt
70   - - info on Amazon's Elastic Network Adapter (ENA)
71   -e100.txt
72   - - info on Intel's EtherExpress PRO/100 line of 10/100 boards
73   -e1000.txt
74   - - info on Intel's E1000 line of gigabit ethernet boards
75   -e1000e.txt
76   - - README for the Intel Gigabit Ethernet Driver (e1000e).
77   -eql.txt
78   - - serial IP load balancing
79   -fib_trie.txt
80   - - Level Compressed Trie (LC-trie) notes: a structure for routing.
81   -filter.txt
82   - - Linux Socket Filtering
83   -fore200e.txt
84   - - FORE Systems PCA-200E/SBA-200E ATM NIC driver info.
85   -framerelay.txt
86   - - info on using Frame Relay/Data Link Connection Identifier (DLCI).
87   -gen_stats.txt
88   - - Generic networking statistics for netlink users.
89   -generic-hdlc.txt
90   - - The generic High Level Data Link Control (HDLC) layer.
91   -generic_netlink.txt
92   - - info on Generic Netlink
93   -gianfar.txt
94   - - Gianfar Ethernet Driver.
95   -i40e.txt
96   - - README for the Intel Ethernet Controller XL710 Driver (i40e).
97   -i40evf.txt
98   - - Short note on the Driver for the Intel(R) XL710 X710 Virtual Function
99   -ieee802154.txt
100   - - Linux IEEE 802.15.4 implementation, API and drivers
101   -igb.txt
102   - - README for the Intel Gigabit Ethernet Driver (igb).
103   -igbvf.txt
104   - - README for the Intel Gigabit Ethernet Driver (igbvf).
105   -ip-sysctl.txt
106   - - /proc/sys/net/ipv4/* variables
107   -ip_dynaddr.txt
108   - - IP dynamic address hack e.g. for auto-dialup links
109   -ipddp.txt
110   - - AppleTalk-IP Decapsulation and AppleTalk-IP Encapsulation
111   -iphase.txt
112   - - Interphase PCI ATM (i)Chip IA Linux driver info.
113   -ipsec.txt
114   - - Note on not compressing IPSec payload and resulting failed policy check.
115   -ipv6.txt
116   - - Options to the ipv6 kernel module.
117   -ipvs-sysctl.txt
118   - - Per-inode explanation of the /proc/sys/net/ipv4/vs interface.
119   -irda.txt
120   - - where to get IrDA (infrared) utilities and info for Linux.
121   -ixgb.txt
122   - - README for the Intel 10 Gigabit Ethernet Driver (ixgb).
123   -ixgbe.txt
124   - - README for the Intel 10 Gigabit Ethernet Driver (ixgbe).
125   -ixgbevf.txt
126   - - README for the Intel Virtual Function (VF) Driver (ixgbevf).
127   -l2tp.txt
128   - - User guide to the L2TP tunnel protocol.
129   -lapb-module.txt
130   - - programming information of the LAPB module.
131   -ltpc.txt
132   - - the Apple or Farallon LocalTalk PC card driver
133   -mac80211-auth-assoc-deauth.txt
134   - - authentication and association / deauth-disassoc with max80211
135   -mac80211-injection.txt
136   - - HOWTO use packet injection with mac80211
137   -multiqueue.txt
138   - - HOWTO for multiqueue network device support.
139   -netconsole.txt
140   - - The network console module netconsole.ko: configuration and notes.
141   -netdev-features.txt
142   - - Network interface features API description.
143   -netdevices.txt
144   - - info on network device driver functions exported to the kernel.
145   -netif-msg.txt
146   - - Design of the network interface message level setting (NETIF_MSG_*).
147   -netlink_mmap.txt
148   - - memory mapped I/O with netlink
149   -nf_conntrack-sysctl.txt
150   - - list of netfilter-sysctl knobs.
151   -nfc.txt
152   - - The Linux Near Field Communication (NFS) subsystem.
153   -openvswitch.txt
154   - - Open vSwitch developer documentation.
155   -operstates.txt
156   - - Overview of network interface operational states.
157   -packet_mmap.txt
158   - - User guide to memory mapped packet socket rings (PACKET_[RT]X_RING).
159   -phonet.txt
160   - - The Phonet packet protocol used in Nokia cellular modems.
161   -phy.txt
162   - - The PHY abstraction layer.
163   -pktgen.txt
164   - - User guide to the kernel packet generator (pktgen.ko).
165   -policy-routing.txt
166   - - IP policy-based routing
167   -ppp_generic.txt
168   - - Information about the generic PPP driver.
169   -proc_net_tcp.txt
170   - - Per inode overview of the /proc/net/tcp and /proc/net/tcp6 interfaces.
171   -radiotap-headers.txt
172   - - Background on radiotap headers.
173   -ray_cs.txt
174   - - Raylink Wireless LAN card driver info.
175   -rds.txt
176   - - Background on the reliable, ordered datagram delivery method RDS.
177   -regulatory.txt
178   - - Overview of the Linux wireless regulatory infrastructure.
179   -rxrpc.txt
180   - - Guide to the RxRPC protocol.
181   -s2io.txt
182   - - Release notes for Neterion Xframe I/II 10GbE driver.
183   -scaling.txt
184   - - Explanation of network scaling techniques: RSS, RPS, RFS, aRFS, XPS.
185   -sctp.txt
186   - - Notes on the Linux kernel implementation of the SCTP protocol.
187   -secid.txt
188   - - Explanation of the secid member in flow structures.
189   -skfp.txt
190   - - SysKonnect FDDI (SK-5xxx, Compaq Netelligent) driver info.
191   -smc9.txt
192   - - the driver for SMC's 9000 series of Ethernet cards
193   -spider_net.txt
194   - - README for the Spidernet Driver (as found in PS3 / Cell BE).
195   -stmmac.txt
196   - - README for the STMicro Synopsys Ethernet driver.
197   -tc-actions-env-rules.txt
198   - - rules for traffic control (tc) actions.
199   -timestamping.txt
200   - - overview of network packet timestamping variants.
201   -tcp.txt
202   - - short blurb on how TCP output takes place.
203   -tcp-thin.txt
204   - - kernel tuning options for low rate 'thin' TCP streams.
205   -team.txt
206   - - pointer to information for ethernet teaming devices.
207   -tlan.txt
208   - - ThunderLAN (Compaq Netelligent 10/100, Olicom OC-2xxx) driver info.
209   -tproxy.txt
210   - - Transparent proxy support user guide.
211   -tuntap.txt
212   - - TUN/TAP device driver, allowing user space Rx/Tx of packets.
213   -udplite.txt
214   - - UDP-Lite protocol (RFC 3828) introduction.
215   -vortex.txt
216   - - info on using 3Com Vortex (3c590, 3c592, 3c595, 3c597) Ethernet cards.
217   -vxge.txt
218   - - README for the Neterion X3100 PCIe Server Adapter.
219   -vxlan.txt
220   - - Virtual extensible LAN overview
221   -x25.txt
222   - - general info on X.25 development.
223   -x25-iface.txt
224   - - description of the X.25 Packet Layer to LAPB device interface.
225   -xfrm_device.txt
226   - - description of XFRM offload API
227   -xfrm_proc.txt
228   - - description of the statistics package for XFRM.
229   -xfrm_sync.txt
230   - - sync patches for XFRM enable migration of an SA between hosts.
231   -xfrm_sysctl.txt
232   - - description of the XFRM configuration options.
233   -z8530drv.txt
234   - - info about Linux driver for Z8530 based HDLC cards for AX.25
Documentation/parisc/00-INDEX
1   -00-INDEX
2   - - this file.
3   -debugging
4   - - some debugging hints for real-mode code
5   -registers
6   - - current/planned usage of registers
Documentation/power/00-INDEX
1   -00-INDEX
2   - - This file
3   -apm-acpi.txt
4   - - basic info about the APM and ACPI support.
5   -basic-pm-debugging.txt
6   - - Debugging suspend and resume
7   -charger-manager.txt
8   - - Battery charger management.
9   -admin-guide/devices.rst
10   - - How drivers interact with system-wide power management
11   -drivers-testing.txt
12   - - Testing suspend and resume support in device drivers
13   -freezing-of-tasks.txt
14   - - How processes and controlled during suspend
15   -interface.txt
16   - - Power management user interface in /sys/power
17   -opp.txt
18   - - Operating Performance Point library
19   -pci.txt
20   - - How the PCI Subsystem Does Power Management
21   -pm_qos_interface.txt
22   - - info on Linux PM Quality of Service interface
23   -power_supply_class.txt
24   - - Tells userspace about battery, UPS, AC or DC power supply properties
25   -runtime_pm.txt
26   - - Power management framework for I/O devices.
27   -s2ram.txt
28   - - How to get suspend to ram working (and debug it when it isn't)
29   -states.txt
30   - - System power management states
31   -suspend-and-cpuhotplug.txt
32   - - Explains the interaction between Suspend-to-RAM (S3) and CPU hotplug
33   -swsusp-and-swap-files.txt
34   - - Using swap files with software suspend (to disk)
35   -swsusp-dmcrypt.txt
36   - - How to use dm-crypt and software suspend (to disk) together
37   -swsusp.txt
38   - - Goals, implementation, and usage of software suspend (ACPI S3)
39   -tricks.txt
40   - - How to trick software suspend (to disk) into working when it isn't
41   -userland-swsusp.txt
42   - - Experimental implementation of software suspend in userspace
43   -video.txt
44   - - Video issues during resume from suspend
Documentation/powerpc/00-INDEX
1   -Index of files in Documentation/powerpc. If you think something about
2   -Linux/PPC needs an entry here, needs correction or you've written one
3   -please mail me.
4   - Cort Dougan (cort@fsmlabs.com)
5   -
6   -00-INDEX
7   - - this file
8   -bootwrapper.txt
9   - - Information on how the powerpc kernel is wrapped for boot on various
10   - different platforms.
11   -cpu_features.txt
12   - - info on how we support a variety of CPUs with minimal compile-time
13   - options.
14   -cxl.txt
15   - - Overview of the CXL driver.
16   -eeh-pci-error-recovery.txt
17   - - info on PCI Bus EEH Error Recovery
18   -firmware-assisted-dump.txt
19   - - Documentation on the firmware assisted dump mechanism "fadump".
20   -hvcs.txt
21   - - IBM "Hypervisor Virtual Console Server" Installation Guide
22   -mpc52xx.txt
23   - - Linux 2.6.x on MPC52xx family
24   -pmu-ebb.txt
25   - - Description of the API for using the PMU with Event Based Branches.
26   -qe_firmware.txt
27   - - describes the layout of firmware binaries for the Freescale QUICC
28   - Engine and the code that parses and uploads the microcode therein.
29   -ptrace.txt
30   - - Information on the ptrace interfaces for hardware debug registers.
31   -transactional_memory.txt
32   - - Overview of the Power8 transactional memory support.
33   -dscr.txt
34   - - Overview DSCR (Data Stream Control Register) support.
Documentation/s390/00-INDEX
1   -00-INDEX
2   - - this file.
3   -3270.ChangeLog
4   - - ChangeLog for the UTS Global 3270-support patch (outdated).
5   -3270.txt
6   - - how to use the IBM 3270 display system support.
7   -cds.txt
8   - - s390 common device support (common I/O layer).
9   -CommonIO
10   - - common I/O layer command line parameters, procfs and debugfs entries
11   -config3270.sh
12   - - example configuration for 3270 devices.
13   -DASD
14   - - information on the DASD disk device driver.
15   -Debugging390.txt
16   - - hints for debugging on s390 systems.
17   -driver-model.txt
18   - - information on s390 devices and the driver model.
19   -monreader.txt
20   - - information on accessing the z/VM monitor stream from Linux.
21   -qeth.txt
22   - - HiperSockets Bridge Port Support.
23   -s390dbf.txt
24   - - information on using the s390 debug feature.
25   -vfio-ccw.txt
26   - information on the vfio-ccw I/O subchannel driver.
27   -zfcpdump.txt
28   - - information on the s390 SCSI dump tool.
Documentation/scheduler/00-INDEX
1   -00-INDEX
2   - - this file.
3   -sched-arch.txt
4   - - CPU Scheduler implementation hints for architecture specific code.
5   -sched-bwc.txt
6   - - CFS bandwidth control overview.
7   -sched-design-CFS.txt
8   - - goals, design and implementation of the Completely Fair Scheduler.
9   -sched-domains.txt
10   - - information on scheduling domains.
11   -sched-nice-design.txt
12   - - How and why the scheduler's nice levels are implemented.
13   -sched-rt-group.txt
14   - - real-time group scheduling.
15   -sched-deadline.txt
16   - - deadline scheduling.
17   -sched-stats.txt
18   - - information on schedstats (Linux Scheduler Statistics).
Documentation/scsi/00-INDEX
1   -00-INDEX
2   - - this file
3   -53c700.txt
4   - - info on driver for 53c700 based adapters
5   -BusLogic.txt
6   - - info on driver for adapters with BusLogic chips
7   -ChangeLog.1992-1997
8   - - Changes to scsi files, if not listed elsewhere
9   -ChangeLog.arcmsr
10   - - Changes to driver for ARECA's SATA RAID controller cards
11   -ChangeLog.ips
12   - - IBM ServeRAID driver Changelog
13   -ChangeLog.lpfc
14   - - Changes to lpfc driver
15   -ChangeLog.megaraid
16   - - Changes to LSI megaraid controller.
17   -ChangeLog.megaraid_sas
18   - - Changes to serial attached scsi version of LSI megaraid controller.
19   -ChangeLog.ncr53c8xx
20   - - Changes to ncr53c8xx driver
21   -ChangeLog.sym53c8xx
22   - - Changes to sym53c8xx driver
23   -ChangeLog.sym53c8xx_2
24   - - Changes to second generation of sym53c8xx driver
25   -FlashPoint.txt
26   - - info on driver for BusLogic FlashPoint adapters
27   -LICENSE.FlashPoint
28   - - Licence of the Flashpoint driver
29   -LICENSE.qla2xxx
30   - - License for QLogic Linux Fibre Channel HBA Driver firmware.
31   -LICENSE.qla4xxx
32   - - License for QLogic Linux iSCSI HBA Driver.
33   -Mylex.txt
34   - - info on driver for Mylex adapters
35   -NinjaSCSI.txt
36   - - info on WorkBiT NinjaSCSI-32/32Bi driver
37   -aacraid.txt
38   - - Driver supporting Adaptec RAID controllers
39   -advansys.txt
40   - - List of Advansys Host Adapters
41   -aha152x.txt
42   - - info on driver for Adaptec AHA152x based adapters
43   -aic79xx.txt
44   - - Adaptec Ultra320 SCSI host adapters
45   -aic7xxx.txt
46   - - info on driver for Adaptec controllers
47   -arcmsr_spec.txt
48   - - ARECA FIRMWARE SPEC (for IOP331 adapter)
49   -bfa.txt
50   - - Brocade FC/FCOE adapter driver.
51   -bnx2fc.txt
52   - - FCoE hardware offload for Broadcom network interfaces.
53   -cxgb3i.txt
54   - - Chelsio iSCSI Linux Driver
55   -dc395x.txt
56   - - README file for the dc395x SCSI driver
57   -dpti.txt
58   - - info on driver for DPT SmartRAID and Adaptec I2O RAID based adapters
59   -dtc3x80.txt
60   - - info on driver for DTC 2x80 based adapters
61   -g_NCR5380.txt
62   - - info on driver for NCR5380 and NCR53c400 based adapters
63   -hpsa.txt
64   - - HP Smart Array Controller SCSI driver.
65   -hptiop.txt
66   - - HIGHPOINT ROCKETRAID 3xxx RAID DRIVER
67   -libsas.txt
68   - - Serial Attached SCSI management layer.
69   -link_power_management_policy.txt
70   - - Link power management options.
71   -lpfc.txt
72   - - LPFC driver release notes
73   -megaraid.txt
74   - - Common Management Module, shared code handling ioctls for LSI drivers
75   -ncr53c8xx.txt
76   - - info on driver for NCR53c8xx based adapters
77   -osd.txt
78   - Object-Based Storage Device, command set introduction.
79   -osst.txt
80   - - info on driver for OnStream SC-x0 SCSI tape
81   -ppa.txt
82   - - info on driver for IOmega zip drive
83   -qlogicfas.txt
84   - - info on driver for QLogic FASxxx based adapters
85   -scsi-changer.txt
86   - - README for the SCSI media changer driver
87   -scsi-generic.txt
88   - - info on the sg driver for generic (non-disk/CD/tape) SCSI devices.
89   -scsi-parameters.txt
90   - - List of SCSI-parameters to pass to the kernel at module load-time.
91   -scsi.txt
92   - - short blurb on using SCSI support as a module.
93   -scsi_mid_low_api.txt
94   - - info on API between SCSI layer and low level drivers
95   -scsi_eh.txt
96   - - info on SCSI midlayer error handling infrastructure
97   -scsi_fc_transport.txt
98   - - SCSI Fiber Channel Tansport
99   -st.txt
100   - - info on scsi tape driver
101   -sym53c500_cs.txt
102   - - info on PCMCIA driver for Symbios Logic 53c500 based adapters
103   -sym53c8xx_2.txt
104   - - info on second generation driver for sym53c8xx based adapters
105   -tmscsim.txt
106   - - info on driver for AM53c974 based adapters
107   -ufs.txt
108   - - info on Universal Flash Storage(UFS) and UFS host controller driver.
Documentation/serial/00-INDEX
1   -00-INDEX
2   - - this file.
3   -README.cycladesZ
4   - - info on Cyclades-Z firmware loading.
5   -driver
6   - - intro to the low level serial driver.
7   -moxa-smartio
8   - - file with info on installing/using Moxa multiport serial driver.
9   -n_gsm.txt
10   - - GSM 0710 tty multiplexer howto.
11   -rocket.txt
12   - - info on the Comtrol RocketPort multiport serial driver.
13   -serial-rs485.txt
14   - - info about RS485 structures and support in the kernel.
15   -tty.txt
16   - - guide to the locking policies of the tty layer.
Documentation/spi/00-INDEX
1   -00-INDEX
2   - - this file.
3   -butterfly
4   - - AVR Butterfly SPI driver overview and pin configuration.
5   -ep93xx_spi
6   - - Basic EP93xx SPI driver configuration.
7   -pxa2xx
8   - - PXA2xx SPI master controller build by spi_message fifo wq
9   -spidev
10   - - Intro to the userspace API for spi devices
11   -spi-lm70llp
12   - - Connecting an LM70-LLP sensor to the kernel via the SPI subsys.
13   -spi-sc18is602
14   - - NXP SC18IS602/603 I2C-bus to SPI bridge
15   -spi-summary
16   - - (Linux) SPI overview. If unsure about SPI or SPI in Linux, start here.
Documentation/sysctl/00-INDEX
1   -00-INDEX
2   - - this file.
3   -README
4   - - general information about /proc/sys/ sysctl files.
5   -abi.txt
6   - - documentation for /proc/sys/abi/*.
7   -fs.txt
8   - - documentation for /proc/sys/fs/*.
9   -kernel.txt
10   - - documentation for /proc/sys/kernel/*.
11   -net.txt
12   - - documentation for /proc/sys/net/*.
13   -sunrpc.txt
14   - - documentation for /proc/sys/sunrpc/*.
15   -vm.txt
16   - - documentation for /proc/sys/vm/*.
Documentation/timers/00-INDEX
1   -00-INDEX
2   - - this file
3   -highres.txt
4   - - High resolution timers and dynamic ticks design notes
5   -hpet.txt
6   - - High Precision Event Timer Driver for Linux
7   -hrtimers.txt
8   - - subsystem for high-resolution kernel timers
9   -NO_HZ.txt
10   - - Summary of the different methods for the scheduler clock-interrupts management.
11   -timekeeping.txt
12   - - Clock sources, clock events, sched_clock() and delay timer notes
13   -timers-howto.txt
14   - - how to insert delays in the kernel the right (tm) way.
15   -timer_stats.txt
16   - - timer usage statistics
Documentation/virtual/00-INDEX
1   -Virtualization support in the Linux kernel.
2   -
3   -00-INDEX
4   - - this file.
5   -
6   -paravirt_ops.txt
7   - - Describes the Linux kernel pv_ops to support different hypervisors
8   -kvm/
9   - - Kernel Virtual Machine. See also http://linux-kvm.org
10   -uml/
11   - - User Mode Linux, builds/runs Linux kernel as a userspace program.
Documentation/virtual/kvm/00-INDEX
1   -00-INDEX
2   - - this file.
3   -amd-memory-encryption.rst
4   - - notes on AMD Secure Encrypted Virtualization feature and SEV firmware
5   - command description
6   -api.txt
7   - - KVM userspace API.
8   -arm
9   - - internal ABI between the kernel and HYP (for arm/arm64)
10   -cpuid.txt
11   - - KVM-specific cpuid leaves (x86).
12   -devices/
13   - - KVM_CAP_DEVICE_CTRL userspace API.
14   -halt-polling.txt
15   - - notes on halt-polling
16   -hypercalls.txt
17   - - KVM hypercalls.
18   -locking.txt
19   - - notes on KVM locks.
20   -mmu.txt
21   - - the x86 kvm shadow mmu.
22   -msr.txt
23   - - KVM-specific MSRs (x86).
24   -nested-vmx.txt
25   - - notes on nested virtualization for Intel x86 processors.
26   -ppc-pv.txt
27   - - the paravirtualization interface on PowerPC.
28   -review-checklist.txt
29   - - review checklist for KVM patches.
30   -s390-diag.txt
31   - - Diagnose hypercall description (for IBM S/390)
32   -timekeeping.txt
33   - - timekeeping virtualization for x86-based architectures.
34   -vcpu-requests.rst
35   - - internal VCPU request API
Documentation/vm/00-INDEX
1   -00-INDEX
2   - - this file.
3   -active_mm.rst
4   - - An explanation from Linus about tsk->active_mm vs tsk->mm.
5   -balance.rst
6   - - various information on memory balancing.
7   -cleancache.rst
8   - - Intro to cleancache and page-granularity victim cache.
9   -frontswap.rst
10   - - Outline frontswap, part of the transcendent memory frontend.
11   -highmem.rst
12   - - Outline of highmem and common issues.
13   -hmm.rst
14   - - Documentation of heterogeneous memory management
15   -hugetlbfs_reserv.rst
16   - - A brief overview of hugetlbfs reservation design/implementation.
17   -hwpoison.rst
18   - - explains what hwpoison is
19   -ksm.rst
20   - - how to use the Kernel Samepage Merging feature.
21   -mmu_notifier.rst
22   - - a note about clearing pte/pmd and mmu notifications
23   -numa.rst
24   - - information about NUMA specific code in the Linux vm.
25   -overcommit-accounting.rst
26   - - description of the Linux kernels overcommit handling modes.
27   -page_frags.rst
28   - - description of page fragments allocator
29   -page_migration.rst
30   - - description of page migration in NUMA systems.
31   -page_owner.rst
32   - - tracking about who allocated each page
33   -remap_file_pages.rst
34   - - a note about remap_file_pages() system call
35   -slub.rst
36   - - a short users guide for SLUB.
37   -split_page_table_lock.rst
38   - - Separate per-table lock to improve scalability of the old page_table_lock.
39   -swap_numa.rst
40   - - automatic binding of swap device to numa node
41   -transhuge.rst
42   - - Transparent Hugepage Support, alternative way of using hugepages.
43   -unevictable-lru.rst
44   - - Unevictable LRU infrastructure
45   -z3fold.txt
46   - - outline of z3fold allocator for storing compressed pages
47   -zsmalloc.rst
48   - - outline of zsmalloc allocator for storing compressed pages
49   -zswap.rst
50   - - Intro to compressed cache for swap pages
Documentation/w1/00-INDEX
1   -00-INDEX
2   - - This file
3   -slaves/
4   - - Drivers that provide support for specific family codes.
5   -masters/
6   - - Individual chips providing 1-wire busses.
7   -w1.generic
8   - - The 1-wire (w1) bus
9   -w1.netlink
10   - - Userspace communication protocol over connector [1].
Documentation/w1/masters/00-INDEX
1   -00-INDEX
2   - - This file
3   -ds2482
4   - - The Maxim/Dallas Semiconductor DS2482 provides 1-wire busses.
5   -ds2490
6   - - The Maxim/Dallas Semiconductor DS2490 builds USB <-> W1 bridges.
7   -mxc-w1
8   - - W1 master controller driver found on Freescale MX2/MX3 SoCs
9   -omap-hdq
10   - - HDQ/1-wire module of TI OMAP 2430/3430.
11   -w1-gpio
12   - - GPIO 1-wire bus master driver.
Documentation/w1/slaves/00-INDEX
1   -00-INDEX
2   - - This file
3   -w1_therm
4   - - The Maxim/Dallas Semiconductor ds18*20 temperature sensor.
5   -w1_ds2413
6   - - The Maxim/Dallas Semiconductor ds2413 dual channel addressable switch.
7   -w1_ds2423
8   - - The Maxim/Dallas Semiconductor ds2423 counter device.
9   -w1_ds2438
10   - - The Maxim/Dallas Semiconductor ds2438 smart battery monitor.
11   -w1_ds28e04
12   - - The Maxim/Dallas Semiconductor ds28e04 eeprom.
13   -w1_ds28e17
14   - - The Maxim/Dallas Semiconductor ds28e17 1-Wire-to-I2C Master Bridge.
Documentation/x86/00-INDEX
1   -00-INDEX
2   - - this file
3   -boot.txt
4   - - List of boot protocol versions
5   -earlyprintk.txt
6   - - Using earlyprintk with a USB2 debug port key.
7   -entry_64.txt
8   - - Describe (some of the) kernel entry points for x86.
9   -exception-tables.txt
10   - - why and how Linux kernel uses exception tables on x86
11   -microcode.txt
12   - - How to load microcode from an initrd-CPIO archive early to fix CPU issues.
13   -mtrr.txt
14   - - how to use x86 Memory Type Range Registers to increase performance
15   -pat.txt
16   - - Page Attribute Table intro and API
17   -usb-legacy-support.txt
18   - - how to fix/avoid quirks when using emulated PS/2 mouse/keyboard.
19   -zero-page.txt
20   - - layout of the first page of memory.
Documentation/x86/x86_64/00-INDEX
1   -00-INDEX
2   - - This file
3   -boot-options.txt
4   - - AMD64-specific boot options.
5   -cpu-hotplug-spec
6   - - Firmware support for CPU hotplug under Linux/x86-64
7   -fake-numa-for-cpusets
8   - - Using numa=fake and CPUSets for Resource Management
9   -kernel-stacks
10   - - Context-specific per-processor interrupt stacks.
11   -machinecheck
12   - - Configurable sysfs parameters for the x86-64 machine check code.
13   -mm.txt
14   - - Memory layout of x86-64 (4 level page tables, 46 bits physical).
15   -uefi.txt
16   - - Booting Linux via Unified Extensible Firmware Interface.
... ... @@ -12,7 +12,6 @@
12 12  
13 13 There are various text files in the Documentation/ subdirectory,
14 14 several of them using the Restructured Text markup notation.
15   -See Documentation/00-INDEX for a list of what is contained in each file.
16 15  
17 16 Please read the Documentation/process/changes.rst file, as it contains the
18 17 requirements for building and running the kernel, and information about
scripts/check_00index.sh
1   -#!/bin/bash
2   -# SPDX-License-Identifier: GPL-2.0
3   -
4   -cd Documentation/
5   -
6   -# Check entries that should be removed
7   -
8   -obsolete=""
9   -for i in $(tail -n +12 00-INDEX |grep -E '^[a-zA-Z0-9]+'); do
10   - if [ ! -e $i ]; then
11   - obsolete="$obsolete $i"
12   - fi
13   -done
14   -
15   -# Check directory entries that should be added
16   -search=""
17   -dir=""
18   -for i in $(find . -maxdepth 1 -type d); do
19   - if [ "$i" != "." ]; then
20   - new=$(echo $i|perl -ne 's,./(.*),$1/,; print $_')
21   - search="$search $new"
22   - fi
23   -done
24   -
25   -for i in $search; do
26   - if [ "$(grep -P "^$i" 00-INDEX)" == "" ]; then
27   - dir="$dir $i"
28   - fi
29   -done
30   -
31   -# Check file entries that should be added
32   -search=""
33   -file=""
34   -for i in $(find . -maxdepth 1 -type f); do
35   - if [ "$i" != "./.gitignore" ]; then
36   - new=$(echo $i|perl -ne 's,./(.*),$1,; print $_')
37   - search="$search $new"
38   - fi
39   -done
40   -
41   -for i in $search; do
42   - if [ "$(grep -P "^$i\$" 00-INDEX)" == "" ]; then
43   - file="$file $i"
44   - fi
45   -done
46   -
47   -# Output its findings
48   -
49   -echo -e "Documentation/00-INDEX check results:\n"
50   -
51   -if [ "$obsolete" != "" ]; then
52   - echo -e "- Should remove those entries:\n\t$obsolete\n"
53   -else
54   - echo -e "- No obsolete entries\n"
55   -fi
56   -
57   -if [ "$dir" != "" ]; then
58   - echo -e "- Should document those directories:\n\t$dir\n"
59   -else
60   - echo -e "- No new directories to add\n"
61   -fi
62   -
63   -if [ "$file" != "" ]; then
64   - echo -e "- Should document those files:\n\t$file"
65   -else
66   - echo "- No new files to add"
67   -fi