diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2008-11-13 21:33:24 +0000 |
---|---|---|
committer | Randy Dunlap <randy.dunlap@oracle.com> | 2008-11-14 17:28:53 +0000 |
commit | 31c00fc15ebd35c1647775dbfc167a15d46657fd (patch) | |
tree | 6d8ff2a6607c94a791ccc56fd8eb625e4fdcc01a /Documentation | |
parent | 3edac25f2e8ac8c2a84904c140e1aeb434e73e75 (diff) | |
download | op-kernel-dev-31c00fc15ebd35c1647775dbfc167a15d46657fd.zip op-kernel-dev-31c00fc15ebd35c1647775dbfc167a15d46657fd.tar.gz |
Create/use more directory structure in the Documentation/ tree.
Create Documentation/blockdev/ sub-directory and populate it.
Populate the Documentation/serial/ sub-directory.
Move MSI-HOWTO.txt to Documentation/PCI/.
Move ioctl-number.txt to Documentation/ioctl/.
Update all relevant 00-INDEX files.
Update all relevant Kconfig files and source files.
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/00-INDEX | 42 | ||||
-rw-r--r-- | Documentation/PCI/00-INDEX | 2 | ||||
-rw-r--r-- | Documentation/PCI/MSI-HOWTO.txt (renamed from Documentation/MSI-HOWTO.txt) | 0 | ||||
-rw-r--r-- | Documentation/blockdev/00-INDEX | 16 | ||||
-rw-r--r-- | Documentation/blockdev/README.DAC960 (renamed from Documentation/README.DAC960) | 0 | ||||
-rw-r--r-- | Documentation/blockdev/cciss.txt (renamed from Documentation/cciss.txt) | 0 | ||||
-rw-r--r-- | Documentation/blockdev/cpqarray.txt (renamed from Documentation/cpqarray.txt) | 0 | ||||
-rw-r--r-- | Documentation/blockdev/floppy.txt (renamed from Documentation/floppy.txt) | 0 | ||||
-rw-r--r-- | Documentation/blockdev/nbd.txt (renamed from Documentation/nbd.txt) | 0 | ||||
-rw-r--r-- | Documentation/blockdev/paride.txt (renamed from Documentation/paride.txt) | 0 | ||||
-rw-r--r-- | Documentation/blockdev/ramdisk.txt (renamed from Documentation/ramdisk.txt) | 0 | ||||
-rw-r--r-- | Documentation/ioctl/00-INDEX | 10 | ||||
-rw-r--r-- | Documentation/ioctl/ioctl-number.txt (renamed from Documentation/ioctl-number.txt) | 0 | ||||
-rw-r--r-- | Documentation/kernel-parameters.txt | 24 | ||||
-rw-r--r-- | Documentation/serial/00-INDEX | 24 | ||||
-rw-r--r-- | Documentation/serial/README.cycladesZ (renamed from Documentation/README.cycladesZ) | 0 | ||||
-rw-r--r-- | Documentation/serial/computone.txt (renamed from Documentation/computone.txt) | 2 | ||||
-rw-r--r-- | Documentation/serial/digiepca.txt (renamed from Documentation/digiepca.txt) | 0 | ||||
-rw-r--r-- | Documentation/serial/hayes-esp.txt (renamed from Documentation/hayes-esp.txt) | 0 | ||||
-rw-r--r-- | Documentation/serial/moxa-smartio (renamed from Documentation/moxa-smartio) | 0 | ||||
-rw-r--r-- | Documentation/serial/riscom8.txt (renamed from Documentation/riscom8.txt) | 0 | ||||
-rw-r--r-- | Documentation/serial/rocket.txt (renamed from Documentation/rocket.txt) | 0 | ||||
-rw-r--r-- | Documentation/serial/specialix.txt (renamed from Documentation/specialix.txt) | 0 | ||||
-rw-r--r-- | Documentation/serial/stallion.txt (renamed from Documentation/stallion.txt) | 0 | ||||
-rw-r--r-- | Documentation/serial/sx.txt (renamed from Documentation/sx.txt) | 0 | ||||
-rw-r--r-- | Documentation/serial/tty.txt (renamed from Documentation/tty.txt) | 0 |
26 files changed, 67 insertions, 53 deletions
diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX index edef85c..2f969e2 100644 --- a/Documentation/00-INDEX +++ b/Documentation/00-INDEX @@ -42,14 +42,8 @@ IRQ.txt - description of what an IRQ is. ManagementStyle - how to (attempt to) manage kernel hackers. -MSI-HOWTO.txt - - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ. RCU/ - directory with info on RCU (read-copy update). -README.DAC960 - - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux. -README.cycladesZ - - info on Cyclades-Z firmware loading. SAK.txt - info on Secure Attention Keys. SM501.txt @@ -86,20 +80,16 @@ blackfin/ - directory with documentation for the Blackfin arch. block/ - info on the Block I/O (BIO) layer. +blockdev/ + - info on block devices & drivers cachetlb.txt - describes the cache/TLB flushing interfaces Linux uses. -cciss.txt - - info, major/minor #'s for Compaq's SMART Array Controllers. cdrom/ - directory with information on the CD-ROM drivers that Linux has. -computone.txt - - info on Computone Intelliport II/Plus Multiport Serial Driver. connector/ - docs on the netlink based userspace<->kernel space communication mod. console/ - documentation on Linux console drivers. -cpqarray.txt - - info on using Compaq's SMART2 Intelligent Disk Array Controllers. cpu-freq/ - info on CPU frequency and voltage scaling. cpu-hotplug.txt @@ -126,8 +116,6 @@ device-mapper/ - directory with info on Device Mapper. devices.txt - plain ASCII listing of all the nodes in /dev/ with major minor #'s. -digiepca.txt - - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards. dontdiff - file containing a list of files that should never be diff'ed. driver-model/ @@ -152,14 +140,10 @@ filesystems/ - info on the vfs and the various filesystems that Linux supports. firmware_class/ - request_firmware() hotplug interface info. -floppy.txt - - notes and driver options for the floppy disk driver. frv/ - Fujitsu FR-V Linux documentation. gpio.txt - overview of GPIO (General Purpose Input/Output) access conventions. -hayes-esp.txt - - info on using the Hayes ESP serial driver. highuid.txt - notes on the change from 16 bit to 32 bit user/group IDs. timers/ @@ -186,8 +170,6 @@ io_ordering.txt - info on ordering I/O writes to memory-mapped addresses. ioctl/ - directory with documents describing various IOCTL calls. -ioctl-number.txt - - how to implement and register device/driver ioctl calls. iostats.txt - info on I/O statistics Linux kernel provides. irqflags-tracing.txt @@ -250,14 +232,10 @@ mips/ - directory with info about Linux on MIPS architecture. mono.txt - how to execute Mono-based .NET binaries with the help of BINFMT_MISC. -moxa-smartio - - file with info on installing/using Moxa multiport serial driver. mutex-design.txt - info on the generic mutex subsystem. namespaces/ - directory with various information about namespaces -nbd.txt - - info on a TCP implementation of a network block device. netlabel/ - directory with information on the NetLabel subsystem. networking/ @@ -270,8 +248,6 @@ numastat.txt - info on how to read Numa policy hit/miss statistics in sysfs. oops-tracing.txt - how to decode those nasty internal kernel error dump messages. -paride.txt - - information about the parallel port IDE subsystem. parisc/ - directory with info on using Linux on PA-RISC architecture. parport.txt @@ -292,18 +268,12 @@ preempt-locking.txt - info on locking under a preemptive kernel. prio_tree.txt - info on radix-priority-search-tree use for indexing vmas. -ramdisk.txt - - short guide on how to set up and use the RAM disk. rbtree.txt - info on what red-black trees are and what they are for. -riscom8.txt - - notes on using the RISCom/8 multi-port serial driver. robust-futex-ABI.txt - documentation of the robust futex ABI. robust-futexes.txt - a description of what robust futexes are. -rocket.txt - - info on the Comtrol RocketPort multiport serial driver. rt-mutex-design.txt - description of the RealTime mutex implementation design. rt-mutex.txt @@ -332,8 +302,6 @@ sparc/ - directory with info on using Linux on Sparc architecture. sparse.txt - info on how to obtain and use the sparse tool for typechecking. -specialix.txt - - info on hardware/driver for specialix IO8+ multiport serial card. spi/ - overview of Linux kernel Serial Peripheral Interface (SPI) support. spinlocks.txt @@ -342,14 +310,10 @@ stable_api_nonsense.txt - info on why the kernel does not have a stable in-kernel api or abi. stable_kernel_rules.txt - rules and procedures for the -stable kernel releases. -stallion.txt - - info on using the Stallion multiport serial driver. svga.txt - short guide on selecting video modes at boot via VGA BIOS. sysfs-rules.txt - How not to use sysfs. -sx.txt - - info on the Specialix SX/SI multiport serial driver. sysctl/ - directory with info on the /proc/sys/* files. sysrq.txt @@ -358,8 +322,6 @@ telephony/ - directory with info on telephony (e.g. voice over IP) support. time_interpolators.txt - info on time interpolators. -tty.txt - - guide to the locking policies of the tty layer. uml/ - directory with information about User Mode Linux. unicode.txt diff --git a/Documentation/PCI/00-INDEX b/Documentation/PCI/00-INDEX index 49f4394..812b17f 100644 --- a/Documentation/PCI/00-INDEX +++ b/Documentation/PCI/00-INDEX @@ -1,5 +1,7 @@ 00-INDEX - this file +MSI-HOWTO.txt + - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ. PCI-DMA-mapping.txt - info for PCI drivers using DMA portably across all platforms PCIEBUS-HOWTO.txt diff --git a/Documentation/MSI-HOWTO.txt b/Documentation/PCI/MSI-HOWTO.txt index 256defd7..256defd7 100644 --- a/Documentation/MSI-HOWTO.txt +++ b/Documentation/PCI/MSI-HOWTO.txt diff --git a/Documentation/blockdev/00-INDEX b/Documentation/blockdev/00-INDEX new file mode 100644 index 0000000..86f054c --- /dev/null +++ b/Documentation/blockdev/00-INDEX @@ -0,0 +1,16 @@ +00-INDEX + - this file +README.DAC960 + - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux. +cciss.txt + - info, major/minor #'s for Compaq's SMART Array Controllers. +cpqarray.txt + - info on using Compaq's SMART2 Intelligent Disk Array Controllers. +floppy.txt + - notes and driver options for the floppy disk driver. +nbd.txt + - info on a TCP implementation of a network block device. +paride.txt + - information about the parallel port IDE subsystem. +ramdisk.txt + - short guide on how to set up and use the RAM disk. diff --git a/Documentation/README.DAC960 b/Documentation/blockdev/README.DAC960 index 0e8f618..0e8f618 100644 --- a/Documentation/README.DAC960 +++ b/Documentation/blockdev/README.DAC960 diff --git a/Documentation/cciss.txt b/Documentation/blockdev/cciss.txt index 89698e8..89698e8 100644 --- a/Documentation/cciss.txt +++ b/Documentation/blockdev/cciss.txt diff --git a/Documentation/cpqarray.txt b/Documentation/blockdev/cpqarray.txt index c7154e2..c7154e2 100644 --- a/Documentation/cpqarray.txt +++ b/Documentation/blockdev/cpqarray.txt diff --git a/Documentation/floppy.txt b/Documentation/blockdev/floppy.txt index 6ccab88..6ccab88 100644 --- a/Documentation/floppy.txt +++ b/Documentation/blockdev/floppy.txt diff --git a/Documentation/nbd.txt b/Documentation/blockdev/nbd.txt index aeb93ff..aeb93ff 100644 --- a/Documentation/nbd.txt +++ b/Documentation/blockdev/nbd.txt diff --git a/Documentation/paride.txt b/Documentation/blockdev/paride.txt index e431267..e431267 100644 --- a/Documentation/paride.txt +++ b/Documentation/blockdev/paride.txt diff --git a/Documentation/ramdisk.txt b/Documentation/blockdev/ramdisk.txt index 6c820ba..6c820ba 100644 --- a/Documentation/ramdisk.txt +++ b/Documentation/blockdev/ramdisk.txt diff --git a/Documentation/ioctl/00-INDEX b/Documentation/ioctl/00-INDEX new file mode 100644 index 0000000..d2fe4d4 --- /dev/null +++ b/Documentation/ioctl/00-INDEX @@ -0,0 +1,10 @@ +00-INDEX + - this file +cdrom.txt + - summary of CDROM ioctl calls +hdio.txt + - summary of HDIO_ ioctl calls +ioctl-decoding.txt + - how to decode the bits of an IOCTL code +ioctl-number.txt + - how to implement and register device/driver ioctl calls diff --git a/Documentation/ioctl-number.txt b/Documentation/ioctl/ioctl-number.txt index b880ce5..b880ce5 100644 --- a/Documentation/ioctl-number.txt +++ b/Documentation/ioctl/ioctl-number.txt diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt index c600c4f..9fa6508 100644 --- a/Documentation/kernel-parameters.txt +++ b/Documentation/kernel-parameters.txt @@ -629,7 +629,7 @@ and is between 256 and 4096 characters. It is defined in the file digiepca= [HW,SERIAL] See drivers/char/README.epca and - Documentation/digiepca.txt. + Documentation/serial/digiepca.txt. disable_mtrr_cleanup [X86] enable_mtrr_cleanup [X86] @@ -740,7 +740,7 @@ and is between 256 and 4096 characters. It is defined in the file See header of drivers/scsi/fdomain.c. floppy= [HW] - See Documentation/floppy.txt. + See Documentation/blockdev/floppy.txt. force_pal_cache_flush [IA-64] Avoid check_sal_cache_flush which may hang on @@ -1101,7 +1101,7 @@ and is between 256 and 4096 characters. It is defined in the file the same attribute, the last one is used. load_ramdisk= [RAM] List of ramdisks to load from floppy - See Documentation/ramdisk.txt. + See Documentation/blockdev/ramdisk.txt. lockd.nlm_grace_period=P [NFS] Assign grace period. Format: <integer> @@ -1596,7 +1596,7 @@ and is between 256 and 4096 characters. It is defined in the file pcd. [PARIDE] See header of drivers/block/paride/pcd.c. - See also Documentation/paride.txt. + See also Documentation/blockdev/paride.txt. pci=option[,option...] [PCI] various PCI subsystem options: off [X86] don't probe for the PCI bus @@ -1697,7 +1697,7 @@ and is between 256 and 4096 characters. It is defined in the file pcmv= [HW,PCMCIA] BadgePAD 4 pd. [PARIDE] - See Documentation/paride.txt. + See Documentation/blockdev/paride.txt. pdcchassis= [PARISC,HW] Disable/Enable PDC Chassis Status codes at boot time. @@ -1705,10 +1705,10 @@ and is between 256 and 4096 characters. It is defined in the file See arch/parisc/kernel/pdc_chassis.c pf. [PARIDE] - See Documentation/paride.txt. + See Documentation/blockdev/paride.txt. pg. [PARIDE] - See Documentation/paride.txt. + See Documentation/blockdev/paride.txt. pirq= [SMP,APIC] Manual mp-table setup See Documentation/x86/i386/IO-APIC.txt. @@ -1778,7 +1778,7 @@ and is between 256 and 4096 characters. It is defined in the file prompt_ramdisk= [RAM] List of RAM disks to prompt for floppy disk before loading. - See Documentation/ramdisk.txt. + See Documentation/blockdev/ramdisk.txt. psmouse.proto= [HW,MOUSE] Highest PS2 mouse protocol extension to probe for; one of (bare|imps|exps|lifebook|any). @@ -1798,7 +1798,7 @@ and is between 256 and 4096 characters. It is defined in the file <io>,<mss_io>,<mss_irq>,<mss_dma>,<mpu_io>,<mpu_irq> pt. [PARIDE] - See Documentation/paride.txt. + See Documentation/blockdev/paride.txt. pty.legacy_count= [KNL] Number of legacy pty's. Overwrites compiled-in @@ -1812,10 +1812,10 @@ and is between 256 and 4096 characters. It is defined in the file See Documentation/md.txt. ramdisk_blocksize= [RAM] - See Documentation/ramdisk.txt. + See Documentation/blockdev/ramdisk.txt. ramdisk_size= [RAM] Sizes of RAM disks in kilobytes - See Documentation/ramdisk.txt. + See Documentation/blockdev/ramdisk.txt. rcupdate.blimit= [KNL,BOOT] Set maximum number of finished RCU callbacks to process @@ -2147,7 +2147,7 @@ and is between 256 and 4096 characters. It is defined in the file See Documentation/sonypi.txt specialix= [HW,SERIAL] Specialix multi-serial port adapter - See Documentation/specialix.txt. + See Documentation/serial/specialix.txt. spia_io_base= [HW,MTD] spia_fio_base= diff --git a/Documentation/serial/00-INDEX b/Documentation/serial/00-INDEX new file mode 100644 index 0000000..07dcdb0 --- /dev/null +++ b/Documentation/serial/00-INDEX @@ -0,0 +1,24 @@ +00-INDEX + - this file. +README.cycladesZ + - info on Cyclades-Z firmware loading. +computone.txt + - info on Computone Intelliport II/Plus Multiport Serial Driver. +digiepca.txt + - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards. +hayes-esp.txt + - info on using the Hayes ESP serial driver. +moxa-smartio + - file with info on installing/using Moxa multiport serial driver. +riscom8.txt + - notes on using the RISCom/8 multi-port serial driver. +rocket.txt + - info on the Comtrol RocketPort multiport serial driver. +specialix.txt + - info on hardware/driver for specialix IO8+ multiport serial card. +stallion.txt + - info on using the Stallion multiport serial driver. +sx.txt + - info on the Specialix SX/SI multiport serial driver. +tty.txt + - guide to the locking policies of the tty layer. diff --git a/Documentation/README.cycladesZ b/Documentation/serial/README.cycladesZ index 024a694..024a694 100644 --- a/Documentation/README.cycladesZ +++ b/Documentation/serial/README.cycladesZ diff --git a/Documentation/computone.txt b/Documentation/serial/computone.txt index 5e2a0c7..c57ea47 100644 --- a/Documentation/computone.txt +++ b/Documentation/serial/computone.txt @@ -247,7 +247,7 @@ shar archive to make it easier to extract the script from the documentation. To create the ip2mkdev shell script change to a convenient directory (/tmp works just fine) and run the following command: - unshar Documentation/computone.txt + unshar Documentation/serial/computone.txt (This file) You should now have a file ip2mkdev in your current working directory with diff --git a/Documentation/digiepca.txt b/Documentation/serial/digiepca.txt index f2560e2..f2560e2 100644 --- a/Documentation/digiepca.txt +++ b/Documentation/serial/digiepca.txt diff --git a/Documentation/hayes-esp.txt b/Documentation/serial/hayes-esp.txt index 09b5d58..09b5d58 100644 --- a/Documentation/hayes-esp.txt +++ b/Documentation/serial/hayes-esp.txt diff --git a/Documentation/moxa-smartio b/Documentation/serial/moxa-smartio index 5337e80..5337e80 100644 --- a/Documentation/moxa-smartio +++ b/Documentation/serial/moxa-smartio diff --git a/Documentation/riscom8.txt b/Documentation/serial/riscom8.txt index 14f61fd..14f61fd 100644 --- a/Documentation/riscom8.txt +++ b/Documentation/serial/riscom8.txt diff --git a/Documentation/rocket.txt b/Documentation/serial/rocket.txt index 1d85829..1d85829 100644 --- a/Documentation/rocket.txt +++ b/Documentation/serial/rocket.txt diff --git a/Documentation/specialix.txt b/Documentation/serial/specialix.txt index 6eb6f3a..6eb6f3a 100644 --- a/Documentation/specialix.txt +++ b/Documentation/serial/specialix.txt diff --git a/Documentation/stallion.txt b/Documentation/serial/stallion.txt index 5c4902d..5c4902d 100644 --- a/Documentation/stallion.txt +++ b/Documentation/serial/stallion.txt diff --git a/Documentation/sx.txt b/Documentation/serial/sx.txt index cb4efa0..cb4efa0 100644 --- a/Documentation/sx.txt +++ b/Documentation/serial/sx.txt diff --git a/Documentation/tty.txt b/Documentation/serial/tty.txt index 8e65c44..8e65c44 100644 --- a/Documentation/tty.txt +++ b/Documentation/serial/tty.txt |