en/glep/glep-0026.html

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!--
This HTML is auto-generated.  DO NOT EDIT THIS FILE!  If you are writing a new
PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
to templates.  DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
-->
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta name="generator" content="Docutils 0.3.3: http://docutils.sourceforge.net/" />
  <title>GLEP 26 -- Handling kernels with portage</title>
  <link rel="stylesheet" href="tools/glep.css" type="text/css" />
</head>
<body bgcolor="white">
<table class="navigation" cellpadding="0" cellspacing="0"
       width="100%" border="0">
<tr><td class="navicon" width="150" height="35">
<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
 border="0" width="150" height="35" /></a></td>
<td class="textlinks" align="left">
[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
[<b><a href="./glep-0026.txt">GLEP Source</a></b>]
</td></tr></table>
<div class="document">
<table class="rfc2822 field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">26</td>
</tr>
<tr class="field"><th class="field-name">Title:</th><td class="field-body">Handling kernels with portage</td>
</tr>
<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td>
</tr>
<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0026.txt?cvsroot=gentoo">2004/11/11 21:32:21</a></td>
</tr>
<tr class="field"><th class="field-name">Author:</th><td class="field-body">Nathaniel McCallum &lt;npmccallum&#32;&#97;t&#32;gentoo.org&gt;, Joshua Campbell &lt;warpzero&#32;&#97;t&#32;gentoo.org&gt;</td>
</tr>
<tr class="field"><th class="field-name">Status:</th><td class="field-body">deferred</td>
</tr>
<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
</tr>
<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0012.html">text/x-rst</a></td>
</tr>
<tr class="field"><th class="field-name">Created:</th><td class="field-body">2-May-2004</td>
</tr>
<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">2-May-2004, 11-Nov-2004</td>
</tr>
</tbody>
</table>
<hr />
<div class="contents topic" id="contents">
<p class="topic-title first"><a name="contents">Contents</a></p>
<ul class="simple">
<li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li>
<li><a class="reference" href="#status" id="id3" name="id3">Status</a></li>
<li><a class="reference" href="#motivation" id="id4" name="id4">Motivation</a></li>
<li><a class="reference" href="#specification" id="id5" name="id5">Specification</a></li>
<li><a class="reference" href="#rationale" id="id6" name="id6">Rationale</a></li>
<li><a class="reference" href="#backwards-compatibility" id="id7" name="id7">Backwards Compatibility</a></li>
<li><a class="reference" href="#reference-implementation" id="id8" name="id8">Reference Implementation</a></li>
<li><a class="reference" href="#copyright" id="id9" name="id9">Copyright</a></li>
</ul>
</div>
<div class="section" id="abstract">
<h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1>
<p>This GLEP proposes to create a more consistent handling of kernels and kernel building.
Currently &quot;emerge kernel-name&quot; only installs the sources and does not build anything.
&quot;emerge kernel-name&quot; should install only sources OR only a binary kernel, its modules, 
and a tarballed package of kernel-headers, depending on USE flag.</p>
</div>
<div class="section" id="status">
<h1><a class="toc-backref" href="#id3" name="status">Status</a></h1>
<p>Timed out</p>
</div>
<div class="section" id="motivation">
<h1><a class="toc-backref" href="#id4" name="motivation">Motivation</a></h1>
<p>Currently, the only automated kernel build proceedure that we have is genkernel. While
genkernel is a great tool, its main weakness is that it does not port well to other
arches because of the initrd and the lack of good &quot;generic&quot; settings for other arches.
This GLEP hopes to overcome this by abstracting the various layers of genkernel and
implementing the most common aspect (the build proceedure) into a portage eclass.</p>
</div>
<div class="section" id="specification">
<h1><a class="toc-backref" href="#id5" name="specification">Specification</a></h1>
<p>There would be 3 layers to kernel building:             (place of implementation)</p>
<blockquote>
<ul class="simple">
<li>Stage 1 - Configuring the kernel (optional)   -- external utility</li>
<li>Stage 2 - Building the kernel                         -- in an eclass</li>
<li>Stage 3 - Building the initrd (optional)      -- in an ebuild</li>
</ul>
</blockquote>
<p>Stages 1 and 3 are optional on most arches.</p>
<p>Stage 1 would be achieved through a seperate utility (perhaps like the current
genkernel).  This utility would help the user configure the kernel and any kernel/build
related settings.  This stage is optional and would only be used if a person wanted a
customized kernel settings.  One optional thought is to have this utility a part of the 
base Gentoo system.  That way there are less steps to make a custom kernel.</p>
<p>Stage 2 would be implimented through an eclass.  This stage is not optional.  One would
perform this step by typing &quot;emerge kernel-name&quot;, where &quot;kernel-name&quot; is the name of
the kernel package you want to use (ie. &quot;gentoo-dev&quot;).  This package would have a
&quot;buildkernel&quot; USE flag.  If the flag was not set, it would simply download and install
sources like we do currently.  However, if the &quot;buildkernel&quot; flag is set, portage will 
perform the following steps:</p>
<blockquote>
<ol class="arabic simple">
<li>(as a dependency) download and install a tarball of &quot;generic&quot; kernel config files.</li>
<li>Check to see if customized kernel config/settings have been set via Stage 1.</li>
<li>Portage will use a custom config, if available.  Otherwise, a &quot;generic&quot; config.</li>
<li>If neither a custom config or a &quot;generic&quot; config is available, die (with message).
This is needed as some arches don't/can't have &quot;generic&quot; configs, so they will
simply be presented a message telling them to run the utility from Stage 1 (which
they obviously skipped).</li>
<li>Build the kernel and modules and install them</li>
<li>Remove unnecessary files from the sources and tarball it as &quot;kernel-headers&quot;.
This tarball provides the appropriate files to build external modules against, like
nvidia-kernel, etc...  The external modules (when built) will determine the running
kernel and unpack the appropriate tarball, to build against, then remove the files.</li>
</ol>
</blockquote>
<p>Stage 3 would merely be an ebuild that constructs an initrd image for either the running
kernel or, lacking a running kernel, the newest kernel installed (by version/date installed?).
Initrd's can't be used on all arches, so this ebuild can be keyword masked as appropriate.
The initrd package would also have a &quot;bootsplash&quot; USE flag (on x86, maybe others) that
would build in bootsplash support.  Any non-default actions desired by the user can be
handled with the utility from Stage 1.</p>
<p>This would lead us to several case scenarios (assuming kernel-config is part of the base 
system):</p>
<blockquote>
<ol class="arabic">
<li><p class="first">default kernel, no initrd:              &quot;emerge gentoo-kernel&quot;</p>
</li>
<li><p class="first">default kernel, initrd:                 &quot;emerge aa-kernel initrd&quot;</p>
</li>
<li><p class="first">default kernel, bootsplash initrd:      &quot;USE=bootsplash emerge mm-kernel initrd&quot;</p>
</li>
<li><dl class="first">
<dt>non-default kernel, no initrd:          &quot;kernel-config gentoo-dev-kernel&quot;</dt>
<dd><p class="first last">&quot;emerge gentoo-dev-kernel&quot;</p>
</dd>
</dl>
</li>
<li><dl class="first">
<dt>non-default kernel, initrd:             &quot;kernel-config alpha-kernel&quot;</dt>
<dd><p class="first last">&quot;emerge alpha-kernel initrd&quot;</p>
</dd>
</dl>
</li>
<li><p class="first">JUST sources, no binary                 &quot;USE=-buildkernel emerge grsec-kernel&quot;</p>
</li>
</ol>
</blockquote>
</div>
<div class="section" id="rationale">
<h1><a class="toc-backref" href="#id6" name="rationale">Rationale</a></h1>
<p>There are many advantages gained by this method:</p>
<blockquote>
<ol class="arabic simple">
<li>Full arch support (GentooInstaller really could use this)</li>
<li>More consistent with the rest of portage (installs binaries by building from source)</li>
<li>Better user experience</li>
<li>More flexability (genkernel forces building of initrd on x86)</li>
<li>Don't have to store full kernel sources (each source tree is ~200MB unpacked)</li>
<li>Creates the ability to make binary kernel packages for fast installs (think GRP kernel)</li>
<li>A seperate package for &quot;generic&quot; kernel config files gives us better version tracking</li>
</ol>
</blockquote>
<p>The major problem is, however, that we currently have two different build systems,
portage and genkernel.  Having competing build systems is not a GoodThing TM.  Therefore,
we can either make portage build kernels or we can make genkernel build everything else.</p>
</div>
<div class="section" id="backwards-compatibility">
<h1><a class="toc-backref" href="#id7" name="backwards-compatibility">Backwards Compatibility</a></h1>
<p>If you want to emerge kernel sources the old way, just do: USE=&quot;-buildkernel&quot; emerge kernel-name</p>
<p>Perhaps we could also name the new kernel-config program (from Stage 1) &quot;genkernel&quot; so that users 
can have a seemless transition.</p>
</div>
<div class="section" id="reference-implementation">
<h1><a class="toc-backref" href="#id8" name="reference-implementation">Reference Implementation</a></h1>
<p>not yet ..</p>
</div>
<div class="section" id="copyright">
<h1><a class="toc-backref" href="#id9" name="copyright">Copyright</a></h1>
<p>This document has been placed in the public domain.</p>
</div>
</div>

<hr class="footer" />
<div class="footer">
<a class="reference" href="glep-0026.txt">View document source</a>.
Generated on: 2004-11-11 21:25 UTC.
Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
</div>
</body>
</html>

1	<?xml version="1.0" encoding="utf-8" ?>
2	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<!--
5	This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
6	PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
7	to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8	-->
9	<head>
10	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11	<meta name="generator" content="Docutils 0.3.3: http://docutils.sourceforge.net/" />
12	<title>GLEP 26 -- Handling kernels with portage</title>
13	<link rel="stylesheet" href="tools/glep.css" type="text/css" />
14	</head>
15	<body bgcolor="white">
16	<table class="navigation" cellpadding="0" cellspacing="0"
17	width="100%" border="0">
18	<tr><td class="navicon" width="150" height="35">
19	<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20	<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21	border="0" width="150" height="35" /></a></td>
22	<td class="textlinks" align="left">
23	[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
24	[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
25	[<b><a href="./glep-0026.txt">GLEP Source</a></b>]
26	</td></tr></table>
27	<div class="document">
28	<table class="rfc2822 field-list" frame="void" rules="none">
29	<col class="field-name" />
30	<col class="field-body" />
31	<tbody valign="top">
32	<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">26</td>
33	</tr>
34	<tr class="field"><th class="field-name">Title:</th><td class="field-body">Handling kernels with portage</td>
35	</tr>
36	<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td>
37	</tr>
38	<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0026.txt?cvsroot=gentoo">2004/11/11 21:32:21</a></td>
39	</tr>
40	<tr class="field"><th class="field-name">Author:</th><td class="field-body">Nathaniel McCallum <npmccallum at gentoo.org>, Joshua Campbell <warpzero at gentoo.org></td>
41	</tr>
42	<tr class="field"><th class="field-name">Status:</th><td class="field-body">deferred</td>
43	</tr>
44	<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
45	</tr>
46	<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0012.html">text/x-rst</a></td>
47	</tr>
48	<tr class="field"><th class="field-name">Created:</th><td class="field-body">2-May-2004</td>
49	</tr>
50	<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">2-May-2004, 11-Nov-2004</td>
51	</tr>
52	</tbody>
53	</table>
54	<hr />
55	<div class="contents topic" id="contents">
56	<p class="topic-title first"><a name="contents">Contents</a></p>
57	<ul class="simple">
58	<li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li>
59	<li><a class="reference" href="#status" id="id3" name="id3">Status</a></li>
60	<li><a class="reference" href="#motivation" id="id4" name="id4">Motivation</a></li>
61	<li><a class="reference" href="#specification" id="id5" name="id5">Specification</a></li>
62	<li><a class="reference" href="#rationale" id="id6" name="id6">Rationale</a></li>
63	<li><a class="reference" href="#backwards-compatibility" id="id7" name="id7">Backwards Compatibility</a></li>
64	<li><a class="reference" href="#reference-implementation" id="id8" name="id8">Reference Implementation</a></li>
65	<li><a class="reference" href="#copyright" id="id9" name="id9">Copyright</a></li>
66	</ul>
67	</div>
68	<div class="section" id="abstract">
69	<h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1>
70	<p>This GLEP proposes to create a more consistent handling of kernels and kernel building.
71	Currently "emerge kernel-name" only installs the sources and does not build anything.
72	"emerge kernel-name" should install only sources OR only a binary kernel, its modules,
73	and a tarballed package of kernel-headers, depending on USE flag.</p>
74	</div>
75	<div class="section" id="status">
76	<h1><a class="toc-backref" href="#id3" name="status">Status</a></h1>
77	<p>Timed out</p>
78	</div>
79	<div class="section" id="motivation">
80	<h1><a class="toc-backref" href="#id4" name="motivation">Motivation</a></h1>
81	<p>Currently, the only automated kernel build proceedure that we have is genkernel. While
82	genkernel is a great tool, its main weakness is that it does not port well to other
83	arches because of the initrd and the lack of good "generic" settings for other arches.
84	This GLEP hopes to overcome this by abstracting the various layers of genkernel and
85	implementing the most common aspect (the build proceedure) into a portage eclass.</p>
86	</div>
87	<div class="section" id="specification">
88	<h1><a class="toc-backref" href="#id5" name="specification">Specification</a></h1>
89	<p>There would be 3 layers to kernel building: (place of implementation)</p>
90	<blockquote>
91	<ul class="simple">
92	<li>Stage 1 - Configuring the kernel (optional) -- external utility</li>
93	<li>Stage 2 - Building the kernel -- in an eclass</li>
94	<li>Stage 3 - Building the initrd (optional) -- in an ebuild</li>
95	</ul>
96	</blockquote>
97	<p>Stages 1 and 3 are optional on most arches.</p>
98	<p>Stage 1 would be achieved through a seperate utility (perhaps like the current
99	genkernel). This utility would help the user configure the kernel and any kernel/build
100	related settings. This stage is optional and would only be used if a person wanted a
101	customized kernel settings. One optional thought is to have this utility a part of the
102	base Gentoo system. That way there are less steps to make a custom kernel.</p>
103	<p>Stage 2 would be implimented through an eclass. This stage is not optional. One would
104	perform this step by typing "emerge kernel-name", where "kernel-name" is the name of
105	the kernel package you want to use (ie. "gentoo-dev"). This package would have a
106	"buildkernel" USE flag. If the flag was not set, it would simply download and install
107	sources like we do currently. However, if the "buildkernel" flag is set, portage will
108	perform the following steps:</p>
109	<blockquote>
110	<ol class="arabic simple">
111	<li>(as a dependency) download and install a tarball of "generic" kernel config files.</li>
112	<li>Check to see if customized kernel config/settings have been set via Stage 1.</li>
113	<li>Portage will use a custom config, if available. Otherwise, a "generic" config.</li>
114	<li>If neither a custom config or a "generic" config is available, die (with message).
115	This is needed as some arches don't/can't have "generic" configs, so they will
116	simply be presented a message telling them to run the utility from Stage 1 (which
117	they obviously skipped).</li>
118	<li>Build the kernel and modules and install them</li>
119	<li>Remove unnecessary files from the sources and tarball it as "kernel-headers".
120	This tarball provides the appropriate files to build external modules against, like
121	nvidia-kernel, etc... The external modules (when built) will determine the running
122	kernel and unpack the appropriate tarball, to build against, then remove the files.</li>
123	</ol>
124	</blockquote>
125	<p>Stage 3 would merely be an ebuild that constructs an initrd image for either the running
126	kernel or, lacking a running kernel, the newest kernel installed (by version/date installed?).
127	Initrd's can't be used on all arches, so this ebuild can be keyword masked as appropriate.
128	The initrd package would also have a "bootsplash" USE flag (on x86, maybe others) that
129	would build in bootsplash support. Any non-default actions desired by the user can be
130	handled with the utility from Stage 1.</p>
131	<p>This would lead us to several case scenarios (assuming kernel-config is part of the base
132	system):</p>
133	<blockquote>
134	<ol class="arabic">
135	<li><p class="first">default kernel, no initrd: "emerge gentoo-kernel"</p>
136	</li>
137	<li><p class="first">default kernel, initrd: "emerge aa-kernel initrd"</p>
138	</li>
139	<li><p class="first">default kernel, bootsplash initrd: "USE=bootsplash emerge mm-kernel initrd"</p>
140	</li>
141	<li><dl class="first">
142	<dt>non-default kernel, no initrd: "kernel-config gentoo-dev-kernel"</dt>
143	<dd><p class="first last">"emerge gentoo-dev-kernel"</p>
144	</dd>
145	</dl>
146	</li>
147	<li><dl class="first">
148	<dt>non-default kernel, initrd: "kernel-config alpha-kernel"</dt>
149	<dd><p class="first last">"emerge alpha-kernel initrd"</p>
150	</dd>
151	</dl>
152	</li>
153	<li><p class="first">JUST sources, no binary "USE=-buildkernel emerge grsec-kernel"</p>
154	</li>
155	</ol>
156	</blockquote>
157	</div>
158	<div class="section" id="rationale">
159	<h1><a class="toc-backref" href="#id6" name="rationale">Rationale</a></h1>
160	<p>There are many advantages gained by this method:</p>
161	<blockquote>
162	<ol class="arabic simple">
163	<li>Full arch support (GentooInstaller really could use this)</li>
164	<li>More consistent with the rest of portage (installs binaries by building from source)</li>
165	<li>Better user experience</li>
166	<li>More flexability (genkernel forces building of initrd on x86)</li>
167	<li>Don't have to store full kernel sources (each source tree is ~200MB unpacked)</li>
168	<li>Creates the ability to make binary kernel packages for fast installs (think GRP kernel)</li>
169	<li>A seperate package for "generic" kernel config files gives us better version tracking</li>
170	</ol>
171	</blockquote>
172	<p>The major problem is, however, that we currently have two different build systems,
173	portage and genkernel. Having competing build systems is not a GoodThing TM. Therefore,
174	we can either make portage build kernels or we can make genkernel build everything else.</p>
175	</div>
176	<div class="section" id="backwards-compatibility">
177	<h1><a class="toc-backref" href="#id7" name="backwards-compatibility">Backwards Compatibility</a></h1>
178	<p>If you want to emerge kernel sources the old way, just do: USE="-buildkernel" emerge kernel-name</p>
179	<p>Perhaps we could also name the new kernel-config program (from Stage 1) "genkernel" so that users
180	can have a seemless transition.</p>
181	</div>
182	<div class="section" id="reference-implementation">
183	<h1><a class="toc-backref" href="#id8" name="reference-implementation">Reference Implementation</a></h1>
184	<p>not yet ..</p>
185	</div>
186	<div class="section" id="copyright">
187	<h1><a class="toc-backref" href="#id9" name="copyright">Copyright</a></h1>
188	<p>This document has been placed in the public domain.</p>
189	</div>
190	</div>
191
192	<hr class="footer" />
193	<div class="footer">
194	<a class="reference" href="glep-0026.txt">View document source</a>.
195	Generated on: 2004-11-11 21:25 UTC.
196	Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
197	</div>
198	</body>
199	</html>
200