source: BOOK/final-system/common/linux-headers.xml @ c8cab44

clfs-3.0.0-sysvinitsysvinit
Last change on this file since c8cab44 was c8cab44, checked in by Chris Staub <chris@…>, 10 years ago

Added a more detailed note to the linux-headers page

  • Property mode set to 100644
File size: 4.0 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4  <!ENTITY % general-entities SYSTEM "../../general.ent">
5  %general-entities;
6]>
7
8<sect1 id="ch-system-linux-headers" role="wrap">
9  <?dbhtml filename="linux-headers.html"?>
10
11  <title>Linux-Headers-&linux-version;</title>
12
13  <indexterm zone="ch-system-linux-headers">
14    <primary sortas="a-Linux-Headers">Linux-Headers</primary>
15  </indexterm>
16
17  <sect2 role="package">
18    <title/>
19
20    <para>The Linux Kernel contains a make target that installs
21    <quote>sanitized</quote> kernel headers.</para>
22
23  </sect2>
24
25  <sect2 role="installation">
26    <title>Installation of Linux-Headers</title>
27
28    <note os="a">
29      <para>There is no actual package called "Linux-Headers" in this book.
30      This step involves "sanitizing" and installing a number of header files
31      from the Linux kernel source so that they can used by other packages.
32      Therefore, for this step you will need to unpack the kernel tarball
33      (<filename>linux-&linux-version;.tar.xz</filename>) and
34      <command>cd</command> into its source
35      directory before entering the commands on this page.</para>
36    </note>
37
38    <para os="b">Install the kernel header files:</para>
39
40<screen os="c"><userinput>make mrproper
41make headers_check
42make INSTALL_HDR_PATH=/usr headers_install
43find /usr/include -name .install -or -name ..install.cmd | xargs rm -fv</userinput></screen>
44
45    <variablelist os="d">
46      <title>The meaning of the make commands:</title>
47
48      <varlistentry os="d1">
49        <term><parameter>make mrproper</parameter></term>
50        <listitem>
51          <para>Ensures that the kernel source dir is clean.</para>
52        </listitem>
53      </varlistentry>
54
55      <varlistentry os="d2">
56        <term><parameter>make headers_check</parameter></term>
57        <listitem>
58          <para>Sanitizes the raw kernel headers so that they can be used
59          by userspace programs.</para>
60        </listitem>
61      </varlistentry>
62
63      <varlistentry os="d3">
64        <term><parameter>make INSTALL_HDR_PATH=/usr headers_install</parameter></term>
65        <listitem>
66          <para>This will install the kernel headers into
67          <filename class="directory">/usr/include</filename>.</para>
68        </listitem>
69      </varlistentry>
70
71      <varlistentry os="d4">
72        <term><parameter>find /usr/include -name .install -or -name ..install.cmd | xargs rm -fv</parameter></term>
73        <listitem>
74          <para>Removes a number of unneeded debugging files that were installed.</para>
75        </listitem>
76      </varlistentry>
77
78    </variablelist>
79
80  </sect2>
81
82  <sect2 id="contents-linux-headers" role="content">
83    <title>Contents of Linux-Headers</title>
84
85    <segmentedlist>
86      <segtitle>Installed headers</segtitle>
87      <segtitle>Installed directories</segtitle>
88
89      <seglistitem>
90        <seg>/usr/include/{asm,asm-generic,drm,linux,mtd,rdma,scsi,sound,video,xen}/*.h</seg>
91        <seg>/usr/include/asm, /usr/include/asm-generic, /usr/include/drm,
92        /usr/include/linux, /usr/include/mtd, /usr/include/rdma,
93        /usr/include/scsi, /usr/include/sound, /usr/include/uapi,
94        /usr/include/video, /usr/include/xen</seg>
95      </seglistitem>
96    </segmentedlist>
97
98    <variablelist>
99      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
100      <?dbfo list-presentation="list"?>
101      <?dbhtml list-presentation="table"?>
102
103      <varlistentry id="linux-headers">
104        <term><filename
105        class="headerfile">/usr/include/{asm,asm-generic,drm,linux,mtd,rdma,sound,video}/*.h</filename></term>
106        <listitem>
107          <para>The Linux API headers</para>
108          <indexterm zone="ch-system-linux-headers linux-headers">
109            <primary
110            sortas="e-/usr/include/{asm,linux}/*.h">/usr/include/{asm,linux}/*.h</primary>
111          </indexterm>
112        </listitem>
113      </varlistentry>
114
115    </variablelist>
116
117  </sect2>
118
119</sect1>
Note: See TracBrowser for help on using the repository browser.