linux-headers.xml 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  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. <sect1 id="ch-tools-linux-headers" role="wrap">
  8. <?dbhtml filename="linux-headers.html"?>
  9. <sect1info condition="script">
  10. <productname>linux-headers</productname>
  11. <productnumber>&linux-version;</productnumber>
  12. <address>&linux-url;</address>
  13. </sect1info>
  14. <title>Linux-&linux-version; API Headers</title>
  15. <indexterm zone="ch-tools-linux-headers">
  16. <primary sortas="a-Linux">Linux</primary>
  17. <secondary>tools, API headers</secondary>
  18. </indexterm>
  19. <sect2 role="package">
  20. <title/>
  21. <para>The Linux API Headers (in linux-&linux-version;.tar.xz) expose the
  22. kernel's API for use by Glibc.</para>
  23. <segmentedlist>
  24. <segtitle>&buildtime;</segtitle>
  25. <segtitle>&diskspace;</segtitle>
  26. <seglistitem>
  27. <seg>&linux-headers-ch5-sbu;</seg>
  28. <seg>&linux-headers-ch5-du;</seg>
  29. </seglistitem>
  30. </segmentedlist>
  31. </sect2>
  32. <sect2 role="installation">
  33. <title>Installation of Linux API Headers</title>
  34. <para>The Linux kernel needs to expose an Application Programming Interface
  35. (API) for the system's C library (Glibc in LFS) to use. This is done
  36. by way of sanitizing various C header files that are shipped in the Linux
  37. kernel source tarball.</para>
  38. <para>Make sure there are no stale files embedded in the package:</para>
  39. <screen><userinput remap="pre">make mrproper</userinput></screen>
  40. <para>Now extract the user-visible kernel headers from the source.
  41. The recommended make target <quote>headers_install</quote> cannot be
  42. used, because it requires <application>rsync</application>, which may not
  43. be available. The headers are first placed in
  44. <filename class="directory">./usr</filename>, then copied to the needed
  45. location.</para>
  46. <screen><userinput remap="make">make headers
  47. find usr/include -name '.*' -delete
  48. rm usr/include/Makefile
  49. </userinput><userinput remap="install">cp -rv usr/include $LFS/usr</userinput></screen>
  50. </sect2>
  51. <sect2 id="contents-linux-headers" role="content">
  52. <title>Contents of Linux API Headers</title>
  53. <segmentedlist>
  54. <segtitle>Installed headers</segtitle>
  55. <segtitle>Installed directories</segtitle>
  56. <seglistitem>
  57. <seg>/usr/include/asm/*.h, /usr/include/asm-generic/*.h,
  58. /usr/include/drm/*.h, /usr/include/linux/*.h, /usr/include/misc/*.h,
  59. /usr/include/mtd/*.h, /usr/include/rdma/*.h, /usr/include/scsi/*.h,
  60. /usr/include/sound/*.h, /usr/include/video/*.h,
  61. and /usr/include/xen/*.h</seg>
  62. <seg>/usr/include/asm, /usr/include/asm-generic, /usr/include/drm,
  63. /usr/include/linux, /usr/include/misc, /usr/include/mtd,
  64. /usr/include/rdma, /usr/include/scsi, /usr/include/sound,
  65. /usr/include/video, and /usr/include/xen</seg>
  66. </seglistitem>
  67. </segmentedlist>
  68. <variablelist>
  69. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  70. <?dbfo list-presentation="list"?>
  71. <?dbhtml list-presentation="table"?>
  72. <varlistentry id="asm">
  73. <term><filename class="headerfile">/usr/include/asm/*.h</filename></term>
  74. <listitem>
  75. <para>The Linux API ASM Headers</para>
  76. <indexterm zone="ch-tools-linux-headers asm">
  77. <primary sortas="e-/usr/include/asm/*.h">/usr/include/asm/*.h</primary>
  78. </indexterm>
  79. </listitem>
  80. </varlistentry>
  81. <varlistentry id="asm-generic">
  82. <term><filename class="headerfile">/usr/include/asm-generic/*.h</filename></term>
  83. <listitem>
  84. <para>The Linux API ASM Generic Headers</para>
  85. <indexterm zone="ch-tools-linux-headers asm-generic">
  86. <primary sortas="e-/usr/include/asm-generic/*.h">/usr/include/asm-generic/*.h</primary>
  87. </indexterm>
  88. </listitem>
  89. </varlistentry>
  90. <varlistentry id="drm">
  91. <term><filename class="headerfile">/usr/include/drm/*.h</filename></term>
  92. <listitem>
  93. <para>The Linux API DRM Headers</para>
  94. <indexterm zone="ch-tools-linux-headers drm">
  95. <primary sortas="e-/usr/include/drm/*.h">/usr/include/drm/*.h</primary>
  96. </indexterm>
  97. </listitem>
  98. </varlistentry>
  99. <varlistentry id="linux">
  100. <term><filename class="headerfile">/usr/include/linux/*.h</filename></term>
  101. <listitem>
  102. <para>The Linux API Linux Headers</para>
  103. <indexterm zone="ch-tools-linux-headers linux">
  104. <primary sortas="e-/usr/include/linux/*.h">/usr/include/linux/*.h</primary>
  105. </indexterm>
  106. </listitem>
  107. </varlistentry>
  108. <varlistentry id="misc">
  109. <term><filename class="headerfile">/usr/include/misc/*.h</filename></term>
  110. <listitem>
  111. <para>The Linux API Miscellaneous Headers</para>
  112. <indexterm zone="ch-tools-linux-headers misc">
  113. <primary sortas="e-/usr/include/misc/*.h">/usr/include/misc/*.h</primary>
  114. </indexterm>
  115. </listitem>
  116. </varlistentry>
  117. <varlistentry id="mtd">
  118. <term><filename class="headerfile">/usr/include/mtd/*.h</filename></term>
  119. <listitem>
  120. <para>The Linux API MTD Headers</para>
  121. <indexterm zone="ch-tools-linux-headers mtd">
  122. <primary sortas="e-/usr/include/mtd/*.h">/usr/include/mtd/*.h</primary>
  123. </indexterm>
  124. </listitem>
  125. </varlistentry>
  126. <varlistentry id="rdma">
  127. <term><filename class="headerfile">/usr/include/rdma/*.h</filename></term>
  128. <listitem>
  129. <para>The Linux API RDMA Headers</para>
  130. <indexterm zone="ch-tools-linux-headers rdma">
  131. <primary sortas="e-/usr/include/rdma/*.h">/usr/include/rdma/*.h</primary>
  132. </indexterm>
  133. </listitem>
  134. </varlistentry>
  135. <varlistentry id="scsi">
  136. <term><filename class="headerfile">/usr/include/scsi/*.h</filename></term>
  137. <listitem>
  138. <para>The Linux API SCSI Headers</para>
  139. <indexterm zone="ch-tools-linux-headers scsi">
  140. <primary sortas="e-/usr/include/scsi/*.h">/usr/include/scsi/*.h</primary>
  141. </indexterm>
  142. </listitem>
  143. </varlistentry>
  144. <varlistentry id="sound">
  145. <term><filename class="headerfile">/usr/include/sound/*.h</filename></term>
  146. <listitem>
  147. <para>The Linux API Sound Headers</para>
  148. <indexterm zone="ch-tools-linux-headers sound">
  149. <primary sortas="e-/usr/include/sound/*.h">/usr/include/sound/*.h</primary>
  150. </indexterm>
  151. </listitem>
  152. </varlistentry>
  153. <varlistentry id="video">
  154. <term><filename class="headerfile">/usr/include/video/*.h</filename></term>
  155. <listitem>
  156. <para>The Linux API Video Headers</para>
  157. <indexterm zone="ch-tools-linux-headers video">
  158. <primary sortas="e-/usr/include/video/*.h">/usr/include/video/*.h</primary>
  159. </indexterm>
  160. </listitem>
  161. </varlistentry>
  162. <varlistentry id="xen">
  163. <term><filename class="headerfile">/usr/include/xen/*.h</filename></term>
  164. <listitem>
  165. <para>The Linux API Xen Headers</para>
  166. <indexterm zone="ch-tools-linux-headers xen">
  167. <primary sortas="e-/usr/include/xen/*.h">/usr/include/xen/*.h</primary>
  168. </indexterm>
  169. </listitem>
  170. </varlistentry>
  171. </variablelist>
  172. </sect2>
  173. </sect1>