最終更新:2019-02-28 (木) 19:16:47 (526d)  

kernel.org/doc/Documentation
Top / kernel.org / doc / Documentation

http://kernel.org/doc/Documentation/

This is a brief list of all the files in ./linux/Documentation and what
they contain. If you add a documentation file, please list it here in
alphabetical order as well, or risk being hunted down like a rabid dog.
Please try and keep the descriptions small enough to fit on one line.
							 Thanks -- Paul G.

メモ

日本語訳 (Linux JF)

一覧

  • kernel.org/doc/Documentation/00-INDEX - this file.
  • kernel.org/doc/Documentation/ABI? - info on kernel <-> userspace ABI and relative interface stability.
  • kernel.org/doc/Documentation/BUG-HUNTING? - brute force method of doing binary search of patches to find bug.
  • kernel.org/doc/Documentation/Changes - list of changes that break older software packages.
  • kernel.org/doc/Documentation/CodingStyle? - how the boss likes the C code in the kernel to look.
  • kernel.org/doc/Documentation/development-process? - An extended tutorial on how to work with the kernel development process.
  • kernel.org/doc/Documentation/DMA-API.txt - DMA API, pci_ API & extensions for non-consistent memory machines.
  • kernel.org/doc/Documentation/DMA-ISA-LPC.txt? - How to do DMA with ISA (and LPC) devices.
  • kernel.org/doc/Documentation/DocBook - directory with DocBook templates etc. for kernel documentation.
  • kernel.org/doc/Documentation/HOWTO? - the process and procedures of how to do Linux kernel development.
  • kernel.org/doc/Documentation/IPMI.txt? - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
  • kernel.org/doc/Documentation/IRQ-affinity.txt? - how to select which CPU(s) handle which interrupt events on SMP.
  • kernel.org/doc/Documentation/IRQ.txt? - description of what an IRQ is.
  • kernel.org/doc/Documentation/ManagementStyle? - how to (attempt to) manage kernel hackers.
  • kernel.org/doc/Documentation/RCU? - directory with info on RCU (read-copy update).
  • kernel.org/doc/Documentation/SAK.txt? - info on Secure Attention Keys.
  • kernel.org/doc/Documentation/SM501.txt? - Silicon Motion SM501 multimedia companion chip
  • kernel.org/doc/Documentation/SecurityBugs? - procedure for reporting security bugs found in the kernel.
  • kernel.org/doc/Documentation/SubmitChecklist? - Linux kernel patch submission checklist.
  • kernel.org/doc/Documentation/SubmittingDrivers? - procedure to get a new driver source included into the kernel tree.
  • kernel.org/doc/Documentation/SubmittingPatches? - procedure to get a source patch included into the kernel tree.
  • kernel.org/doc/Documentation/VGA-softcursor.txt? - how to change your VGA cursor from a blinking underscore.
  • kernel.org/doc/Documentation/accounting? - documentation on accounting and taskstats.
  • kernel.org/doc/Documentation/acpi? - info on ACPI-specific hooks in the kernel.
  • kernel.org/doc/Documentation/aoe? - description of AoE (ATA over Ethernet) along with config examples.
  • kernel.org/doc/Documentation/applying-patches.txt? - description of various trees and how to apply their patches.
  • kernel.org/doc/Documentation/arm? - directory with info about Linux on the ARM architecture.
  • kernel.org/doc/Documentation/atomic_ops.txt? - semantics and behavior of atomic and bitmask operations.
  • kernel.org/doc/Documentation/auxdisplay? - misc. LCD driver documentation (cfag12864b, ks0108).
  • kernel.org/doc/Documentation/basic_profiling.txt? - basic instructions for those who wants to profile Linux kernel.
  • kernel.org/doc/Documentation/binfmt_misc.txt? - info on the kernel support for extra binary formats.
  • kernel.org/doc/Documentation/blackfin? - directory with documentation for the Blackfin arch.
  • kernel.org/doc/Documentation/block? - info on the Block I/O (BIO) layer.
  • kernel.org/doc/Documentation/blockdev? - info on block devices & drivers
  • kernel.org/doc/Documentation/btmrvl.txt? - info on Marvell Bluetooth driver usage.
  • kernel.org/doc/Documentation/bus-virt-phys-mapping.txt? - how to access I/O mapped memory from within device drivers.
  • kernel.org/doc/Documentation/cachetlb.txt? - describes the cache/TLB flushing interfaces Linux uses.
  • kernel.org/doc/Documentation/cdrom? - directory with information on the CD-ROM drivers that Linux has.
  • kernel.org/doc/Documentation/cgroups? - cgroups features, including cpusets and memory controller.
  • kernel.org/doc/Documentation/connector? - docs on the netlink based userspace<->kernel space communication mod.
  • kernel.org/doc/Documentation/console? - documentation on Linux console drivers.
  • kernel.org/doc/Documentation/cpu-freq - info on CPU frequency and voltage scaling.
  • kernel.org/doc/Documentation/cpu-hotplug.txt? - document describing CPU hotplug support in the Linux kernel.
  • kernel.org/doc/Documentation/cpu-load.txt? - document describing how CPU load statistics are collected.
  • kernel.org/doc/Documentation/cpuidle? - info on CPU_IDLE, CPU idle state management subsystem.
  • kernel.org/doc/Documentation/cputopology.txt? - documentation on how CPU topology info is exported via sysfs.
  • kernel.org/doc/Documentation/cris? - directory with info about Linux on CRIS architecture.
  • kernel.org/doc/Documentation/crypto? - directory with info on the Crypto API.
  • kernel.org/doc/Documentation/dcdbas.txt? - information on the Dell Systems Management Base Driver.
  • kernel.org/doc/Documentation/debugging-modules.txt? - some notes on debugging modules after Linux 2.6.3.
  • kernel.org/doc/Documentation/dell_rbu.txt? - document demonstrating the use of the Dell Remote BIOS Update driver.
  • kernel.org/doc/Documentation/device-mapper? - directory with info on Device Mapper.
  • kernel.org/doc/Documentation/devices.txt - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
  • kernel.org/doc/Documentation/devicetree - directory with info on device tree files used by OF/PowerPC/ARM
  • kernel.org/doc/Documentation/dontdiff? - file containing a list of files that should never be diff'ed.
  • kernel.org/doc/Documentation/dynamic-debug-howto.txt - how to use the dynamic debug (dyndbg) feature.
  • kernel.org/doc/Documentation/driver-model - directory with info about Linux driver model.
  • kernel.org/doc/Documentation/dvb? - info on Linux Digital Video Broadcast (DVB) subsystem.
  • kernel.org/doc/Documentation/early-userspace? - info about initramfs, klibc, and userspace early during boot.
  • kernel.org/doc/Documentation/edac.txt? - information on EDAC - Error Detection And Correction
  • kernel.org/doc/Documentation/eisa.txt? - info on EISA bus support.
  • kernel.org/doc/Documentation/fault-injection? - dir with docs about the fault injection capabilities infrastructure.
  • kernel.org/doc/Documentation/fb - directory with info on the frame buffer graphics abstraction layer.
  • kernel.org/doc/Documentation/feature-removal-schedule.txt - list of files and features that are going to be removed.
  • kernel.org/doc/Documentation/filesystems - info on the vfs and the various filesystems that Linux supports.
  • kernel.org/doc/Documentation/firmware_class? - request_firmware() hotplug interface info.
  • kernel.org/doc/Documentation/frv? - Fujitsu FR-V Linux documentation.
  • kernel.org/doc/Documentation/gpio.txt - overview of GPIO (General Purpose Input/Output) access conventions.
  • kernel.org/doc/Documentation/highuid.txt? - notes on the change from 16 bit to 32 bit user/group IDs.
  • kernel.org/doc/Documentation/timers? - info on the timer related topics
  • kernel.org/doc/Documentation/hw_random.txt? - info on Linux support for random number generator in i8xx chipsets.
  • kernel.org/doc/Documentation/hwmon - directory with docs on various hardware monitoring drivers.
  • kernel.org/doc/Documentation/i2c? - directory with info about the I2C bus/protocol (2 wire, kHz speed).
  • kernel.org/doc/Documentation/i2o? - directory with info about the Linux I2O subsystem.
  • kernel.org/doc/Documentation/x86/i386? - directory with info about Linux on Intel 32 bit architecture.
  • kernel.org/doc/Documentation/ia64? - directory with info about Linux on Intel 64 bit architecture.
  • kernel.org/doc/Documentation/infiniband? - directory with documents concerning Linux InfiniBand support.
  • kernel.org/doc/Documentation/initrd.txt - how to use the RAM disk as an initial/temporary root filesystem.
  • kernel.org/doc/Documentation/input - info on Linux input device support.
  • kernel.org/doc/Documentation/io-mapping.txt? - description of io_mapping functions in linux/io-mapping.h
  • kernel.org/doc/Documentation/io_ordering.txt? - info on ordering I/O writes to memory-mapped addresses.
  • kernel.org/doc/Documentation/ioctl - directory with documents describing various IOCTL calls.
  • kernel.org/doc/Documentation/iostats.txt? - info on I/O statistics Linux kernel provides.
  • kernel.org/doc/Documentation/irqflags-tracing.txt? - how to use the irq-flags tracing feature.
  • kernel.org/doc/Documentation/isapnp.txt? - info on Linux ISA Plug & Play support.
  • kernel.org/doc/Documentation/isdn? - directory with info on the Linux ISDN support, and supported cards.
  • kernel.org/doc/Documentation/java.txt? - info on the in-kernel binary support for Java(tm).
  • kernel.org/doc/Documentation/kbuild - directory with info about the kernel build process.
  • kernel.org/doc/Documentation/kdump? - directory with mini HowTo? on getting the crash dump code to work.
  • kernel.org/doc/Documentation/kernel-doc-nano-HOWTO.txt - mini HowTo? on generation and location of kernel documentation files.
  • kernel.org/doc/Documentation/kernel-docs.txt? - listing of various WWW + books that document kernel internals.
  • kernel.org/doc/Documentation/kernel-parameters.txt - summary listing of command line / boot prompt args for the kernel.
  • kernel.org/doc/Documentation/kobject.txt - info of the kobject infrastructure of the Linux kernel.
  • kernel.org/doc/Documentation/kprobes.txt - documents the kernel probes debugging feature.
  • kernel.org/doc/Documentation/kref.txt? - docs on adding reference counters (krefs) to kernel objects.
  • kernel.org/doc/Documentation/laptops? - directory with laptop related info and laptop driver documentation.
  • kernel.org/doc/Documentation/ldm.txt? - a brief description of LDM (Windows Dynamic Disks).
  • kernel.org/doc/Documentation/leds? - directory with info about LED handling under Linux.
  • kernel.org/doc/Documentation/local_ops.txt? - semantics and behavior of local atomic operations.
  • kernel.org/doc/Documentation/lockdep-design.txt? - documentation on the runtime locking correctness validator.
  • kernel.org/doc/Documentation/logo.gif? - full colour GIF image of Linux logo (penguin - Tux).
  • kernel.org/doc/Documentation/logo.txt? - info on creator of above logo & site to get additional images from.
  • kernel.org/doc/Documentation/m68k? - directory with info about Linux on Motorola 68k architecture.
  • kernel.org/doc/Documentation/magic-number.txt? - list of magic numbers used to mark/protect kernel data structures.
  • kernel.org/doc/Documentation/mca.txt? - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
  • kernel.org/doc/Documentation/md.txt? - info on boot arguments for the multiple devices driver.
  • kernel.org/doc/Documentation/memory-barriers.txt? - info on Linux kernel memory barriers.
  • kernel.org/doc/Documentation/memory-hotplug.txt? - Hotpluggable memory support, how to use and current status.
  • kernel.org/doc/Documentation/memory.txt? - info on typical Linux memory problems.
  • kernel.org/doc/Documentation/mips? - directory with info about Linux on MIPS architecture.
  • kernel.org/doc/Documentation/mmc? - directory with info about the MMC subsystem
  • kernel.org/doc/Documentation/mono.txt? - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
  • kernel.org/doc/Documentation/mutex-design.txt? - info on the generic mutex subsystem.
  • kernel.org/doc/Documentation/namespaces? - directory with various information about namespaces
  • kernel.org/doc/Documentation/netlabel? - directory with information on the NetLabel? subsystem.
  • kernel.org/doc/Documentation/networking? - directory with info on various aspects of networking with Linux.
  • kernel.org/doc/Documentation/nmi_watchdog.txt? - info on NMI watchdog for SMP systems.
  • kernel.org/doc/Documentation/nommu-mmap.txt? - documentation about no-mmu memory mapping support.
  • kernel.org/doc/Documentation/numastat.txt? - info on how to read Numa policy hit/miss statistics in sysfs.
  • kernel.org/doc/Documentation/oops-tracing.txt? - how to decode those nasty internal kernel error dump messages.
  • kernel.org/doc/Documentation/padata.txt? - An introduction to the "padata" parallel execution API
  • kernel.org/doc/Documentation/parisc? - directory with info on using Linux on PA-RISC architecture.
  • kernel.org/doc/Documentation/parport.txt? - how to use the parallel-port driver.
  • kernel.org/doc/Documentation/parport-lowlevel.txt? - description and usage of the low level parallel port functions.
  • kernel.org/doc/Documentation/pcmcia? - info on the Linux PCMCIA driver.
  • kernel.org/doc/Documentation/pi-futex.txt? - documentation on lightweight PI-futexes.
  • kernel.org/doc/Documentation/pnp.txt? - Linux Plug and Play documentation.
  • kernel.org/doc/Documentation/power? - directory with info on Linux PCI power management.
  • kernel.org/doc/Documentation/powerpc? - directory with info on using Linux with the PowerPC.
  • kernel.org/doc/Documentation/preempt-locking.txt? - info on locking under a preemptive kernel.
  • kernel.org/doc/Documentation/printk-formats.txt? - how to get printk format specifiers right
  • kernel.org/doc/Documentation/prio_tree.txt? - info on radix-priority-search-tree use for indexing vmas.
  • kernel.org/doc/Documentation/rbtree.txt? - info on what red-black trees are and what they are for.
  • kernel.org/doc/Documentation/robust-futex-ABI.txt? - documentation of the robust futex ABI.
  • kernel.org/doc/Documentation/robust-futexes.txt? - a description of what robust futexes are.
  • kernel.org/doc/Documentation/rt-mutex-design.txt? - description of the RealTime? mutex implementation design.
  • kernel.org/doc/Documentation/rt-mutex.txt? - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
  • kernel.org/doc/Documentation/rtc.txt? - notes on how to use the Real Time Clock (aka CMOS clock) driver.
  • kernel.org/doc/Documentation/s390? - directory with info on using Linux on the IBM S390.
  • kernel.org/doc/Documentation/scheduler? - directory with info on the scheduler.
  • kernel.org/doc/Documentation/scsi? - directory with info on Linux scsi support.
  • kernel.org/doc/Documentation/security? - directory that contains security-related info
  • kernel.org/doc/Documentation/serial? - directory with info on the low level serial API.
  • kernel.org/doc/Documentation/serial-console.txt? - how to set up Linux with a serial line console as the default.
  • kernel.org/doc/Documentation/sgi-ioc4.txt? - description of the SGI IOC4 PCI (multi function) device.
  • kernel.org/doc/Documentation/sgi-visws.txt? - short blurb on the SGI Visual Workstations.
  • kernel.org/doc/Documentation/sh? - directory with info on porting Linux to a new architecture.
  • kernel.org/doc/Documentation/sound? - directory with info on sound card support.
  • kernel.org/doc/Documentation/sparc? - directory with info on using Linux on Sparc architecture.
  • kernel.org/doc/Documentation/sparse.txt? - info on how to obtain and use the sparse tool for typechecking.
  • kernel.org/doc/Documentation/spi? - overview of Linux kernel Serial Peripheral Interface (SPI) support.
  • kernel.org/doc/Documentation/spinlocks.txt - info on using spinlocks to provide exclusive access in kernel.
  • kernel.org/doc/Documentation/stable_api_nonsense.txt? - info on why the kernel does not have a stable in-kernel api or abi.
  • kernel.org/doc/Documentation/stable_kernel_rules.txt - rules and procedures for the -stable kernel releases.
  • kernel.org/doc/Documentation/svga.txt? - short guide on selecting video modes at boot via VGA BIOS.
  • kernel.org/doc/Documentation/sysfs-rules.txt? - How not to use sysfs.
  • kernel.org/doc/Documentation/sysctl? - directory with info on the /proc/sys/* files.
  • kernel.org/doc/Documentation/sysrq.txt? - info on the magic SysRq key.
  • kernel.org/doc/Documentation/telephony? - directory with info on telephony (e.g. voice over IP) support.
  • kernel.org/doc/Documentation/unicode.txt? - info on the Unicode character/font mapping used in Linux.
  • kernel.org/doc/Documentation/unshare.txt? - description of the Linux unshare system call.
  • kernel.org/doc/Documentation/usb - directory with info regarding the Universal Serial Bus.
  • kernel.org/doc/Documentation/video-output.txt? - sysfs class driver interface to enable/disable a video output device.
  • kernel.org/doc/Documentation/video4linux? - directory with info regarding video/TV/radio cards and linux.
  • kernel.org/doc/Documentation/vm? - directory with info on the Linux vm code.
  • kernel.org/doc/Documentation/volatile-considered-harmful.txt? - Why the "volatile" type class should not be used
  • kernel.org/doc/Documentation/w1? - directory with documents regarding the 1-wire (w1) subsystem.
  • kernel.org/doc/Documentation/watchdog? - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
  • kernel.org/doc/Documentation/x86/x86_64? - directory with info on Linux support for AMD x86-64 (Hammer) machines.
  • kernel.org/doc/Documentation/zorro.txt? - info on writing drivers for Zorro bus devices found on Amigas.

変更点

Linux 4.2

  • 追加
    • kernel.org/doc/Documentation/features?
    • kernel.org/doc/Documentation/nvdimm?
    • kernel.org/doc/Documentation/ntb.txt?

Linux 4.1

  • 追加
    • kernel.org/doc/Documentation/cma?
    • kernel.org/doc/Documentation/md-cluster.txt?
  • 削除
    • kernel.org/doc/Documentation/i2o?

Linux 4.0

  • 追加
    • kernel.org/doc/Documentation/CodeOfConflict?
    • kernel.org/doc/Documentation/gdb-kernel-debugging.txt?
    • kernel.org/doc/Documentation/kasan.txt?

Linux 3.19

  • 追加
    • kernel.org/doc/Documentation/dmaengine?
    • kernel.org/doc/Documentation/nios2?
    • kernel.org/doc/Documentation/kselftest.txt?
  • 削除
    • kernel.org/doc/Documentation/dmaengine.txt?
    • kernel.org/doc/Documentation/dmatest.txt?

Linux 3.18

  • 追加
    • kernel.org/doc/Documentation/locking?
    • kernel.org/doc/Documentation/lzo.txt?
    • kernel.org/doc/Documentation/mailbox.txt?
  • 削除
    • kernel.org/doc/Documentation/lockdep-design.txt?
    • kernel.org/doc/Documentation/lockstat.txt?
    • kernel.org/doc/Documentation/mutex-design.txt?
    • kernel.org/doc/Documentation/rt-mutex-design.txt?
    • kernel.org/doc/Documentation/rt-mutex.txt?
    • kernel.org/doc/Documentation/spinlocks.txt

Linux 3.17

  • 削除
    • kernel.org/doc/Documentation/make?

Linux 3.16

  • 追加
    • kernel.org/doc/Documentation/platform?
    • kernel.org/doc/Documentation/hsi.txt?

Linux 3.15

  • 追加
    • kernel.org/doc/Documentation/phy?
  • 削除
    • kernel.org/doc/Documentation/sgi-visws.txt?

Linux 3.13

  • 追加
    • kernel.org/doc/Documentation/gpio
    • kernel.org/doc/Documentation/mic?
    • kernel.org/doc/Documentation/assoc_array.txt?
    • kernel.org/doc/Documentation/efi-stub.txt?
    • kernel.org/doc/Documentation/module-signing.txt?
    • kernel.org/doc/Documentation/phy.txt?

Linux 3.12

  • 追加
    • kernel.org/doc/Documentation/tpm?

Linux 3.11

  • 追加
    • kernel.org/doc/Documentation/fmc?
    • kernel.org/doc/Documentation/ww-mutex-design.txt?

Linux 3.10

  • 追加
    • kernel.org/doc/Documentation/bcache.txt?
    • kernel.org/doc/Documentation/dmatest.txt?
    • kernel.org/doc/Documentation/kernel-per-CPU-kthreads.txt?
    • kernel.org/doc/Documentation/this_cpu_ops.txt?

Linux 3.9

  • 追加
    • kernel.org/doc/Documentation/metag?

Linux 3.8

  • 追加
    • kernel.org/doc/Documentation/bus-devices?
    • kernel.org/doc/Documentation/xtensa?
  • 削除
    • kernel.org/doc/Documentation/telephony?

Linux 3.7

  • 追加
    • kernel.org/doc/Documentation/arm64?
    • kernel.org/doc/Documentation/percpu-rw-semaphore.txt?
    • kernel.org/doc/Documentation/rprio_tree.txt?
    • kernel.org/doc/Documentation/smsc_ece1099.txt?

Linux 3.6

  • 追加
    • kernel.org/doc/Documentation/pwm.txt?
    • kernel.org/doc/Documentation/vfio.txt?

Linux 3.5

  • 追加
    • kernel.org/doc/Documentation/extcon?
    • kernel.org/doc/Documentation/memory-devices?
    • kernel.org/doc/Documentation/vme_api.txt?
  • 削除
    • kernel.org/doc/Documentation/sparc?
    • kernel.org/doc/Documentation/mca.txt?

Linux 3.4

  • 追加
    • kernel.org/doc/Documentation/EDID?
    • kernel.org/doc/Documentation/backlight?
    • kernel.org/doc/Documentation/IRQ-domain.txt?
    • kernel.org/doc/Documentation/clk.txt?
    • kernel.org/doc/Documentation/crc32.txt?
    • kernel.org/doc/Documentation/lockup-watchdogs.txt?
    • kernel.org/doc/Documentation/remoteproc.txt?
    • kernel.org/doc/Documentation/rpmsg.txt?
    • kernel.org/doc/Documentation/static-keys.txt?
  • 削除
    • kernel.org/doc/Documentation/nmi_watchdog.txt?

Linux 3.0

  • 削除
    • kernel.org/doc/Documentation/kvm?
    • kernel.org/doc/Documentation/lguest?
    • kernel.org/doc/Documentation/uml?