Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

+96 -81
+2 -40
Documentation/00-INDEX
··· 42 42 - description of what an IRQ is. 43 43 ManagementStyle 44 44 - how to (attempt to) manage kernel hackers. 45 - MSI-HOWTO.txt 46 - - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ. 47 45 RCU/ 48 46 - directory with info on RCU (read-copy update). 49 - README.DAC960 50 - - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux. 51 - README.cycladesZ 52 - - info on Cyclades-Z firmware loading. 53 47 SAK.txt 54 48 - info on Secure Attention Keys. 55 49 SM501.txt ··· 80 86 - directory with documentation for the Blackfin arch. 81 87 block/ 82 88 - info on the Block I/O (BIO) layer. 89 + blockdev/ 90 + - info on block devices & drivers 83 91 cachetlb.txt 84 92 - describes the cache/TLB flushing interfaces Linux uses. 85 - cciss.txt 86 - - info, major/minor #'s for Compaq's SMART Array Controllers. 87 93 cdrom/ 88 94 - directory with information on the CD-ROM drivers that Linux has. 89 - computone.txt 90 - - info on Computone Intelliport II/Plus Multiport Serial Driver. 91 95 connector/ 92 96 - docs on the netlink based userspace<->kernel space communication mod. 93 97 console/ 94 98 - documentation on Linux console drivers. 95 - cpqarray.txt 96 - - info on using Compaq's SMART2 Intelligent Disk Array Controllers. 97 99 cpu-freq/ 98 100 - info on CPU frequency and voltage scaling. 99 101 cpu-hotplug.txt ··· 116 126 - directory with info on Device Mapper. 117 127 devices.txt 118 128 - plain ASCII listing of all the nodes in /dev/ with major minor #'s. 119 - digiepca.txt 120 - - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards. 121 129 dontdiff 122 130 - file containing a list of files that should never be diff'ed. 123 131 driver-model/ ··· 140 152 - info on the vfs and the various filesystems that Linux supports. 141 153 firmware_class/ 142 154 - request_firmware() hotplug interface info. 143 - floppy.txt 144 - - notes and driver options for the floppy disk driver. 145 155 frv/ 146 156 - Fujitsu FR-V Linux documentation. 147 157 gpio.txt 148 158 - overview of GPIO (General Purpose Input/Output) access conventions. 149 - hayes-esp.txt 150 - - info on using the Hayes ESP serial driver. 151 159 highuid.txt 152 160 - notes on the change from 16 bit to 32 bit user/group IDs. 153 161 timers/ ··· 170 186 - info on ordering I/O writes to memory-mapped addresses. 171 187 ioctl/ 172 188 - directory with documents describing various IOCTL calls. 173 - ioctl-number.txt 174 - - how to implement and register device/driver ioctl calls. 175 189 iostats.txt 176 190 - info on I/O statistics Linux kernel provides. 177 191 irqflags-tracing.txt ··· 232 250 - directory with info about Linux on MIPS architecture. 233 251 mono.txt 234 252 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC. 235 - moxa-smartio 236 - - file with info on installing/using Moxa multiport serial driver. 237 253 mutex-design.txt 238 254 - info on the generic mutex subsystem. 239 255 namespaces/ 240 256 - directory with various information about namespaces 241 - nbd.txt 242 - - info on a TCP implementation of a network block device. 243 257 netlabel/ 244 258 - directory with information on the NetLabel subsystem. 245 259 networking/ ··· 248 270 - info on how to read Numa policy hit/miss statistics in sysfs. 249 271 oops-tracing.txt 250 272 - how to decode those nasty internal kernel error dump messages. 251 - paride.txt 252 - - information about the parallel port IDE subsystem. 253 273 parisc/ 254 274 - directory with info on using Linux on PA-RISC architecture. 255 275 parport.txt ··· 268 292 - info on locking under a preemptive kernel. 269 293 prio_tree.txt 270 294 - info on radix-priority-search-tree use for indexing vmas. 271 - ramdisk.txt 272 - - short guide on how to set up and use the RAM disk. 273 295 rbtree.txt 274 296 - info on what red-black trees are and what they are for. 275 - riscom8.txt 276 - - notes on using the RISCom/8 multi-port serial driver. 277 297 robust-futex-ABI.txt 278 298 - documentation of the robust futex ABI. 279 299 robust-futexes.txt 280 300 - a description of what robust futexes are. 281 - rocket.txt 282 - - info on the Comtrol RocketPort multiport serial driver. 283 301 rt-mutex-design.txt 284 302 - description of the RealTime mutex implementation design. 285 303 rt-mutex.txt ··· 302 332 - directory with info on using Linux on Sparc architecture. 303 333 sparse.txt 304 334 - info on how to obtain and use the sparse tool for typechecking. 305 - specialix.txt 306 - - info on hardware/driver for specialix IO8+ multiport serial card. 307 335 spi/ 308 336 - overview of Linux kernel Serial Peripheral Interface (SPI) support. 309 337 spinlocks.txt ··· 310 342 - info on why the kernel does not have a stable in-kernel api or abi. 311 343 stable_kernel_rules.txt 312 344 - rules and procedures for the -stable kernel releases. 313 - stallion.txt 314 - - info on using the Stallion multiport serial driver. 315 345 svga.txt 316 346 - short guide on selecting video modes at boot via VGA BIOS. 317 347 sysfs-rules.txt 318 348 - How not to use sysfs. 319 - sx.txt 320 - - info on the Specialix SX/SI multiport serial driver. 321 349 sysctl/ 322 350 - directory with info on the /proc/sys/* files. 323 351 sysrq.txt ··· 322 358 - directory with info on telephony (e.g. voice over IP) support. 323 359 time_interpolators.txt 324 360 - info on time interpolators. 325 - tty.txt 326 - - guide to the locking policies of the tty layer. 327 361 uml/ 328 362 - directory with information about User Mode Linux. 329 363 unicode.txt
Documentation/MSI-HOWTO.txt Documentation/PCI/MSI-HOWTO.txt
+2
Documentation/PCI/00-INDEX
··· 1 1 00-INDEX 2 2 - this file 3 + MSI-HOWTO.txt 4 + - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ. 3 5 PCI-DMA-mapping.txt 4 6 - info for PCI drivers using DMA portably across all platforms 5 7 PCIEBUS-HOWTO.txt
Documentation/README.DAC960 Documentation/blockdev/README.DAC960
Documentation/README.cycladesZ Documentation/serial/README.cycladesZ
+16
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 + nbd.txt 12 + - info on a TCP implementation of a network block device. 13 + paride.txt 14 + - information about the parallel port IDE subsystem. 15 + ramdisk.txt 16 + - short guide on how to set up and use the RAM disk.
Documentation/cciss.txt Documentation/blockdev/cciss.txt
+1 -1
Documentation/computone.txt Documentation/serial/computone.txt
··· 247 247 To create the ip2mkdev shell script change to a convenient directory (/tmp 248 248 works just fine) and run the following command: 249 249 250 - unshar Documentation/computone.txt 250 + unshar Documentation/serial/computone.txt 251 251 (This file) 252 252 253 253 You should now have a file ip2mkdev in your current working directory with
Documentation/cpqarray.txt Documentation/blockdev/cpqarray.txt
Documentation/digiepca.txt Documentation/serial/digiepca.txt
Documentation/floppy.txt Documentation/blockdev/floppy.txt
Documentation/hayes-esp.txt Documentation/serial/hayes-esp.txt
Documentation/ioctl-number.txt Documentation/ioctl/ioctl-number.txt
+10
Documentation/ioctl/00-INDEX
··· 1 + 00-INDEX 2 + - this file 3 + cdrom.txt 4 + - summary of CDROM ioctl calls 5 + hdio.txt 6 + - summary of HDIO_ ioctl calls 7 + ioctl-decoding.txt 8 + - how to decode the bits of an IOCTL code 9 + ioctl-number.txt 10 + - how to implement and register device/driver ioctl calls
+12 -12
Documentation/kernel-parameters.txt
··· 629 629 630 630 digiepca= [HW,SERIAL] 631 631 See drivers/char/README.epca and 632 - Documentation/digiepca.txt. 632 + Documentation/serial/digiepca.txt. 633 633 634 634 disable_mtrr_cleanup [X86] 635 635 enable_mtrr_cleanup [X86] ··· 740 740 See header of drivers/scsi/fdomain.c. 741 741 742 742 floppy= [HW] 743 - See Documentation/floppy.txt. 743 + See Documentation/blockdev/floppy.txt. 744 744 745 745 force_pal_cache_flush 746 746 [IA-64] Avoid check_sal_cache_flush which may hang on ··· 1101 1101 the same attribute, the last one is used. 1102 1102 1103 1103 load_ramdisk= [RAM] List of ramdisks to load from floppy 1104 - See Documentation/ramdisk.txt. 1104 + See Documentation/blockdev/ramdisk.txt. 1105 1105 1106 1106 lockd.nlm_grace_period=P [NFS] Assign grace period. 1107 1107 Format: <integer> ··· 1596 1596 1597 1597 pcd. [PARIDE] 1598 1598 See header of drivers/block/paride/pcd.c. 1599 - See also Documentation/paride.txt. 1599 + See also Documentation/blockdev/paride.txt. 1600 1600 1601 1601 pci=option[,option...] [PCI] various PCI subsystem options: 1602 1602 off [X86] don't probe for the PCI bus ··· 1697 1697 pcmv= [HW,PCMCIA] BadgePAD 4 1698 1698 1699 1699 pd. [PARIDE] 1700 - See Documentation/paride.txt. 1700 + See Documentation/blockdev/paride.txt. 1701 1701 1702 1702 pdcchassis= [PARISC,HW] Disable/Enable PDC Chassis Status codes at 1703 1703 boot time. ··· 1705 1705 See arch/parisc/kernel/pdc_chassis.c 1706 1706 1707 1707 pf. [PARIDE] 1708 - See Documentation/paride.txt. 1708 + See Documentation/blockdev/paride.txt. 1709 1709 1710 1710 pg. [PARIDE] 1711 - See Documentation/paride.txt. 1711 + See Documentation/blockdev/paride.txt. 1712 1712 1713 1713 pirq= [SMP,APIC] Manual mp-table setup 1714 1714 See Documentation/x86/i386/IO-APIC.txt. ··· 1778 1778 1779 1779 prompt_ramdisk= [RAM] List of RAM disks to prompt for floppy disk 1780 1780 before loading. 1781 - See Documentation/ramdisk.txt. 1781 + See Documentation/blockdev/ramdisk.txt. 1782 1782 1783 1783 psmouse.proto= [HW,MOUSE] Highest PS2 mouse protocol extension to 1784 1784 probe for; one of (bare|imps|exps|lifebook|any). ··· 1798 1798 <io>,<mss_io>,<mss_irq>,<mss_dma>,<mpu_io>,<mpu_irq> 1799 1799 1800 1800 pt. [PARIDE] 1801 - See Documentation/paride.txt. 1801 + See Documentation/blockdev/paride.txt. 1802 1802 1803 1803 pty.legacy_count= 1804 1804 [KNL] Number of legacy pty's. Overwrites compiled-in ··· 1812 1812 See Documentation/md.txt. 1813 1813 1814 1814 ramdisk_blocksize= [RAM] 1815 - See Documentation/ramdisk.txt. 1815 + See Documentation/blockdev/ramdisk.txt. 1816 1816 1817 1817 ramdisk_size= [RAM] Sizes of RAM disks in kilobytes 1818 - See Documentation/ramdisk.txt. 1818 + See Documentation/blockdev/ramdisk.txt. 1819 1819 1820 1820 rcupdate.blimit= [KNL,BOOT] 1821 1821 Set maximum number of finished RCU callbacks to process ··· 2147 2147 See Documentation/sonypi.txt 2148 2148 2149 2149 specialix= [HW,SERIAL] Specialix multi-serial port adapter 2150 - See Documentation/specialix.txt. 2150 + See Documentation/serial/specialix.txt. 2151 2151 2152 2152 spia_io_base= [HW,MTD] 2153 2153 spia_fio_base=
Documentation/moxa-smartio Documentation/serial/moxa-smartio
Documentation/nbd.txt Documentation/blockdev/nbd.txt
Documentation/paride.txt Documentation/blockdev/paride.txt
Documentation/ramdisk.txt Documentation/blockdev/ramdisk.txt
Documentation/riscom8.txt Documentation/serial/riscom8.txt
Documentation/rocket.txt Documentation/serial/rocket.txt
+24
Documentation/serial/00-INDEX
··· 1 + 00-INDEX 2 + - this file. 3 + README.cycladesZ 4 + - info on Cyclades-Z firmware loading. 5 + computone.txt 6 + - info on Computone Intelliport II/Plus Multiport Serial Driver. 7 + digiepca.txt 8 + - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards. 9 + hayes-esp.txt 10 + - info on using the Hayes ESP serial driver. 11 + moxa-smartio 12 + - file with info on installing/using Moxa multiport serial driver. 13 + riscom8.txt 14 + - notes on using the RISCom/8 multi-port serial driver. 15 + rocket.txt 16 + - info on the Comtrol RocketPort multiport serial driver. 17 + specialix.txt 18 + - info on hardware/driver for specialix IO8+ multiport serial card. 19 + stallion.txt 20 + - info on using the Stallion multiport serial driver. 21 + sx.txt 22 + - info on the Specialix SX/SI multiport serial driver. 23 + tty.txt 24 + - guide to the locking policies of the tty layer.
Documentation/specialix.txt Documentation/serial/specialix.txt
Documentation/stallion.txt Documentation/serial/stallion.txt
Documentation/sx.txt Documentation/serial/sx.txt
Documentation/tty.txt Documentation/serial/tty.txt
+15 -14
drivers/block/Kconfig
··· 21 21 ---help--- 22 22 If you want to use the floppy disk drive(s) of your PC under Linux, 23 23 say Y. Information about this driver, especially important for IBM 24 - Thinkpad users, is contained in <file:Documentation/floppy.txt>. 24 + Thinkpad users, is contained in 25 + <file:Documentation/blockdev/floppy.txt>. 25 26 That file also contains the location of the Floppy driver FAQ as 26 27 well as location of the fdutils package used to configure additional 27 28 parameters of the driver at run time. ··· 77 76 your computer's parallel port. Most of them are actually IDE devices 78 77 using a parallel port IDE adapter. This option enables the PARIDE 79 78 subsystem which contains drivers for many of these external drives. 80 - Read <file:Documentation/paride.txt> for more information. 79 + Read <file:Documentation/blockdev/paride.txt> for more information. 81 80 82 81 If you have said Y to the "Parallel-port support" configuration 83 82 option, you may share a single port between your printer and other ··· 115 114 help 116 115 This is the driver for Compaq Smart Array controllers. Everyone 117 116 using these boards should say Y here. See the file 118 - <file:Documentation/cpqarray.txt> for the current list of boards 119 - supported by this driver, and for further information on the use of 120 - this driver. 117 + <file:Documentation/blockdev/cpqarray.txt> for the current list of 118 + boards supported by this driver, and for further information on the 119 + use of this driver. 121 120 122 121 config BLK_CPQ_CISS_DA 123 122 tristate "Compaq Smart Array 5xxx support" ··· 125 124 help 126 125 This is the driver for Compaq Smart Array 5xxx controllers. 127 126 Everyone using these boards should say Y here. 128 - See <file:Documentation/cciss.txt> for the current list of 127 + See <file:Documentation/blockdev/cciss.txt> for the current list of 129 128 boards supported by this driver, and for further information 130 129 on the use of this driver. 131 130 ··· 136 135 help 137 136 When enabled (Y), this option allows SCSI tape drives and SCSI medium 138 137 changers (tape robots) to be accessed via a Compaq 5xxx array 139 - controller. (See <file:Documentation/cciss.txt> for more details.) 138 + controller. (See <file:Documentation/blockdev/cciss.txt> for more details.) 140 139 141 140 "SCSI support" and "SCSI tape support" must also be enabled for this 142 141 option to work. ··· 150 149 help 151 150 This driver adds support for the Mylex DAC960, AcceleRAID, and 152 151 eXtremeRAID PCI RAID controllers. See the file 153 - <file:Documentation/README.DAC960> for further information about 154 - this driver. 152 + <file:Documentation/blockdev/README.DAC960> for further information 153 + about this driver. 155 154 156 155 To compile this driver as a module, choose M here: the 157 156 module will be called DAC960. ··· 279 278 userland (making server and client physically the same computer, 280 279 communicating using the loopback network device). 281 280 282 - Read <file:Documentation/nbd.txt> for more information, especially 283 - about where to find the server code, which runs in user space and 284 - does not need special kernel support. 281 + Read <file:Documentation/blockdev/nbd.txt> for more information, 282 + especially about where to find the server code, which runs in user 283 + space and does not need special kernel support. 285 284 286 285 Note that this has nothing to do with the network file systems NFS 287 286 or Coda; you can say N here even if you intend to use NFS or Coda. ··· 322 321 store a copy of a minimal root file system off of a floppy into RAM 323 322 during the initial install of Linux. 324 323 325 - Note that the kernel command line option "ramdisk=XX" is now 326 - obsolete. For details, read <file:Documentation/ramdisk.txt>. 324 + Note that the kernel command line option "ramdisk=XX" is now obsolete. 325 + For details, read <file:Documentation/blockdev/ramdisk.txt>. 327 326 328 327 To compile this driver as a module, choose M here: the 329 328 module will be called rd.
+1 -1
drivers/block/floppy.c
··· 4124 4124 printk("\n"); 4125 4125 } else 4126 4126 DPRINT("botched floppy option\n"); 4127 - DPRINT("Read Documentation/floppy.txt\n"); 4127 + DPRINT("Read Documentation/blockdev/floppy.txt\n"); 4128 4128 return 0; 4129 4129 } 4130 4130
+12 -12
drivers/char/Kconfig
··· 124 124 which give you many serial ports. You would need something like this 125 125 to connect more than two modems to your Linux box, for instance in 126 126 order to become a dial-in server. If you have a card like that, say 127 - Y here and read <file:Documentation/computone.txt>. 127 + Y here and read <file:Documentation/serial/computone.txt>. 128 128 129 129 To compile this driver as module, choose M here: the 130 130 module will be called ip2. ··· 136 136 This driver supports Comtrol RocketPort and RocketModem PCI boards. 137 137 These boards provide 2, 4, 8, 16, or 32 high-speed serial ports or 138 138 modems. For information about the RocketPort/RocketModem boards 139 - and this driver read <file:Documentation/rocket.txt>. 139 + and this driver read <file:Documentation/serial/rocket.txt>. 140 140 141 141 To compile this driver as a module, choose M here: the 142 142 module will be called rocket. ··· 154 154 your Linux box, for instance in order to become a dial-in server. 155 155 156 156 For information about the Cyclades-Z card, read 157 - <file:Documentation/README.cycladesZ>. 157 + <file:Documentation/serial/README.cycladesZ>. 158 158 159 159 To compile this driver as a module, choose M here: the 160 160 module will be called cyclades. ··· 183 183 box, for instance in order to become a dial-in server. This driver 184 184 supports the original PC (ISA) boards as well as PCI, and EISA. If 185 185 you have a card like this, say Y here and read the file 186 - <file:Documentation/digiepca.txt>. 186 + <file:Documentation/serial/digiepca.txt>. 187 187 188 188 To compile this driver as a module, choose M here: the 189 189 module will be called epca. ··· 289 289 which gives you many serial ports. You would need something like 290 290 this to connect more than two modems to your Linux box, for instance 291 291 in order to become a dial-in server. If you have a card like that, 292 - say Y here and read the file <file:Documentation/riscom8.txt>. 292 + say Y here and read the file <file:Documentation/serial/riscom8.txt>. 293 293 294 294 Also it's possible to say M here and compile this driver as kernel 295 295 loadable module; the module will be called riscom8. ··· 304 304 your Linux box, for instance in order to become a dial-in server. 305 305 306 306 If you have a card like that, say Y here and read the file 307 - <file:Documentation/specialix.txt>. Also it's possible to say M here 308 - and compile this driver as kernel loadable module which will be 307 + <file:Documentation/serial/specialix.txt>. Also it's possible to say 308 + M here and compile this driver as kernel loadable module which will be 309 309 called specialix. 310 310 311 311 config SX ··· 313 313 depends on SERIAL_NONSTANDARD && (PCI || EISA || ISA) 314 314 help 315 315 This is a driver for the SX and SI multiport serial cards. 316 - Please read the file <file:Documentation/sx.txt> for details. 316 + Please read the file <file:Documentation/serial/sx.txt> for details. 317 317 318 318 This driver can only be built as a module ( = code which can be 319 319 inserted in and removed from the running kernel whenever you want). ··· 344 344 like this to connect more than two modems to your Linux box, for 345 345 instance in order to become a dial-in server. If you say Y here, 346 346 you will be asked for your specific card model in the next 347 - questions. Make sure to read <file:Documentation/stallion.txt> in 348 - this case. If you have never heard about all this, it's safe to 347 + questions. Make sure to read <file:Documentation/serial/stallion.txt> 348 + in this case. If you have never heard about all this, it's safe to 349 349 say N. 350 350 351 351 config STALLION ··· 354 354 help 355 355 If you have an EasyIO or EasyConnection 8/32 multiport Stallion 356 356 card, then this is for you; say Y. Make sure to read 357 - <file:Documentation/stallion.txt>. 357 + <file:Documentation/serial/stallion.txt>. 358 358 359 359 To compile this driver as a module, choose M here: the 360 360 module will be called stallion. ··· 365 365 help 366 366 If you have an EasyConnection 8/64, ONboard, Brumby or Stallion 367 367 serial multiport card, say Y here. Make sure to read 368 - <file:Documentation/stallion.txt>. 368 + <file:Documentation/serial/stallion.txt>. 369 369 370 370 To compile this driver as a module, choose M here: the 371 371 module will be called istallion.
+1 -1
drivers/char/specialix.c
··· 72 72 /* 73 73 * There is a bunch of documentation about the card, jumpers, config 74 74 * settings, restrictions, cables, device names and numbers in 75 - * Documentation/specialix.txt 75 + * Documentation/serial/specialix.txt 76 76 */ 77 77 78 78 #include <linux/module.h>