[deployment-guide/comm-rel: 156/727] Kernel: mv indexterms; various fixes
Jaromir Hradilek
jhradile at fedoraproject.org
Tue Oct 19 12:37:24 UTC 2010
commit 9275f519df8ca261b07ca63f8e759e1923e186ff
Author: Douglas Silas <dhensley at redhat.com>
Date: Mon Jul 26 22:14:52 2010 +0200
Kernel: mv indexterms; various fixes
en-US/Manually_Upgrading_the_Kernel.xml | 186 +++++++++++++++----------------
1 files changed, 92 insertions(+), 94 deletions(-)
---
diff --git a/en-US/Manually_Upgrading_the_Kernel.xml b/en-US/Manually_Upgrading_the_Kernel.xml
index e5e476b..2966738 100644
--- a/en-US/Manually_Upgrading_the_Kernel.xml
+++ b/en-US/Manually_Upgrading_the_Kernel.xml
@@ -53,112 +53,109 @@
<primary>kernel</primary>
<secondary>kernel packages</secondary>
</indexterm>
+ <indexterm>
+ <primary>kernel package</primary>
+ <secondary>kernel</secondary>
+ <tertiary>for single,multicore and multiprocessor systems</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>packages</primary>
+ <secondary>kernel</secondary>
+ <tertiary>for single,multicore and multiprocessor systems</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>kernel package</primary>
+ <secondary>kernel-devel</secondary>
+ <tertiary>kernel headers and makefiles</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>packages</primary>
+ <secondary>kernel-devel</secondary>
+ <tertiary>kernel headers and makefiles</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>kernel package</primary>
+ <secondary>kernel-doc</secondary>
+ <tertiary>
+ documentation files</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>packages</primary>
+ <secondary>kernel-doc</secondary>
+ <tertiary>
+ documentation files</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>kernel package</primary>
+ <secondary>kernel-headers</secondary>
+ <tertiary>
+ C header files files</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>packages</primary>
+ <secondary>kernel-headers</secondary>
+ <tertiary>
+ C header files files</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>kernel package</primary>
+ <secondary>kernel-firmware</secondary>
+ <tertiary>
+ firmware files</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>packages</primary>
+ <secondary>kernel-firmware</secondary>
+ <tertiary>
+ firmware files</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>kernel package</primary>
+ <secondary>perf</secondary>
+ <tertiary>firmware files</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>packages</primary>
+ <secondary>perf</secondary>
+ <tertiary>
+ firmware files</tertiary>
+ </indexterm>
<para>&MAJOROS; contains the following kernel packages:</para>
<itemizedlist>
<listitem>
- <indexterm>
- <primary>kernel package</primary>
- <secondary>kernel</secondary>
- <tertiary>for single,multicore and multiprocessor systems</tertiary>
- </indexterm>
- <indexterm>
- <primary>packages</primary>
- <secondary>kernel</secondary>
- <tertiary>for single,multicore and multiprocessor systems</tertiary>
- </indexterm>
<para>
<package>kernel</package> — Contains the kernel for single, multicore and multiprocessor systems.</para>
</listitem>
<listitem>
<para>
- <package>kernel-debug</package> — This kernel has numerous debugging options enabled for kernel diagnosis, at the expense of reduced performance.
- </para>
+ <package>kernel-debug</package> — Contains a kernel with numerous debugging options enabled for kernel diagnosis, at the expense of reduced performance.</para>
</listitem>
<listitem>
- <indexterm>
- <primary>kernel package</primary>
- <secondary>kernel-devel</secondary>
- <tertiary>kernel headers and makefiles</tertiary>
- </indexterm>
- <indexterm>
- <primary>packages</primary>
- <secondary>kernel-devel</secondary>
- <tertiary>kernel headers and makefiles</tertiary>
- </indexterm>
<para>
<package>kernel-devel</package> — Contains the kernel headers and makefiles sufficient to build modules against the <package>kernel</package> package.</para>
</listitem>
<listitem>
- <indexterm>
- <primary>kernel package</primary>
- <secondary>kernel-doc</secondary>
- <tertiary>
- documentation files</tertiary>
- </indexterm>
- <indexterm>
- <primary>packages</primary>
- <secondary>kernel-doc</secondary>
- <tertiary>
- documentation files</tertiary>
- </indexterm>
+ <para>
+ <package>kernel-debug-devel</package> — Contains the development version of the kernel with numerous debugging options enabled for kernel diagnosis, at the expense of reduced performance.</para>
+ </listitem>
+ <listitem>
<para>
<package>kernel-doc</package> — Documentation files from the kernel source. Various portions of the Linux kernel and the device drivers shipped with it are documented in these files. Installation of this package provides a reference to the options that can be passed to Linux kernel modules at load time.</para>
<para>By default, these files are placed in the <filename>/usr/share/doc/kernel-doc-<replaceable><kernel_version></replaceable>/</filename> directory.</para>
</listitem>
<listitem>
- <indexterm>
- <primary>kernel package</primary>
- <secondary>kernel-headers</secondary>
- <tertiary>
- C header files files</tertiary>
- </indexterm>
- <indexterm>
- <primary>packages</primary>
- <secondary>kernel-headers</secondary>
- <tertiary>
- C header files files</tertiary>
- </indexterm>
<para>
<package>kernel-headers</package> — Includes the C header files that specify the interface between the Linux kernel and user-space libraries and programs. The header files define structures and constants that are needed for building most standard programs.</para>
</listitem>
<listitem>
- <indexterm>
- <primary>kernel package</primary>
- <secondary>kernel-firmware</secondary>
- <tertiary>
- firmware files</tertiary>
- </indexterm>
- <indexterm>
- <primary>packages</primary>
- <secondary>kernel-firmware</secondary>
- <tertiary>
- firmware files</tertiary>
- </indexterm>
<para>
<package>kernel-firmware</package> — Contains all of the firmware files that are required by various devices to operate.</para>
</listitem>
<listitem>
- <indexterm>
- <primary>kernel package</primary>
- <secondary>perf</secondary>
- <tertiary>firmware files</tertiary>
- </indexterm>
- <indexterm>
- <primary>packages</primary>
- <secondary>perf</secondary>
- <tertiary>
- firmware files</tertiary>
- </indexterm>
<para>
- <package>perf</package> — Technically a documentation instead of kernel package, <package>perf</package> contains supporting documentation for the perf tool shipped in each kernel image subpackage.</para>
+ <package>perf</package> — This package contains supporting scripts and documentation for the <application>perf</application> tool shipped in each kernel image subpackage.</para>
</listitem>
</itemizedlist>
- <!-- TBD6: ensure the release notes contain kernel-source pkg build instructions -->
- <note>
- <title>Note: kernel-source package availability</title>
- <para>The <package>kernel-source</package> package has been removed and replaced with a source RPM package that can only be retrieved from Red Hat Network. This SRPM package must then be built locally using the <command>rpmbuild</command> command. For more information on obtaining and installing the kernel source package, refer to the latest updated &MAJOROSVER; Release Notes (and their updates) at <ulink
- url="http://www.redhat.com/docs/manuals/enterprise/"/>.</para>
- </note>
</section>
<section
id="s1-kernel-preparing">
@@ -182,7 +179,7 @@
<tertiary>working boot media</tertiary>
</indexterm>
<para>Before upgrading the kernel, it is recommended that you take some precautionary steps.</para>
- <para>In the first step, make sure working boot media exists for the system in case a problem occurs. If the boot loader is not configured properly to boot the new kernel, the system cannot be booted into &MAJOROS; without working boot media.</para>
+ <para>First, ensure that working boot media exists for the system in case a problem occurs. If the boot loader is not configured properly to boot the new kernel, the system cannot be booted into &MAJOROS; without working boot media.</para>
<!--silas: the following instructions for making (USB) boot media are adapted from the RHEL6 beta Installation Guide, "Alternative Method to Make Minimal USB Boot Media" section-->
<para>USB media often comes in the form of flash devices sometimes called <firstterm>pen drives</firstterm>, <firstterm>thumb disks</firstterm>, or <firstterm>keys</firstterm>, or as an externally-connected hard disk device. Almost all media of this type is formatted as a <systemitem
class="filesystem">VFAT</systemitem> file system. You can create bootable USB media on media formatted as <systemitem
@@ -235,16 +232,17 @@
<para>You should reboot the machine with the boot media and verify that you are able to boot with it before continuing.</para>
</step>
</procedure>
- <para>Alternatively, on systems with a floppy drive, you can create a boot diskette by installing the <package>mkbootdisk</package> package and running the <command>mkbootdisk</command> command as root. Refer to the <command>mkbootdisk</command> man page for usage information.</para>
+ <para>Alternatively, on systems with a floppy drive, you can create a boot diskette by installing the <package>mkbootdisk</package> package and running the <command>mkbootdisk</command> command as root. Refer to <command>man mkbootdisk</command> man page after installing the package for usage information.</para>
<para>To determine which kernel packages are installed, execute the command <command>yum list installed "kernel-*"</command> at a shell prompt. The output will comprise some or all of the following packages, depending on the system's architecture, and the version numbers may differ:</para>
- <screen>~]$ <command>yum list installed "kernel-*"</command>
+ <screen>~]# <command>yum list installed "kernel-*"</command>
kernel.x86_64 2.6.32-17.el6 installed
-kernel-doc.noarch 2.6.32-17.el6 installed
+kernel-doc.noarch 2.6.32-17.el6 installed
kernel-firmware.noarch 2.6.32-17.el6 installed
kernel-headers.x86_64 2.6.32-17.el6 installed
</screen>
<para>From the output, determine which packages need to be download for the kernel upgrade. For a single processor system, the only required package is the <package>kernel</package> package. Refer to <xref
linkend="s1-kernel-packages"/> for descriptions of the different packages.</para>
+ <!-- RHEL6: the following info is probably unnecessary
<para>In the file name, each kernel package contains the architecture for which the package was built. The format is kernel-<replaceable><variant></replaceable>-<replaceable><version></replaceable>.<replaceable><arch></replaceable>.rpm, where <replaceable><variant></replaceable> is one of either <package>PAE</package>, <package>xen</package>, and so forth. The <replaceable><arch></replaceable> is one of the following:</para>
<itemizedlist>
<listitem>
@@ -284,7 +282,7 @@ kernel-headers.x86_64 2.6.32-17.el6 installed
class="registered">AMD Athlon</trademark>, and <trademark
class="registered">AMD Duron</trademark> systems</para>
</listitem>
- </itemizedlist>
+ </itemizedlist>-->
</section>
<section
id="s1-kernel-download">
@@ -301,6 +299,11 @@ kernel-headers.x86_64 2.6.32-17.el6 installed
<indexterm>
<primary>kernel</primary>
<secondary>upgrade kernel available</secondary>
+ <tertiary>via Red Hat network</tertiary>
+ </indexterm>
+ <indexterm>
+ <primary>kernel</primary>
+ <secondary>upgrade kernel available</secondary>
<tertiary>Security Errata</tertiary>
</indexterm>
<para>There are several ways to determine if an updated kernel is available for the system.</para>
@@ -310,11 +313,6 @@ kernel-headers.x86_64 2.6.32-17.el6 installed
url="http://www.redhat.com/security/updates/"/> for information on security errata, including kernel upgrades that fix security issues.</para>
</listitem>
<listitem>
- <indexterm>
- <primary>kernel</primary>
- <secondary>upgrade kernel available</secondary>
- <tertiary>via Red Hat network</tertiary>
- </indexterm>
<para>Via Red Hat Network — Download and install the kernel RPM packages. Red Hat Network can download the latest kernel, upgrade the kernel on the system, create an initial RAM disk image if needed, and configure the boot loader to boot the new kernel. For more information, refer to <ulink
url="http://www.redhat.com/docs/manuals/RHNetwork/"> http://www.redhat.com/docs/manuals/RHNetwork/</ulink>.</para>
</listitem>
@@ -397,7 +395,7 @@ initrd-2.6.32-22.el6.x86_64kdump.img</screen>
</listitem>
<listitem>
<para>an <systemitem
- class="filesystem">initramfs</systemitem> file matching our kernel version, <filename>initrd-2.6.32-22.el6.x86_64kdump.img</filename>, also exists.</para>
+ class="filesystem">initramfs</systemitem> file matching our kernel version, <filename>initramfs-2.6.32-22.el6.x86_64kdump.img</filename>, also exists.</para>
</listitem>
</itemizedlist>
<important
@@ -415,12 +413,13 @@ initrd-2.6.32-22.el6.x86_64kdump.img</screen>
<para>You must use the <option>--force</option> option if you want <command>dracut</command> to overwrite an existing <filename>initramfs</filename> (for example, if your <filename>initramfs</filename> has become corrupt). Otherwise <command>dracut</command> will refuse to overwrite the existing <filename>initramfs</filename> file:</para>
<screen>~]# <command>dracut</command>
Will not override existing initramfs (/boot/initramfs-2.6.32-22.el6.x86_64.img) without --force</screen>
- <para>You can create an initramfs in the current directory by calling <command>dracut <replaceable><initramfs_name></replaceable> <replaceable><kernel_version></replaceable>
- </command>:</para>
+ <para>You can create an initramfs in the current directory by calling <command>
+dracut <replaceable><initramfs_name></replaceable> <replaceable><kernel_version></replaceable>
+</command>:</para>
<screen>~]# <command>dracut "initramfs-$(uname -r).img" $(uname -r)</command>
</screen>
<para>If you need to specify specific kernel modules to be preloaded, add the names of those modules (minus any file name suffixes such as <filename>.ko</filename>) inside the parentheses of the <computeroutput>add_dracutmodules="<replaceable><module></replaceable> <optional><replaceable><more_modules></replaceable>
- </optional>"</computeroutput> directive of the <filename>/etc/dracut.conf</filename> configuration file. You can list the file contents of an <filename>initramfs</filename> image file created by dracut by using the <command>lsinitrd <replaceable><initramfs_file></replaceable>
+</optional>"</computeroutput> directive of the <filename>/etc/dracut.conf</filename> configuration file. You can list the file contents of an <filename>initramfs</filename> image file created by dracut by using the <command>lsinitrd <replaceable><initramfs_file></replaceable>
</command> command:</para>
<screen>~]# <command>lsinitrd initramfs-2.6.32-22.el6.x86_64.img</command>
initramfs-2.6.32-22.el6.x86_64.img:
@@ -460,7 +459,7 @@ drwxr-xr-x 2 root root 0 May 3 22:34 etc/modprobe.d
<primary>boot loader</primary>
<secondary>verifying</secondary>
</indexterm>
- <para>When you install a kernel using<command>rpm</command>, the kernel package creates an entry in the boot loader configuration file for that new kernel. However, <command>rpm</command> does <emphasis>not</emphasis> configure the new kernel to boot as the default kernel. You must do this manually when installing a new kernel with <command>rpm</command>.</para>
+ <para>When you install a kernel using <command>rpm</command>, the kernel package creates an entry in the boot loader configuration file for that new kernel. However, <command>rpm</command> does <emphasis>not</emphasis> configure the new kernel to boot as the default kernel. You must do this manually when installing a new kernel with <command>rpm</command>.</para>
<!-- TBD6: insert link to Installation Guide -->
<para>It is always recommended to double-check the boot loader configuration file after installing a new kernel with <command>rpm</command> to ensure that the configuration is correct. Otherwise, the system may not be able to boot into &MAJOROS; properly. If this happens, boot the system with the boot media created earlier and re-configure the boot loader.</para>
<para>In the following table, find your system's architecture to determine the boot loader it uses, and then click on the "Refer to" link to jump to the correct instructions for your system.</para>
@@ -592,8 +591,7 @@ title Red Hat Enterprise Linux 6 (2.6.32-17.el6.x86_64)
image are relative to <filename>/boot/</filename>. This is the case in <xref
linkend="ex-_boot_grub_grub.conf"/>, above. Therefore the <computeroutput>initrd <filename>/initramfs-2.6.32-22.el6.x86_64.img</filename>
</computeroutput> line in the first kernel stanza means that the <systemitem
- class="filesystem">initramfs</systemitem> image is actually located at <filename>/boot/initramfs-2.6.32-22.el6.x86_64.img</filename> when the root file system is mounted, and likewise for the kernel path (for example: <computeroutput>kernel <filename>/vmlinuz-2.6.32-22.el6.x86_64</filename>
- </computeroutput>) in each stanza of <filename>grub.conf</filename>.</para>
+ class="filesystem">initramfs</systemitem> image is actually located at <filename>/boot/initramfs-2.6.32-22.el6.x86_64.img</filename> when the root file system is mounted, and likewise for the kernel path (for example: <computeroutput>kernel /vmlinuz-2.6.32-22.el6.x86_64</computeroutput>) in each stanza of <filename>grub.conf</filename>.</para>
<note
id="note-The_initrd_directive_in_grub.conf_refers_to_an_initramfs_image">
<title>The initrd directive in grub.conf refers to an initramfs image</title>
@@ -618,7 +616,7 @@ title Red Hat Enterprise Linux 6 (2.6.32-17.el6.x86_64)
<para>In <xref
linkend="ex-_boot_grub_grub.conf"/> GRUB is therefore configured to boot an older kernel, when we compare by version numbers. In order to boot the newer kernel, which is the <emphasis>first</emphasis>
<computeroutput>title</computeroutput> entry in <filename>grub.conf</filename>, we would need to change the <computeroutput>default</computeroutput> value to <constant>0</constant>.</para>
- <para>After installing a new kernel with <command>rpm</command>, verify that <filename>/boot/grub/grub.conf</filename> is correct, change the <computeroutput>default=</computeroutput> value to the new kernel (while remembering to count from 0), and reboot the computer into the new kernel (ensure your hardware is detected by watching the boot process output).</para>
+ <para>After installing a new kernel with <command>rpm</command>, verify that <filename>/boot/grub/grub.conf</filename> is correct, change the <computeroutput>default=</computeroutput> value to the new kernel (while remembering to count from <constant>0</constant>), and reboot the computer into the new kernel. Ensure your hardware is detected by watching the boot process output.</para>
<para>If GRUB presents an error and is unable to boot into the default kernel, it is often easiest to try to boot into an alternative or older kernel so that you can fix the problem.</para>
<important>
<title>Important: Causing the GRUB boot menu to display</title>
More information about the docs-commits
mailing list