README change
PATCH 1/1 README change
A suggestion was made the other day that the README file needed to be changed to delete the reference to make dep in line with the changes to the make procedure. Here is a patch to make that change in addition to some other changes I thought would help. While poking around in the documentation I see some other files which could use some updating; 00-INDEX is next on the hitlist if no one objects.
README renamed from README.orig +54 -29
@@ -40,8 +40,9 @@ these typically contain kernel-specific installation notes for some drivers for example. See ./Documentation/00-INDEX for a list of what is contained in each file. Please read the Changes file, as it - contains information about the problems, which may result by upgrading - your kernel. + contains information about the version of software and utilities + required to run 2.5 kernels as well as any "Gotchas" that could be + encountered. - The Documentation/DocBook/ subdirectory contains several guides for kernel developers and users. These guides can be rendered in a
@@ -55,14 +56,18 @@ directory where you have permissions (eg. your home directory) and unpack it: - gzip -cd linux-2.5.XX.tar.gz | tar xvf - + tar xvzf linux-2.5.XX.tar.gz + +or + + tar xvjf linux-2.5.XX.tar.bz2 Replace "XX" with the version number of the latest kernel. - Do NOT use the /usr/src/linux area! This area has a (usually - incomplete) set of kernel headers that are used by the library header - files. They should match the library, and not get messed up by - whatever the kernel-du-jour happens to be. + Do NOT use /usr/src/linux! This directory should contain the source + and headers of the kernel gcc was compile with. They should match + the compiler, and not get messed up by whatever the kernel-du-jour + happens to be. - You can also upgrade between 2.5.xx releases by patching. Patches are distributed in the traditional gzip and the new bzip2 format. To
@@ -84,11 +89,15 @@ process. It determines the current kernel version and applies any patches found. - linux/scripts/patch-kernel linux + usage: patch-kernel [ sourcedir [ patchdir [ stopversion ] [ -acxx ] ] ] + + The source directory defaults to /usr/src/linux, and the patch + directory defaults to the current directory. + - The first argument in the command above is the location of the - kernel source. Patches are applied from the current directory, but - an alternative directory can be specified as the second argument. + The first argument is the location of the kernel source. Patches + are applied from the current directory, but an alternative directory + can be specified as the second argument. - Make sure you have no stale .o files and dependencies lying around:
@@ -131,9 +140,9 @@ - having unnecessary drivers will make the kernel bigger, and can under some circumstances lead to problems: probing for a nonexistent controller card may confuse your other controllers - - compiling the kernel with "Processor type" set higher than 386 - will result in a kernel that does NOT work on a 386. The - kernel will detect this on bootup, and give up. + - compiling the kernel with an incorrect "Processor type" will + result in a kernel that does NOT work. The kernel will detect + this on bootup, and give up. - A kernel with math-emulation compiled in will still use the coprocessor if one is present: the math emulation will just never get used in that case. The kernel will be slightly larger,
@@ -146,13 +155,20 @@ should probably answer 'n' to the questions for "development", "experimental", or "debugging" features. - - Check the top Makefile for further site-dependent configuration - (default SVGA mode etc). + - Check the top Makefile for further site-dependent configuration + information such as host compiler or cross-platform information. - - Finally, do a "make dep" to set up all the dependencies correctly. + - A "make dep" command was previously required at this point, but is + no longer necessary. COMPILING the kernel: + The steps for compiling the kernel are: + make bzImage + make modules + make modules_install + make install + - Make sure you have gcc 2.95.3 available. gcc 2.91.66 (egcs-1.1.2), and gcc 2.7.2.3 are known to miscompile some parts of the kernel, and are *no longer supported*.
@@ -163,12 +179,11 @@ - Do a "make bzImage" to create a compressed kernel image. If you want to make a boot disk (without root filesystem or LILO), insert a floppy - in your A: drive, and do a "make bzdisk". It is also possible to do - "make install" if you have lilo installed to suit the kernel makefiles, - but you may want to check your particular lilo setup first. + in your A: drive, and do a "make bzdisk". - To do the actual install you have to be root, but none of the normal - build should require that. Don't take the name of root in vain. + To do the make modules_install and make install you have to be root, + but none of the other build should require that. + Don't take the name of root in vain. - In the unlikely event that your system cannot boot bzImage kernels you can still compile your kernel as zImage. However, since zImage support
@@ -190,9 +205,11 @@ working kernel, make a backup of your modules directory before you do a "make modules_install". - - In order to boot your new kernel, you'll need to copy the kernel + - In order to boot your new kernel you'll need to copy the kernel image (found in .../linux/arch/i386/boot/bzImage after compilation) - to the place where your regular bootable kernel is found. + to the place where your regular bootable kernel is found. The + "make install" step will do this for you as well as changing + the lilo or grub configuration files. For some, this is on a floppy disk, in which case you can copy the kernel bzImage file to /dev/fd0 to make a bootable floppy.
@@ -213,6 +230,10 @@ After reinstalling LILO, you should be all set. Shutdown the system, reboot, and enjoy! + The other popular boot manager is grub. If you use this boot + manager, no additional actions are required beyond changing the + /boot/grub/grub.conf configuration file. + If you ever need to change the default root device, video mode, ramdisk size, etc. in the kernel image, use the 'rdev' program (or alternatively the LILO boot options when appropriate). No need to
@@ -222,19 +243,23 @@ IF SOMETHING GOES WRONG: + - Please read the file REPORTING-BUGS before forwarding any reports + of suspected kernel problems to maintainers or mailing lists. It + contains a suggested format for bug reports as well as what + information is most helpful to developers. + - If you have problems that seem to be due to kernel bugs, please check the file MAINTAINERS to see if there is a particular person associated with the part of the kernel that you are having trouble with. If there isn't anyone listed there, then the second best thing is to mail - them to me ([email protected]), and possibly to any other + them to the linux-kernel mailing list and possibly to any other relevant mailing-list or to the newsgroup. The mailing-lists are - useful especially for SCSI and networking problems, as I can't test - either of those personally anyway. + useful especially for SCSI and networking problems - In all bug-reports, *please* tell what kernel you are talking about, how to duplicate the problem, and what your setup is (use your common - sense). If the problem is new, tell me so, and if the problem is - old, please try to tell me when you first noticed it. + sense). If the problem is new, say so, and if the problem is + old, please try to explain when you first noticed it. - If the bug results in a message like
[Hypocrisy alert: I'm feeling somewhat lazy right now so there could be more grammar problems with this e-mail than with the file it's trying to improve. OTOH this e-mail isn't distributed with every Linux kernel source code tarball.]
README line 68
Quoted 6 lines · Thomas Molina
README renamed from README.orig +2
-4- Do NOT use the /usr/src/linux area! This area has a (usually - incomplete) set of kernel headers that are used by the library header - files. They should match the library, and not get messed up by - whatever the kernel-du-jour happens to be. + Do NOT use /usr/src/linux! This directory should contain the source + and headers of the kernel gcc was compile with. They should match
s/gcc/glibc/ (maybe better to just s+the /usr/src/linux area+/usr/src/linux+ and leave the rest of the paragraph unchanged)
Quoted 1 line
+ the compiler, and not get messed up by whatever the kernel-du-jour
Again, s/compiler/library/ (i.e., undo your change, it was right the first time)
README line 145
Quoted 8 lines
README renamed from README.orig +4
-3+ happens to be. - - compiling the kernel with "Processor type" set higher than 386 - will result in a kernel that does NOT work on a 386. The - kernel will detect this on bootup, and give up. + - compiling the kernel with an incorrect "Processor type" will + result in a kernel that does NOT work. The kernel will detect + this on bootup, and give up.
Can the kernel still freeze during printk if it was compiled for the wrong CPU type, or has that been fixed? (I haven't followed that closely enough.)
Quoted 2 lines
- Make sure you have gcc 2.95.3 available.
gcc 2.91.66 (egcs-1.1.2), and gcc 2.7.2.3 are known to miscompile
Not a criticism of your patch, but something I just noticed now -- feel free to ignore this: that comma after "(egcs-1.1.2)" seems awkward to me.
Quoted 2 lines
- - In order to boot your new kernel, you'll need to copy the kernel
+ - In order to boot your new kernel you'll need to copy the kernel
Conversely, this is better with the comma (IMO).
README line 249
Quoted 6 lines
IF SOMETHING GOES WRONG:
+ - Please read the file REPORTING-BUGS before forwarding any reports
README renamed from README.orig +3
-0+ of suspected kernel problems to maintainers or mailing lists. It + contains a suggested format for bug reports as well as what + information is most helpful to developers.
Something seems wrong to me about this sentence. The easiest potential fix I can think of is s/contains/describes/, but that might not be a 100% fix. My problem with this sentence is that it seems to be saying the file:
+ "contains a suggested format for bug reports"
+ "contains...what information is most helpful to developers"
I know what you mean by the latter, but if I interpret it in a slightly more literal sense, it seems both semantically and syntactically flawed.
README line 255
Quoted 6 lines
- If you have problems that seem to be due to kernel bugs, please check the file
MAINTAINERSto see if there is a particular person associated with the part of the kernel that you are having trouble with. If there isn't anyone listed there, then the second best thing is to mailREADME renamed from README.orig +1
-1- them to me ([email protected]), and possibly to any other + them to the linux-kernel mailing list and possibly to any other
Should this mention the mailing list's e-mail address?
README line 257
Quoted 4 lines
relevant mailing-list or to the newsgroup. The mailing-lists are
README renamed from README.orig +1
-2- useful especially for SCSI and networking problems, as I can't test - either of those personally anyway. + useful especially for SCSI and networking problems
You (accidentally?) removed the period.
README line 262
Quoted 4 lines
README renamed from README.orig +2
-2- sense). If the problem is new, tell me so, and if the problem is - old, please try to tell me when you first noticed it. + sense). If the problem is new, say so, and if the problem is + old, please try to explain when you first noticed it.
Perhaps s/explain/tell us/ ?
Enclosed is a second version, incorporating your suggestions.
Quoted 3 lines · Barry K. Nathan
Again, s/compiler/library/ (i.e., undo your change, it was right the first time)
Quoted 1 line
+ happens to be.
Reverted. I did change the word area to directory, which is all I originally intended anyway.
Quoted 3 lines
Can the kernel still freeze during printk if it was compiled for the wrong CPU type, or has that been fixed? (I haven't followed that closely enough.)
The actual point I wanted to make is in the new version.
Quoted 2 lines
Not a criticism of your patch, but something I just noticed now -- feel free to ignore this: that comma after "(egcs-1.1.2)" seems awkward to me.
I removed the comma.
Quoted 4 lines
Quoted 2 lines
- - In order to boot your new kernel, you'll need to copy the kernel
+ - In order to boot your new kernel you'll need to copy the kernelConversely, this is better with the comma (IMO).
I ended up with dueling style guides on this point. I reverted to the original, which had the comma included.
Quoted 6 lines
Something seems wrong to me about this sentence. The easiest potential fix I can think of is s/contains/describes/, but that might not be a 100% fix. My problem with this sentence is that it seems to be saying the file:
+ "contains a suggested format for bug reports"
+ "contains...what information is most helpful to developers"
I took your suggestion. I believe the new version is shorter and clearer.
Quoted 4 lines
Review
Quoted 2 lines
(quoted diff) +1
-1- them to me ([email protected]), and possibly to any other + them to the linux-kernel mailing list and possibly to any otherShould this mention the mailing list's e-mail address?
Yes. I wanted to change people from sending to Linus and have them send to a more appropriate place.
Quoted 3 lines
Quoted 1 line
+ useful especially for SCSI and networking problems
You (accidentally?) removed the period.
Yes. I put it back.
Quoted 6 lines
Review
Quoted 4 lines
(quoted diff) +2
-2- sense). If the problem is new, tell me so, and if the problem is - old, please try to tell me when you first noticed it. + sense). If the problem is new, say so, and if the problem is + old, please try to explain when you first noticed it.Perhaps s/explain/tell us/ ?
OK.
README renamed from README.orig +53 -27
@@ -40,8 +40,9 @@ these typically contain kernel-specific installation notes for some drivers for example. See ./Documentation/00-INDEX for a list of what is contained in each file. Please read the Changes file, as it - contains information about the problems, which may result by upgrading - your kernel. + contains information about the version of software and utilities + required to run 2.5 kernels as well as any "Gotchas" that could be + encountered. - The Documentation/DocBook/ subdirectory contains several guides for kernel developers and users. These guides can be rendered in a
@@ -55,11 +56,15 @@ directory where you have permissions (eg. your home directory) and unpack it: - gzip -cd linux-2.5.XX.tar.gz | tar xvf - + tar xvzf linux-2.5.XX.tar.gz + +or + + tar xvjf linux-2.5.XX.tar.bz2 Replace "XX" with the version number of the latest kernel. - Do NOT use the /usr/src/linux area! This area has a (usually + Do NOT use the /usr/src/linux directory! It has a (usually incomplete) set of kernel headers that are used by the library header files. They should match the library, and not get messed up by whatever the kernel-du-jour happens to be.
@@ -84,11 +89,15 @@ process. It determines the current kernel version and applies any patches found. - linux/scripts/patch-kernel linux + use: patch-kernel [ sourcedir [ patchdir [ stopversion ] [ -acxx ] ] ] + + The source directory defaults to /usr/src/linux, and the patch + directory defaults to the current directory. + - The first argument in the command above is the location of the - kernel source. Patches are applied from the current directory, but - an alternative directory can be specified as the second argument. + The first argument is the location of the kernel source. Patches + are applied from the current directory, but an alternative directory + can be specified as the second argument. - Make sure you have no stale .o files and dependencies lying around:
@@ -131,9 +140,10 @@ - having unnecessary drivers will make the kernel bigger, and can under some circumstances lead to problems: probing for a nonexistent controller card may confuse your other controllers - - compiling the kernel with "Processor type" set higher than 386 - will result in a kernel that does NOT work on a 386. The - kernel will detect this on bootup, and give up. + - compiling the kernel with an incorrect "Processor type" will + result in a kernel that does NOT work. A kernel compiled for + i386 will work on later x86 processors, but the reverse is not + true. - A kernel with math-emulation compiled in will still use the coprocessor if one is present: the math emulation will just never get used in that case. The kernel will be slightly larger,
@@ -146,15 +156,22 @@ should probably answer 'n' to the questions for "development", "experimental", or "debugging" features. - - Check the top Makefile for further site-dependent configuration - (default SVGA mode etc). + - Check the top Makefile for further site-dependent configuration + information such as host compiler or cross-platform information. - - Finally, do a "make dep" to set up all the dependencies correctly. + - A "make dep" command was previously required at this point, but is + no longer necessary. COMPILING the kernel: + The steps for compiling the kernel are: + make bzImage + make modules + make modules_install + make install + - Make sure you have gcc 2.95.3 available. - gcc 2.91.66 (egcs-1.1.2), and gcc 2.7.2.3 are known to miscompile + gcc 2.91.66 (egcs-1.1.2) and gcc 2.7.2.3 are known to miscompile some parts of the kernel, and are *no longer supported*. Also remember to upgrade your binutils package (for as/ld/nm and company) if necessary. For more information, refer to ./Documentation/Changes.
@@ -163,12 +180,11 @@ - Do a "make bzImage" to create a compressed kernel image. If you want to make a boot disk (without root filesystem or LILO), insert a floppy - in your A: drive, and do a "make bzdisk". It is also possible to do - "make install" if you have lilo installed to suit the kernel makefiles, - but you may want to check your particular lilo setup first. + in your A: drive, and do a "make bzdisk". - To do the actual install you have to be root, but none of the normal - build should require that. Don't take the name of root in vain. + To do the make modules_install and make install you have to be root, + but none of the other build should require that. + Don't take the name of root in vain. - In the unlikely event that your system cannot boot bzImage kernels you can still compile your kernel as zImage. However, since zImage support
@@ -192,7 +208,9 @@ - In order to boot your new kernel, you'll need to copy the kernel image (found in .../linux/arch/i386/boot/bzImage after compilation) - to the place where your regular bootable kernel is found. + to the place where your regular bootable kernel is found. The + "make install" step will do this for you as well as changing + the lilo or grub configuration files. For some, this is on a floppy disk, in which case you can copy the kernel bzImage file to /dev/fd0 to make a bootable floppy.
@@ -213,6 +231,10 @@ After reinstalling LILO, you should be all set. Shutdown the system, reboot, and enjoy! + The other popular boot manager is grub. If you use this boot + manager, no additional actions are required beyond changing the + /boot/grub/grub.conf configuration file. + If you ever need to change the default root device, video mode, ramdisk size, etc. in the kernel image, use the 'rdev' program (or alternatively the LILO boot options when appropriate). No need to
@@ -222,19 +244,23 @@ IF SOMETHING GOES WRONG: + - Please read the file REPORTING-BUGS before forwarding any reports + of suspected kernel problems to maintainers or mailing lists. It + describes a suggested format and content for bug reports. + - If you have problems that seem to be due to kernel bugs, please check the file MAINTAINERS to see if there is a particular person associated with the part of the kernel that you are having trouble with. If there isn't anyone listed there, then the second best thing is to mail - them to me ([email protected]), and possibly to any other - relevant mailing-list or to the newsgroup. The mailing-lists are - useful especially for SCSI and networking problems, as I can't test - either of those personally anyway. + them to the linux-kernel mailing list ([email protected]) + and possibly to any other relevant mailing-list or to the newsgroup. + The mailing-lists are useful, especially for SCSI and networking + problems. - In all bug-reports, *please* tell what kernel you are talking about, how to duplicate the problem, and what your setup is (use your common - sense). If the problem is new, tell me so, and if the problem is - old, please try to tell me when you first noticed it. + sense). If the problem is new, say so, and if the problem is + old, please try to tell us when you first noticed it. - If the bug results in a message like
Quoted 10 lines · Thomas Molina
Enclosed is a second version, incorporating your suggestions.
Quoted 4 lines · Barry K. Nathan
Again, s/compiler/library/ (i.e., undo your change, it was right the first time)
Quoted 1 line
+ happens to be.
Reverted. I did change the word area to directory, which is all I originally intended anyway.
IMHO /user/src/linux have nothing to do with glibc headers. Any half-sanely configured glibc will have all relevant kernel headers installed under /usr/include/{asm|linux} (most probably copied from a kernel tree).
The sad fact is that these are symlinks on many systems in Real World.
In short, on sanely configured system you should be able to rm -rf /usr/src, then untar some $source and configure/build it successfully.
--
vda
On Wed, Nov 27, 2002 at 06:26:05PM -0600, Thomas Molina wrote:
- Do NOT use the /usr/src/linux area! This area has a (usually - incomplete) set of kernel headers that are used by the library header - files. They should match the library, and not get messed up by - whatever the kernel-du-jour happens to be. + Do NOT use /usr/src/linux! This directory should contain the source + and headers of the kernel gcc was compile with. They should match + the compiler, and not get messed up by whatever the kernel-du-jour + happens to be.
The original text was not bad.
The new text is completely wrong.
Quoted 11 lines · Andries Brouwer
On Wed, Nov 27, 2002 at 06:26:05PM -0600, Thomas Molina wrote:
README renamed from README.orig +4
-4- Do NOT use the /usr/src/linux area! This area has a (usually - incomplete) set of kernel headers that are used by the library header - files. They should match the library, and not get messed up by - whatever the kernel-du-jour happens to be. + Do NOT use /usr/src/linux! This directory should contain the source + and headers of the kernel gcc was compile with. They should match + the compiler, and not get messed up by whatever the kernel-du-jour + happens to be.
Quoted 2 lines
The original text was not bad.
The new text is completely wrong.
Yeah, I tried a simple word replacement and went too far. Please see my updated patch. I apologize to everyone for messing up good words.
On Thu, Nov 28, 2002 at 09:03:14AM -0600, Thomas Molina wrote:
While you are add it, how about introducing "make help" in the README. At least for a few architectures it list possible targets. And bzImage is not the only one.
Sam