source: chapter08/kernel.xml@ a1e18fa

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 11.1 11.1-rc1 11.2 11.2-rc1 11.3 11.3-rc1 12.0 12.0-rc1 12.1 12.1-rc1 6.3 6.4 6.5 6.6 6.7 6.8 7.0 7.1 7.2 7.3 7.4 7.5 7.5-systemd 7.6 7.6-systemd 7.7 7.7-systemd 7.8 7.8-systemd 7.9 7.9-systemd 8.0 8.1 8.2 8.3 8.4 9.0 9.1 arm bdubbs/gcc13 ml-11.0 multilib renodr/libudev-from-systemd s6-init trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/lfs-next xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/mips64el xry111/pip3 xry111/rust-wip-20221008 xry111/update-glibc
Last change on this file since a1e18fa was a1e18fa, checked in by Matthew Burgess <matthew@…>, 18 years ago

Install Linux kernel documentation. Fixes bug 1683

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@7295 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

  • Property mode set to 100644
File size: 10.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../general.ent">
5 %general-entities;
6]>
7
8<sect1 id="ch-bootable-kernel" role="wrap">
9 <?dbhtml filename="kernel.html"?>
10
11 <title>Linux-&linux-version;</title>
12
13 <indexterm zone="ch-bootable-kernel">
14 <primary sortas="a-Linux">Linux</primary>
15 </indexterm>
16
17 <sect2 role="package">
18 <title/>
19
20 <para>The Linux package contains the Linux kernel.</para>
21
22 <segmentedlist>
23 <segtitle>&buildtime;</segtitle>
24 <segtitle>&diskspace;</segtitle>
25
26 <seglistitem>
27 <seg>4.20 SBU</seg>
28 <seg>181 MB</seg>
29 </seglistitem>
30 </segmentedlist>
31
32 <segmentedlist>
33 <segtitle>&dependencies;</segtitle>
34
35 <seglistitem>
36 <seg>Bash, Binutils, Coreutils, Findutils, GCC, Glibc, Grep, Gzip,
37 Make, Modutils, Perl, and Sed</seg>
38 </seglistitem>
39 </segmentedlist>
40
41 </sect2>
42
43 <sect2 role="installation">
44 <title>Installation of the kernel</title>
45
46 <para>Building the kernel involves a few steps&mdash;configuration,
47 compilation, and installation. Read the <filename>README</filename> file
48 in the kernel source tree for alternative methods to the way this book
49 configures the kernel.</para>
50
51 <para>By default, the Linux kernel generates wrong sequences of bytes when
52 dead keys are used in UTF-8 keyboard mode. Also, one cannot copy and paste
53 non-ASCII characters when UTF-8 mode is active. Fix these issues with the
54 patch:</para>
55
56<screen><userinput>patch -Np1 -i ../&linux-utf8-patch;</userinput></screen>
57
58 <para>Prepare for compilation by running the following command:</para>
59
60<screen><userinput>make mrproper</userinput></screen>
61
62 <para>This ensures that the kernel tree is absolutely clean. The
63 kernel team recommends that this command be issued prior to each
64 kernel compilation. Do not rely on the source tree being clean after
65 un-tarring.</para>
66
67 <!-- Support for compiling a keymap into the kernel is deliberately removed -->
68
69 <para>Configure the kernel via a menu-driven interface. BLFS has some
70 information regarding particular kernel configuration requirements of
71 packages outside of LFS at <ulink
72 url="&blfs-root;view/svn/longindex.html#kernel-config-index"/>:</para>
73
74<screen role="nodump"><userinput>make menuconfig</userinput></screen>
75
76 <para>Alternatively, <command>make oldconfig</command> may be more
77 appropriate in some situations. See the <filename>README</filename>
78 file for more information.</para>
79
80 <para>If desired, skip kernel configuration by copying the kernel
81 config file, <filename>.config</filename>, from the host system
82 (assuming it is available) to the unpacked <filename
83 class="directory">linux-&linux-version;</filename> directory. However,
84 we do not recommend this option. It is often better to explore all the
85 configuration menus and create the kernel configuration from
86 scratch.</para>
87
88 <note>
89 <para>NPTL requires the kernel to be compiled with GCC-3.x or later, in
90 this case &gcc-version;. It is not recommended to compile the kernel with
91 GCC-2.95.x, as this causes failures in the Glibc test suite. Normally,
92 this wouldn't be mentioned as LFS doesn't build GCC-2.95.x. Unfortunately,
93 the kernel documentation is outdated and still claims GCC-2.95.3 is the
94 recommended compiler.</para>
95 </note>
96
97 <para>Compile the kernel image and modules:</para>
98
99<screen><userinput>make</userinput></screen>
100
101 <para>If using kernel modules, an <filename>/etc/modprobe.conf</filename> file
102 may be needed. Information pertaining to modules and kernel configuration is
103 located in the kernel documentation in the <filename
104 class="directory">linux-&linux-version;/Documentation</filename> directory.
105 Also, <filename>modprobe.conf(5)</filename> may be of interest.</para>
106
107 <para>Be very careful when reading other documentation relating to kernel
108 modules because it usually applies to 2.4.x kernels only. As far as we know,
109 kernel configuration issues specific to Hotplug and Udev are not documented.
110 The problem is that Udev will create a device node only if Hotplug or a
111 user-written script inserts the corresponding module into the kernel, and not
112 all modules are detectable by Hotplug. Note that statements like the one below
113 in the <filename>/etc/modprobe.conf</filename> file do not work with
114 Udev:</para>
115
116<screen><literal>alias char-major-XXX some-module</literal></screen>
117
118 <para>Because of the complications with Hotplug, Udev, and modules, we
119 strongly recommend starting with a completely non-modular kernel
120 configuration, especially if this is the first time using Udev.</para>
121
122 <para>Install the modules, if the kernel configuration uses them:</para>
123
124<screen><userinput>make modules_install</userinput></screen>
125
126 <para>After kernel compilation is complete, additional steps are
127 required to complete the installation. Some files need to be copied to
128 the <filename class="directory">/boot</filename> directory.</para>
129
130 <para>The path to the kernel image may vary depending on the platform
131 being used. The following command assumes an x86 architecture:</para>
132
133<screen><userinput>cp -v arch/i386/boot/bzImage /boot/lfskernel-&linux-version;</userinput></screen>
134
135 <para><filename>System.map</filename> is a symbol file for the kernel.
136 It maps the function entry points of every function in the kernel API,
137 as well as the addresses of the kernel data structures for the running
138 kernel. Issue the following command to install the map file:</para>
139
140<screen><userinput>cp -v System.map /boot/System.map-&linux-version;</userinput></screen>
141
142 <para>The kernel configuration file <filename>.config</filename>
143 produced by the <command>make menuconfig</command> step
144 above contains all the configuration selections for the kernel
145 that was just compiled. It is a good idea to keep this file for future
146 reference:</para>
147
148<screen><userinput>cp -v .config /boot/config-&linux-version;</userinput></screen>
149
150 <para>Install the documentation for the Linux kernel:</para>
151
152<screen>install -d /usr/share/doc/linux-&linux-version; &amp;&amp;
153cp -r Documentation/* /usr/share/doc/linux-&linux-version;</screen>
154
155 <para>It is important to note that the files in the kernel source
156 directory are not owned by <emphasis>root</emphasis>. Whenever a
157 package is unpacked as user <emphasis>root</emphasis> (like we did
158 inside chroot), the files have the user and group IDs of whatever
159 they were on the packager's computer. This is usually not a problem
160 for any other package to be installed because the source tree is
161 removed after the installation. However, the Linux source tree is
162 often retained for a long time. Because of this, there is a chance
163 that whatever user ID the packager used will be assigned to somebody
164 on the machine. That person would then have write access to the kernel
165 source.</para>
166
167 <para>If the kernel source tree is going to be retained, run
168 <command>chown -R 0:0</command> on the <filename
169 class="directory">linux-&linux-version;</filename> directory to ensure
170 all files are owned by user <emphasis>root</emphasis>.</para>
171
172 <warning>
173 <para>Some kernel documentation recommends creating a symlink from
174 <filename class="symlink">/usr/src/linux</filename> pointing to the kernel
175 source directory. This is specific to kernels prior to the 2.6 series and
176 <emphasis>must not</emphasis> be created on an LFS system as it can cause
177 problems for packages you may wish to build once your base LFS system is
178 complete.</para>
179
180 <para>Also, the headers in the system's
181 <filename class="directory">include</filename> directory should
182 <emphasis>always</emphasis> be the ones against which Glibc was compiled,
183 that is, the ones from the Linux-Libc-Headers package, and therefore, should
184 <emphasis>never</emphasis> be replaced by the kernel headers.</para>
185 </warning>
186
187 </sect2>
188
189
190 <sect2 id="contents-kernel" role="content">
191 <title>Contents of Linux</title>
192
193 <segmentedlist>
194 <segtitle>Installed files</segtitle>
195
196 <seglistitem>
197 <seg>config-&linux-version;, lfskernel-&linux-version;, and
198 System.map-&linux-version;</seg>
199 </seglistitem>
200 </segmentedlist>
201
202 <variablelist>
203 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
204 <?dbfo list-presentation="list"?>
205 <?dbhtml list-presentation="table"?>
206
207 <varlistentry id="config">
208 <term><filename>config-&linux-version;</filename></term>
209 <listitem>
210 <para>Contains all the configuration selections for the kernel</para>
211 <indexterm zone="ch-bootable-kernel config">
212 <primary sortas="e-/boot/config">/boot/config-&linux-version;</primary>
213 </indexterm>
214 </listitem>
215 </varlistentry>
216
217 <varlistentry id="lfskernel">
218 <term><filename>lfskernel-&linux-version;</filename></term>
219 <listitem>
220 <para>The engine of the Linux system. When turning on the computer,
221 the kernel is the first part of the operating system that gets loaded.
222 It detects and initializes all components of the computer's hardware,
223 then makes these components available as a tree of files to the
224 software and turns a single CPU into a multitasking machine capable
225 of running scores of programs seemingly at the same time</para>
226 <indexterm zone="ch-bootable-kernel lfskernel">
227 <primary sortas="b-lfskernel">lfskernel-&linux-version;</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="System.map">
233 <term><filename>System.map-&linux-version;</filename></term>
234 <listitem>
235 <para>A list of addresses and symbols; it maps the entry points and
236 addresses of all the functions and data structures in the
237 kernel</para>
238 <indexterm zone="ch-bootable-kernel System.map">
239 <primary sortas="e-/boot/System.map">/boot/System.map-&linux-version;</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 </variablelist>
245
246 </sect2>
247
248</sect1>
Note: See TracBrowser for help on using the repository browser.