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

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 7a3ea39 was 7a3ea39, checked in by Chris Staub <chris@…>, 11 years ago

Added command explanation to Linux-Headers pages

  • Property mode set to 100644
File size: 3.1 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    <para os="a">For this step you will need the kernel tarball.</para>
29
30    <para os="b">Install the kernel header files:</para>
31
32<screen os="c"><userinput>make mrproper
33make headers_check
34make INSTALL_HDR_PATH=dest headers_install
35cp -rv dest/include/* /usr/include</userinput></screen>
36
37    <variablelist os="d">
38      <title>The meaning of the make commands:</title>
39
40      <varlistentry os="d1">
41        <term><parameter>make mrproper</parameter></term>
42        <listitem>
43          <para>Ensures that the kernel source dir is clean.</para>
44        </listitem>
45      </varlistentry>
46
47      <varlistentry os="d2">
48        <term><parameter>make headers_check</parameter></term>
49        <listitem>
50          <para>Sanitizes the raw kernel headers so that they can be used
51          by userspace programs.</para>
52        </listitem>
53      </varlistentry>
54
55      <varlistentry os="d3">
56        <term><parameter>make INSTALL_HDR_PATH=dest headers_install</parameter></term>
57        <listitem>
58          <para>Normally the headers_install target removes the entire
59          destination directory (default
60          <filename class="directory">/usr/include</filename>) before
61          installing the headers. To prevent this, we tell the kernel to
62          install the headers to a directory inside the source dir.</para>
63        </listitem>
64      </varlistentry>
65
66    </variablelist>
67
68  </sect2>
69
70  <sect2 id="contents-linux-headers" role="content">
71    <title>Contents of Linux-Headers</title>
72
73    <segmentedlist>
74      <segtitle>Installed headers</segtitle>
75
76      <seglistitem>
77        <seg>/usr/include/{asm,asm-generic,drm,linux,mtd,rdma,sound,video}/*.h</seg>
78      </seglistitem>
79    </segmentedlist>
80
81    <variablelist>
82      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
83      <?dbfo list-presentation="list"?>
84      <?dbhtml list-presentation="table"?>
85
86      <varlistentry id="linux-headers">
87        <term><filename
88        class="headerfile">/usr/include/{asm,asm-generic,drm,linux,mtd,rdma,sound,video}/*.h</filename></term>
89        <listitem>
90          <para>The Linux API headers</para>
91          <indexterm zone="ch-system-linux-headers linux-headers">
92            <primary
93            sortas="e-/usr/include/{asm,linux}/*.h">/usr/include/{asm,linux}/*.h</primary>
94          </indexterm>
95        </listitem>
96      </varlistentry>
97
98    </variablelist>
99
100  </sect2>
101
102</sect1>
Note: See TracBrowser for help on using the repository browser.