Documentation updates to 2.1.93

Paul Gortmaker (paul@rasty.ph.unimelb.edu.au)
Wed, 8 Apr 1998 15:59:30 +1000 (EST)


This is a 100% safe patch - it doesn't touch one line of code :) It
clears out my own list of documentation updates and typo fixes.

Paul.

--

diff -ur linux-2193/Documentation/00-INDEX linux/Documentation/00-INDEX --- linux-2193/Documentation/00-INDEX Fri Mar 13 15:01:27 1998 +++ linux/Documentation/00-INDEX Wed Apr 8 12:42:32 1998 @@ -56,6 +56,8 @@ - info on the in-kernel binary support for Java(tm) joystick.txt - info on using joystick devices (and driver) with linux. +kmod.txt + - info on the kernel module loader/unloader (kerneld replacement) locks.txt - info on file locking implementations, flock() vs. fcntl(), etc. logo.gif @@ -84,6 +86,8 @@ - short guide on setting up a diskless box with NFS root filesystem oops-tracing.txt - how to decode those nasty internal kernel error dump messages. +pci.txt + - info on how a driver should query/probe for PCI devices/resources. pcwd-watchdog.txt - info and sample code for using with the PC Watchdog reset card. paride.txt @@ -106,6 +110,8 @@ - description of the Smart Config makefile feature. smp.tex - TeX document describing implementation of Multiprocessor Linux +sound/ + - directory with information relating to the linux sound driver. specialix.txt - info on hardware/driver for specialix IO8+ multiport serial card. spinlocks.txt @@ -114,6 +120,10 @@ - info on using the Stallion multiport serial driver. svga.txt - short guide on selecting video modes at boot via VGA BIOS. +sysctl/ + - directory with info on how to tune your /proc/sys kernel values. +sysrq.txt + - info on using the `magic' SysRq hot-key for when things go wrong. transname.txt - how to use name translation to ease use of diskless systems. unicode.txt diff -ur linux-2193/Documentation/cdrom/00-INDEX linux/Documentation/cdrom/00-INDEX --- linux-2193/Documentation/cdrom/00-INDEX Sun Dec 28 20:05:44 1997 +++ linux/Documentation/cdrom/00-INDEX Wed Apr 8 14:33:51 1998 @@ -1,8 +1,9 @@ 00-INDEX - this file (info on CD-ROMs and Linux) +Makefile + - only used to generate TeX output from the documentation. aztcd - info on Aztech/Orchid/Okano/Wearnes/Conrad/CyCDROM driver. - cdrom-standard.tex - LaTeX document on standardizing the CD-ROM programming interface. cdu31a diff -ur linux-2193/Documentation/filesystems/00-INDEX linux/Documentation/filesystems/00-INDEX --- linux-2193/Documentation/filesystems/00-INDEX Thu Oct 23 21:00:14 1997 +++ linux/Documentation/filesystems/00-INDEX Wed Apr 8 14:51:08 1998 @@ -2,12 +2,18 @@ - this file (info on some of the filesystems supported by linux). affs.txt - info and mount options for the Amiga Fast File System. +coda.txt + - how to use and where to get more info on the Coda filesystem. +fat_cvf.txt + - info on Compressed Volume Files on FAT fs (Doublespace, etc.) hpfs.txt - info and mount options for the OS/2 HPFS. isofs.txt - info and mount options for the ISO9660 (CDROM) filesystem. ncpfs.txt - info on Novell Netware(tm) filesystem using NCP protocol. +ntfs.txt + - info on mounting and reading Windows NT volumes with linux. romfs.txt - Description of the ROMFS filesystem. smbfs.txt @@ -18,3 +24,5 @@ - info on the umsdos extensions to the msdos filesystem. vfat.txt - info on using the VFAT filesystem used in Win NT and Win 95 +vfs.txt + - info on the Virtual File System layer used in the kernel. diff -ur linux-2193/Documentation/filesystems/vfs.txt linux/Documentation/filesystems/vfs.txt --- linux-2193/Documentation/filesystems/vfs.txt Fri Mar 13 15:01:31 1998 +++ linux/Documentation/filesystems/vfs.txt Wed Apr 8 14:46:35 1998 @@ -5,7 +5,7 @@ Noone else seems to be writing this, so here's a quick description of what I've learned while writing lofs... -The VFS relatively simple, but it is nice not to have to browse through +The VFS is relatively simple, but it is nice not to have to browse through pages of code to determine what is expected when writing a filesystem. Hopefully this helps anyone attempting such a feat, as well as clearing up a few important points/dependencies. diff -ur linux-2193/Documentation/initrd.txt linux/Documentation/initrd.txt --- linux-2193/Documentation/initrd.txt Fri Apr 12 06:49:29 1996 +++ linux/Documentation/initrd.txt Wed Apr 8 12:47:37 1998 @@ -93,7 +93,7 @@ First, the "normal" root file system has to be prepared as follows: -# mknod /dev/initrd b 0 250 +# mknod /dev/initrd b 1 250 # chmod 400 /dev/initrd # mkdir /initrd diff -ur linux-2193/Documentation/networking/00-INDEX linux/Documentation/networking/00-INDEX --- linux-2193/Documentation/networking/00-INDEX Sun Feb 2 13:18:29 1997 +++ linux/Documentation/networking/00-INDEX Wed Apr 8 14:30:56 1998 @@ -4,6 +4,10 @@ - information on the 3Com EtherLink Plus (3c505) driver. Configurable - info on some of the configurable network parameters +DLINK.txt + - info on the D-Link DE600/620 parallel port net adapter. +PLIP.txt + - info on connecting two linux boxes via the parallel port. alias.txt - info on using alias network devices arcnet-hardware.txt @@ -12,26 +16,68 @@ - info on the using the arcnet driver itself. ax25.txt - info on using AX.25 and NET/ROM code for Linux +baycom.txt + - info on using Baycom amateur radio modems with linux. +cops.txt + - info on the COPS linux LocalTalk driver. +cs89x0.txt + - info on the Crystal Semiconductor CS8900 ethernet driver/hardware. +de4x5.txt + - info on using the Digital DC21xxx (aka tulip) ethernet driver. +depca.txt + - jumper/switch settings for Digital DE10x and DE20x ethernet cards. +dgrs.txt + - info on using linux with the Digi `RightSwitch' ethernet switch. +eql.txt + - info on sharing/splitting IP traffic load across several devices. +ethertap.txt + - info on accessing ethernet from user space via a /dev/tap framerelay.txt - info on using Frame Relay/Data Link Connection Identifier (DLCI). +ewrk3.txt + - info on the Digital DE20x ethernet card driver. +filter.txt + - how to attatch a filter to a socket to give BPF-like functionality. +ip-sysctl.txt + - describes what all the /proc/sys/ipv4 tuneable parameters do. +ip_dynaddr.txt + - info on using dynamic IP addr for diald and IP masquerading. +ipddp.txt + - info on how to send/rec IP packets inside AppleTalk packets. lapb-module.txt - programming information on the LAPB module. +ltpc.txt + - info on the LocalTalk-PC card driver (Apple/Farallon). +multicast.txt + - list of how each ethernet card/driver handles multicast. ncsa-telnet - notes on how NCSA telnet (DOS) breaks with MTU discovery enabled. net-modules.txt - info and "insmod" parameters for all network driver modules. +policy-routing.txt + - info on the IP routing policy and how to use it. ppp.txt - info on what software you should use to run PPP. +pt.txt + - info on the PackeTwin amateur radio device driver. shaper.txt - info on the module that can shape/limit transmitted traffic. +smc9.txt + - info on the SMC 9xxx (9194) ethernet chip driver. +soundmodem.txt + - info on how to use some soundcards as an amateur radio modem. tcp.txt - short blurb on how TCP output takes place. tulip.txt - info on using DEC 21040/21041/21140 based PCI ethernet cards. vortex.txt - info on using 3Com Vortex (3c590, 3c592, 3c595, 3c597) e'net cards. +wanpipe.txt + - info on the Sangoma WANPIPE driver for their WAN card. wan-router.txt - - Wan router documentation + - WAN router documentation. +wavelan.txt + - info on using the wavelan (ethernet via radio xcvr) driver. x25.txt - general info on X.25 development. x25-iface.txt diff -ur linux-2193/Documentation/networking/filter.txt linux/Documentation/networking/filter.txt --- linux-2193/Documentation/networking/filter.txt Mon Dec 29 18:22:43 1997 +++ linux/Documentation/networking/filter.txt Wed Apr 8 13:50:56 1998 @@ -15,7 +15,7 @@ (BPF), so refering to the BSD bpf.4 manpage is very helpful in creating filters. -LSF is much simpler that BPF. One does not have to worry about +LSF is much simpler than BPF. One does not have to worry about devices or anything like that. You simply create your filter code, send it to the kernel via the SO_ATTACH_FILTER ioctl and if you filter code passes the kernel check on it, you then diff -ur linux-2193/Documentation/networking/multicast.txt linux/Documentation/networking/multicast.txt --- linux-2193/Documentation/networking/multicast.txt Sat Nov 29 18:33:18 1997 +++ linux/Documentation/networking/multicast.txt Wed Apr 8 14:09:30 1998 @@ -1,6 +1,5 @@ Behaviour of cards under Multicast. This is how they currently -behave not what the hardware can do. In particular all the 8390 based -cards don't use the onboard hash filter, and the lance driver doesn't +behave not what the hardware can do - i.e. the lance driver doesn't use its filter, even though the code for loading it is in the DEC lance based driver. diff -ur linux-2193/Documentation/smart-config.txt linux/Documentation/smart-config.txt --- linux-2193/Documentation/smart-config.txt Thu Jan 22 01:51:11 1998 +++ linux/Documentation/smart-config.txt Wed Apr 8 12:46:09 1998 @@ -72,14 +72,12 @@ modular, 'make' will notice that the foo.o was not compiled with -DMODULE and will recompile foo.c. - Flag dependencies also work with per-source-file flags such - as those in drivers/net/CONFIG. - All .a and .o files made from C source or with 'ld' or 'ar' have flag dependencies. .S files do not have flag dependencies. Per-source-file Flags + Flag dependencies also work with per-source-file flags. You can specify compilation flags for individual source files like this: diff -ur linux-2193/Documentation/sysrq.txt linux/Documentation/sysrq.txt --- linux-2193/Documentation/sysrq.txt Tue Apr 7 20:06:06 1998 +++ linux/Documentation/sysrq.txt Wed Apr 8 12:40:01 1998 @@ -15,7 +15,9 @@ 3. How do I use the magic SysRQ key? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You press the key combo 'ALT-SysRQ-<command key>'. +You press the key combo 'ALT-SysRQ-<command key>'. (You can let go of ALT +after hitting SysRq, but you must hold down SysRq until you have hit the +desired command key(s) you want.) 4. What are the 'command' keys? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -39,7 +41,7 @@ 'm' - Will dump current memory info to your console. -'0'-'8' - Sets the console log level, controlling which kernel messages +'0'-'9' - Sets the console log level, controlling which kernel messages will be printed to your console. ('0', for example would make it so that only emergency messages like PANICs or OOPSes would make it to your console.) @@ -51,6 +53,9 @@ 'l' - Send a SIGKILL to all processes, INCLUDING init. (Your system will be non-functional after this.) +Any other key will give you a menu of the valid commands, with the associated +key for each shown in upper case. + 5. Okay, so what can I use them for? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Well, un'R'aw is very handy when your X server or a svgalib program crashes. @@ -62,12 +67,17 @@ and 'U'mount first. 'S'ync is great when your system is locked up, it allows you to sync your -disks and will certainly lessen the chance of data loss and fscking. +disks and will certainly lessen the chance of data loss and fscking. Note +that the sync hasn't taken place until you see the "OK" and "Done" appear +on the screen. (If the kernel is really in strife, you may not ever get the +OK or Done message...) 'U'mount is basically useful in the same ways as 'S'ync. I generally 'S'ync, 'U'mount, then re'B'oot when my system locks. It's saved me many a fsck. +Again, the unmount (remount read-only) hasn't taken place until you see the +"OK" and "Done" message appear on the screen. -The loglevel'0'-'8' is useful when your console is being flooded with +The loglevel'0'-'9' is useful when your console is being flooded with kernel messages you do not want to see. Setting '0' will prevent all but the most urgent kernel messages from reaching your console. (They will still be logged if syslogd/klogd are alive, though.) @@ -80,7 +90,8 @@ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ That happens to me, also. I've found that tapping shift, alt, and control on both sides of the keyboard, and hitting an invalid sysrq sequence again -will fix the problem. (ie, something like alt-sysrq-z). +will fix the problem. (ie, something like alt-sysrq-z). Switching to another +virtual console (ALT+Fn) and then back again should also help. 7. I have more questions, who can I ask? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff -ur linux-2193/drivers/char/ChangeLog linux/drivers/char/ChangeLog --- linux-2193/drivers/char/ChangeLog Wed Mar 18 23:45:35 1998 +++ linux/drivers/char/ChangeLog Wed Apr 8 12:51:49 1998 @@ -4,13 +4,13 @@ version of tty_name, and rename the reentrant _tty_name function to be tty_name. (tty_open): Add a warning message stating callout devices - are deprecated. + are depreciated. Mon Dec 1 08:24:15 1997 Theodore Ts'o <tytso@rsts-11.mit.edu> * tty_io.c (tty_get_baud_rate): Print a warning syslog if the tty->alt_speed kludge is used; this means the system is - using the deprecated SPD_HI ioctls. + using the depreciated SPD_HI ioctls. Mon Nov 24 10:37:49 1997 Theodore Ts'o <tytso@rsts-11.mit.edu> diff -ur linux-2193/drivers/char/lp.c linux/drivers/char/lp.c --- linux-2193/drivers/char/lp.c Sun Apr 5 13:57:06 1998 +++ linux/drivers/char/lp.c Wed Apr 8 12:52:08 1998 @@ -671,7 +671,7 @@ /* disable driver on "lp=" or "lp=0" */ parport[0] = LP_PARPORT_OFF; } else { - printk(KERN_WARNING "warning: 'lp=0x%x' is deprecated, ignored\n", ints[1]); + printk(KERN_WARNING "warning: 'lp=0x%x' is depreciated, ignored\n", ints[1]); } } else if (!strncmp(str, "parport", 7)) { int n = simple_strtoul(str+7, NULL, 10); diff -ur linux-2193/drivers/char/tty_io.c linux/drivers/char/tty_io.c --- linux-2193/drivers/char/tty_io.c Tue Apr 7 20:06:15 1998 +++ linux/drivers/char/tty_io.c Wed Apr 8 12:52:31 1998 @@ -1288,7 +1288,7 @@ } if ((tty->driver.type == TTY_DRIVER_TYPE_SERIAL) && (tty->driver.subtype == SERIAL_TYPE_CALLOUT)) { - printk(KERN_INFO "Warning, %s opened, is a deprecated tty " + printk(KERN_INFO "Warning, %s opened, is a depreciated tty " "callout device\n", tty_name(tty, buf)); } return 0; @@ -1815,7 +1815,7 @@ } if (i==15 && tty->alt_speed) { if (!tty->warned) { - printk("Use of setserial/setrocket to set SPD_* flags is deprecated\n"); + printk("Use of setserial/setrocket to set SPD_* flags is depreciated\n"); tty->warned = 1; } return(tty->alt_speed); diff -ur linux-2193/fs/buffer.c linux/fs/buffer.c --- linux-2193/fs/buffer.c Sun Apr 5 13:57:59 1998 +++ linux/fs/buffer.c Wed Apr 8 12:57:02 1998 @@ -10,7 +10,6 @@ * data, of course), but instead letting the caller do it. */ -/* Some bdflush() changes for the dynamic ramdisk - Paul Gortmaker, 12/94 */ /* Start bdflush() with kernel_thread not syscall - Paul Gortmaker, 12/95 */ /* Removed a lot of unnecessary code and simplified things now that

- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.rutgers.edu