README

   1         Linux kernel release 2.5.xx
   2
   3 These are the release notes for Linux version 2.5.  Read them carefully,
   4 as they tell you what this is all about, explain how to install the
   5 kernel, and what to do if something goes wrong.
   6
   7 NOTE! As with all odd-numbered releases, 2.5.x is a development kernel.
   8 For stable kernels, see the 2.4.x maintained by Marcelo Tosatti.
   9
  10 WHAT IS LINUX?
  11
  12   Linux is a Unix clone written from scratch by Linus Torvalds with
  13   assistance from a loosely-knit team of hackers across the Net.
  14   It aims towards POSIX compliance.
  15
  16   It has all the features you would expect in a modern fully-fledged
  17   Unix, including true multitasking, virtual memory, shared libraries,
  18   demand loading, shared copy-on-write executables, proper memory
  19   management and TCP/IP networking.
  20
  21   It is distributed under the GNU General Public License - see the
  22   accompanying COPYING file for more details.
  23
  24 ON WHAT HARDWARE DOES IT RUN?
  25
  26   Linux was first developed for 386/486-based PCs.  These days it also
  27   runs on ARMs, DEC Alphas, SUN Sparcs, M68000 machines (like Atari and
  28   Amiga), MIPS and PowerPC, and others.
  29
  30 DOCUMENTATION:
  31
  32  - There is a lot of documentation available both in electronic form on
  33    the Internet and in books, both Linux-specific and pertaining to
  34    general UNIX questions.  I'd recommend looking into the documentation
  35    subdirectories on any Linux FTP site for the LDP (Linux Documentation
  36    Project) books.  This README is not meant to be documentation on the
  37    system: there are much better sources available.
  38
  39  - There are various README files in the Documentation/ subdirectory:
  40    these typically contain kernel-specific installation notes for some
  41    drivers for example. See ./Documentation/00-INDEX for a list of what
  42    is contained in each file.  Please read the Changes file, as it
  43    contains information about the problems, which may result by upgrading
  44    your kernel.
  45
  46  - The Documentation/DocBook/ subdirectory contains several guides for
  47    kernel developers and users.  These guides can be rendered in a
  48    number of formats:  PostScript (.ps), PDF, and HTML, among others.
  49    After installation, "make psdocs", "make pdfdocs", or "make htmldocs"
  50    will render the documentation in the requested format.
  51
  52 INSTALLING the kernel:
  53
  54  - If you install the full sources, put the kernel tarball in a
  55    directory where you have permissions (eg. your home directory) and
  56    unpack it:
  57
  58                 gzip -cd linux-2.5.XX.tar.gz | tar xvf -
  59
  60    Replace "XX" with the version number of the latest kernel.
  61
  62    Do NOT use the /usr/src/linux area! This area has a (usually
  63    incomplete) set of kernel headers that are used by the library header
  64    files.  They should match the library, and not get messed up by
  65    whatever the kernel-du-jour happens to be.
  66
  67  - You can also upgrade between 2.5.xx releases by patching.  Patches are
  68    distributed in the traditional gzip and the new bzip2 format.  To
  69    install by patching, get all the newer patch files, enter the
  70    directory in which you unpacked the kernel source and execute:
  71
  72                 gzip -cd patchXX.gz | patch -p0
  73
  74    or
  75                 bzip2 -dc patchXX.bz2 | patch -p0
  76
  77    (repeat xx for all versions bigger than the version of your current
  78    source tree, _in_order_) and you should be ok.  You may want to remove
  79    the backup files (xxx~ or xxx.orig), and make sure that there are no
  80    failed patches (xxx# or xxx.rej). If there are, either you or me has
  81    made a mistake.
  82
  83    Alternatively, the script patch-kernel can be used to automate this
  84    process.  It determines the current kernel version and applies any
  85    patches found.
  86
  87                 linux/scripts/patch-kernel linux
  88
  89    The first argument in the command above is the location of the
  90    kernel source.  Patches are applied from the current directory, but
  91    an alternative directory can be specified as the second argument.
  92
  93  - Make sure you have no stale .o files and dependencies lying around:
  94
  95                 cd linux
  96                 make mrproper
  97
  98    You should now have the sources correctly installed.
  99
 100 SOFTWARE REQUIREMENTS
 101
 102    Compiling and running the 2.5.xx kernels requires up-to-date
 103    versions of various software packages.  Consult
 104    ./Documentation/Changes for the minimum version numbers required
 105    and how to get updates for these packages.  Beware that using
 106    excessively old versions of these packages can cause indirect
 107    errors that are very difficult to track down, so don't assume that
 108    you can just update packages when obvious problems arise during
 109    build or operation.
 110
 111 CONFIGURING the kernel:
 112
 113  - Do a "make config" to configure the basic kernel.  "make config" needs
 114    bash to work: it will search for bash in $BASH, /bin/bash and /bin/sh
 115    (in that order), so one of those must be correct for it to work.
 116
 117    Do not skip this step even if you are only upgrading one minor
 118    version.  New configuration options are added in each release, and
 119    odd problems will turn up if the configuration files are not set up
 120    as expected.  If you want to carry your existing configuration to a
 121    new version with minimal work, use "make oldconfig", which will
 122    only ask you for the answers to new questions.
 123
 124  - Alternate configuration commands are:
 125         "make menuconfig"  Text based color menus, radiolists & dialogs.
 126         "make xconfig"     X windows based configuration tool.
 127         "make oldconfig"   Default all questions based on the contents of
 128                            your existing ./.config file.
 129
 130         NOTES on "make config":
 131         - having unnecessary drivers will make the kernel bigger, and can
 132           under some circumstances lead to problems: probing for a
 133           nonexistent controller card may confuse your other controllers
 134         - compiling the kernel with "Processor type" set higher than 386
 135           will result in a kernel that does NOT work on a 386.  The
 136           kernel will detect this on bootup, and give up.
 137         - A kernel with math-emulation compiled in will still use the
 138           coprocessor if one is present: the math emulation will just
 139           never get used in that case.  The kernel will be slightly larger,
 140           but will work on different machines regardless of whether they
 141           have a math coprocessor or not.
 142         - the "kernel hacking" configuration details usually result in a
 143           bigger or slower kernel (or both), and can even make the kernel
 144           less stable by configuring some routines to actively try to
 145           break bad code to find kernel problems (kmalloc()).  Thus you
 146           should probably answer 'n' to the questions for
 147           "development", "experimental", or "debugging" features.
 148
 149  - Check the top Makefile for further site-dependent configuration
 150    (default SVGA mode etc).
 151
 152  - Finally, do a "make dep" to set up all the dependencies correctly.
 153
 154 COMPILING the kernel:
 155
 156  - Make sure you have gcc-2.91.66 (egcs-1.1.2) available.  gcc 2.95.2 may
 157    also work but is not as safe, and *gcc 2.7.2.3 is no longer supported*.
 158    Also remember to upgrade your binutils package (for as/ld/nm and company)
 159    if necessary. For more information, refer to ./Documentation/Changes.
 160
 161    Please note that you can still run a.out user programs with this
 162    kernel.
 163
 164  - Do a "make bzImage" to create a compressed kernel image.  If you want
 165    to make a boot disk (without root filesystem or LILO), insert a floppy
 166    in your A: drive, and do a "make bzdisk".  It is also possible to do
 167    "make install" if you have lilo installed to suit the kernel makefiles,
 168    but you may want to check your particular lilo setup first.
 169
 170    To do the actual install you have to be root, but none of the normal
 171    build should require that. Don't take the name of root in vain.
 172
 173  - In the unlikely event that your system cannot boot bzImage kernels you
 174    can still compile your kernel as zImage. However, since zImage support
 175    will be removed at some point in the future in favor of bzImage we
 176    encourage people having problems with booting bzImage kernels to report
 177    these, with detailed hardware configuration information, to the
 178    linux-kernel mailing list and to H. Peter Anvin <hpa+linux@zytor.com>.
 179
 180  - If you configured any of the parts of the kernel as `modules', you
 181    will have to do "make modules" followed by "make modules_install".
 182    Read Documentation/modules.txt for more information.  For example,
 183    an explanation of how to use the modules is included there.
 184
 185  - Keep a backup kernel handy in case something goes wrong.  This is
 186    especially true for the development releases, since each new release
 187    contains new code which has not been debugged.  Make sure you keep a
 188    backup of the modules corresponding to that kernel, as well.  If you
 189    are installing a new kernel with the same version number as your
 190    working kernel, make a backup of your modules directory before you
 191    do a "make modules_install".
 192
 193  - In order to boot your new kernel, you'll need to copy the kernel
 194    image (found in .../linux/arch/i386/boot/bzImage after compilation)
 195    to the place where your regular bootable kernel is found.
 196
 197    For some, this is on a floppy disk, in which case you can copy the
 198    kernel bzImage file to /dev/fd0 to make a bootable floppy.
 199
 200    If you boot Linux from the hard drive, chances are you use LILO which
 201    uses the kernel image as specified in the file /etc/lilo.conf.  The
 202    kernel image file is usually /vmlinuz, /boot/vmlinuz, /bzImage or
 203    /boot/bzImage.  To use the new kernel, save a copy of the old image
 204    and copy the new image over the old one.  Then, you MUST RERUN LILO
 205    to update the loading map!! If you don't, you won't be able to boot
 206    the new kernel image.
 207
 208    Reinstalling LILO is usually a matter of running /sbin/lilo.
 209    You may wish to edit /etc/lilo.conf to specify an entry for your
 210    old kernel image (say, /vmlinux.old) in case the new one does not
 211    work.  See the LILO docs for more information.
 212
 213    After reinstalling LILO, you should be all set.  Shutdown the system,
 214    reboot, and enjoy!
 215
 216    If you ever need to change the default root device, video mode,
 217    ramdisk size, etc.  in the kernel image, use the 'rdev' program (or
 218    alternatively the LILO boot options when appropriate).  No need to
 219    recompile the kernel to change these parameters.
 220
 221  - Reboot with the new kernel and enjoy.
 222
 223 IF SOMETHING GOES WRONG:
 224
 225  - If you have problems that seem to be due to kernel bugs, please check
 226    the file MAINTAINERS to see if there is a particular person associated
 227    with the part of the kernel that you are having trouble with. If there
 228    isn't anyone listed there, then the second best thing is to mail
 229    them to me (torvalds@transmeta.com), and possibly to any other
 230    relevant mailing-list or to the newsgroup.  The mailing-lists are
 231    useful especially for SCSI and networking problems, as I can't test
 232    either of those personally anyway.
 233
 234  - In all bug-reports, *please* tell what kernel you are talking about,
 235    how to duplicate the problem, and what your setup is (use your common
 236    sense).  If the problem is new, tell me so, and if the problem is
 237    old, please try to tell me when you first noticed it.
 238
 239  - If the bug results in a message like
 240
 241         unable to handle kernel paging request at address C0000010
 242         Oops: 0002
 243         EIP:   0010:XXXXXXXX
 244         eax: xxxxxxxx   ebx: xxxxxxxx   ecx: xxxxxxxx   edx: xxxxxxxx
 245         esi: xxxxxxxx   edi: xxxxxxxx   ebp: xxxxxxxx
 246         ds: xxxx  es: xxxx  fs: xxxx  gs: xxxx
 247         Pid: xx, process nr: xx
 248         xx xx xx xx xx xx xx xx xx xx
 249
 250    or similar kernel debugging information on your screen or in your
 251    system log, please duplicate it *exactly*.  The dump may look
 252    incomprehensible to you, but it does contain information that may
 253    help debugging the problem.  The text above the dump is also
 254    important: it tells something about why the kernel dumped code (in
 255    the above example it's due to a bad kernel pointer). More information
 256    on making sense of the dump is in Documentation/oops-tracing.txt
 257
 258  - You can use the "ksymoops" program to make sense of the dump.  This
 259    utility can be downloaded from
 260    ftp://ftp.<country>.kernel.org/pub/linux/utils/kernel/ksymoops.
 261    Alternately you can do the dump lookup by hand:
 262
 263  - In debugging dumps like the above, it helps enormously if you can
 264    look up what the EIP value means.  The hex value as such doesn't help
 265    me or anybody else very much: it will depend on your particular
 266    kernel setup.  What you should do is take the hex value from the EIP
 267    line (ignore the "0010:"), and look it up in the kernel namelist to
 268    see which kernel function contains the offending address.
 269
 270    To find out the kernel function name, you'll need to find the system
 271    binary associated with the kernel that exhibited the symptom.  This is
 272    the file 'linux/vmlinux'.  To extract the namelist and match it against
 273    the EIP from the kernel crash, do:
 274
 275                 nm vmlinux | sort | less
 276
 277    This will give you a list of kernel addresses sorted in ascending
 278    order, from which it is simple to find the function that contains the
 279    offending address.  Note that the address given by the kernel
 280    debugging messages will not necessarily match exactly with the
 281    function addresses (in fact, that is very unlikely), so you can't
 282    just 'grep' the list: the list will, however, give you the starting
 283    point of each kernel function, so by looking for the function that
 284    has a starting address lower than the one you are searching for but
 285    is followed by a function with a higher address you will find the one
 286    you want.  In fact, it may be a good idea to include a bit of
 287    "context" in your problem report, giving a few lines around the
 288    interesting one.
 289
 290    If you for some reason cannot do the above (you have a pre-compiled
 291    kernel image or similar), telling me as much about your setup as
 292    possible will help.
 293
 294  - Alternately, you can use gdb on a running kernel. (read-only; i.e. you
 295    cannot change values or set break points.) To do this, first compile the
 296    kernel with -g; edit arch/i386/Makefile appropriately, then do a "make
 297    clean". You'll also need to enable CONFIG_PROC_FS (via "make config").
 298
 299    After you've rebooted with the new kernel, do "gdb vmlinux /proc/kcore".
 300    You can now use all the usual gdb commands. The command to look up the
 301    point where your system crashed is "l *0xXXXXXXXX". (Replace the XXXes
 302    with the EIP value.)
 303
 304    gdb'ing a non-running kernel currently fails because gdb (wrongly)
 305    disregards the starting offset for which the kernel is compiled.
 306