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

clfs-3.0.0-systemdsystemd
Last change on this file since be1c363 was be1c363, checked in by Chris Staub <chris@…>, 8 years ago

Change title for Linux Headers pages

Conflicts:

BOOK/appendices/dependencies/common.xml
BOOK/introduction/common/changelog.xml

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