/[gentoo]/xml/htdocs/proj/en/glep/glep-0053.html
Gentoo

Contents of /xml/htdocs/proj/en/glep/glep-0053.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (show annotations) (download) (as text)
Sun Aug 12 08:37:32 2007 UTC (7 years, 2 months ago) by grobian
Branch: MAIN
File MIME type: text/html
Add html versions of my last changes.  Manually patched to have correct
glep index link.

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.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 53 -- Keywording scheme</title>
13 <style type="text/css">
14
15 /*
16 :Author: David Goodger
17 :Contact: goodger@users.sourceforge.net
18 :date: $Date: 2003/06/02 17:03:08 $
19 :version: $Revision: 1.1 $
20 :copyright: This stylesheet has been placed in the public domain.
21
22 Default cascading style sheet for the PEP HTML output of Docutils.
23 */
24
25 .first {
26 margin-top: 0 }
27
28 .last {
29 margin-bottom: 0 }
30
31 .navigation {
32 width: 100% ;
33 background: #cc99ff ;
34 margin-top: 0px ;
35 margin-bottom: 0px }
36
37 .navigation .navicon {
38 width: 150px ;
39 height: 35px }
40
41 .navigation .textlinks {
42 padding-left: 1em ;
43 text-align: left }
44
45 .navigation td, .navigation th {
46 padding-left: 0em ;
47 padding-right: 0em ;
48 vertical-align: middle }
49
50 .rfc2822 {
51 margin-top: 0.5em ;
52 margin-left: 0.5em ;
53 margin-right: 0.5em ;
54 margin-bottom: 0em }
55
56 .rfc2822 td {
57 text-align: left }
58
59 .rfc2822 th.field-name {
60 text-align: right ;
61 font-family: sans-serif ;
62 padding-right: 0.5em ;
63 font-weight: bold ;
64 margin-bottom: 0em }
65
66 a.toc-backref {
67 text-decoration: none ;
68 color: black }
69
70 body {
71 margin: 0px ;
72 margin-bottom: 1em ;
73 padding: 0px }
74
75 dd {
76 margin-bottom: 0.5em }
77
78 div.section {
79 margin-left: 1em ;
80 margin-right: 1em ;
81 margin-bottom: 1.5em }
82
83 div.section div.section {
84 margin-left: 0em ;
85 margin-right: 0em ;
86 margin-top: 1.5em }
87
88 div.abstract {
89 margin: 2em 5em }
90
91 div.abstract p.topic-title {
92 font-weight: bold ;
93 text-align: center }
94
95 div.attention, div.caution, div.danger, div.error, div.hint,
96 div.important, div.note, div.tip, div.warning {
97 margin: 2em ;
98 border: medium outset ;
99 padding: 1em }
100
101 div.attention p.admonition-title, div.caution p.admonition-title,
102 div.danger p.admonition-title, div.error p.admonition-title,
103 div.warning p.admonition-title {
104 color: red ;
105 font-weight: bold ;
106 font-family: sans-serif }
107
108 div.hint p.admonition-title, div.important p.admonition-title,
109 div.note p.admonition-title, div.tip p.admonition-title {
110 font-weight: bold ;
111 font-family: sans-serif }
112
113 div.figure {
114 margin-left: 2em }
115
116 div.footer, div.header {
117 font-size: smaller }
118
119 div.footer {
120 margin-left: 1em ;
121 margin-right: 1em }
122
123 div.system-messages {
124 margin: 5em }
125
126 div.system-messages h1 {
127 color: red }
128
129 div.system-message {
130 border: medium outset ;
131 padding: 1em }
132
133 div.system-message p.system-message-title {
134 color: red ;
135 font-weight: bold }
136
137 div.topic {
138 margin: 2em }
139
140 h1 {
141 font-family: sans-serif ;
142 font-size: large }
143
144 h2 {
145 font-family: sans-serif ;
146 font-size: medium }
147
148 h3 {
149 font-family: sans-serif ;
150 font-size: small }
151
152 h4 {
153 font-family: sans-serif ;
154 font-style: italic ;
155 font-size: small }
156
157 h5 {
158 font-family: sans-serif;
159 font-size: x-small }
160
161 h6 {
162 font-family: sans-serif;
163 font-style: italic ;
164 font-size: x-small }
165
166 .section hr {
167 width: 75% }
168
169 ol.simple, ul.simple {
170 margin-bottom: 1em }
171
172 ol.arabic {
173 list-style: decimal }
174
175 ol.loweralpha {
176 list-style: lower-alpha }
177
178 ol.upperalpha {
179 list-style: upper-alpha }
180
181 ol.lowerroman {
182 list-style: lower-roman }
183
184 ol.upperroman {
185 list-style: upper-roman }
186
187 p.caption {
188 font-style: italic }
189
190 p.credits {
191 font-style: italic ;
192 font-size: smaller }
193
194 p.label {
195 white-space: nowrap }
196
197 p.topic-title {
198 font-family: sans-serif ;
199 font-weight: bold }
200
201 pre.line-block {
202 font-family: serif ;
203 font-size: 100% }
204
205 pre.literal-block, pre.doctest-block {
206 margin-left: 2em ;
207 margin-right: 2em ;
208 background-color: #eeeeee }
209
210 span.classifier {
211 font-family: sans-serif ;
212 font-style: oblique }
213
214 span.classifier-delimiter {
215 font-family: sans-serif ;
216 font-weight: bold }
217
218 span.interpreted {
219 font-family: sans-serif }
220
221 span.option-argument {
222 font-style: italic }
223
224 span.pre {
225 white-space: pre }
226
227 span.problematic {
228 color: red }
229
230 table {
231 margin-top: 0.5em ;
232 margin-bottom: 0.5em }
233
234 td, th {
235 padding-left: 0.5em ;
236 padding-right: 0.5em ;
237 vertical-align: top }
238
239 td.num {
240 text-align: right }
241
242 th.field-name {
243 font-weight: bold ;
244 text-align: left ;
245 white-space: nowrap }
246
247 h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
248 font-size: 100% }
249
250 tt {
251 background-color: #eeeeee }
252
253 ul.auto-toc {
254 list-style-type: none }
255
256 </style>
257 </head>
258 <body bgcolor="white">
259 <table class="navigation" cellpadding="0" cellspacing="0"
260 width="100%" border="0">
261 <tr><td class="navicon" width="150" height="35">
262 <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
263 <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
264 border="0" width="150" height="35" /></a></td>
265 <td class="textlinks" align="left">
266 [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
267 [<b><a href="http://www.gentoo.org/proj/en/glep/">GLEP Index</a></b>]
268 [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0053.txt">GLEP Source</a></b>]
269 </td></tr></table>
270 <table class="rfc2822 docutils field-list" frame="void" rules="none">
271 <col class="field-name" />
272 <col class="field-body" />
273 <tbody valign="top">
274 <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">53</td>
275 </tr>
276 <tr class="field"><th class="field-name">Title:</th><td class="field-body">Keywording scheme</td>
277 </tr>
278 <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td>
279 </tr>
280 <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.cgi/xml/htdocs/proj/en/glep/glep-0053.txt?cvsroot=gentoo">2007/07/22 10:03:18</a></td>
281 </tr>
282 <tr class="field"><th class="field-name">Author:</th><td class="field-body">Fabian Groffen &lt;grobian&#32;&#97;t&#32;gentoo.org&gt;, Diego Pettenò &lt;flameeyes&#32;&#97;t&#32;gentoo.org&gt;</td>
283 </tr>
284 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td>
285 </tr>
286 <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
287 </tr>
288 <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td>
289 </tr>
290 <tr class="field"><th class="field-name">Created:</th><td class="field-body">11-Dec-2005</td>
291 </tr>
292 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">13-Apr-2007</td>
293 </tr>
294 </tbody>
295 </table>
296 <hr />
297 <div class="contents topic">
298 <p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
299 <ul class="simple">
300 <li><a class="reference" href="#abstract" id="id4" name="id4">Abstract</a></li>
301 <li><a class="reference" href="#motivation" id="id5" name="id5">Motivation</a></li>
302 <li><a class="reference" href="#rationale" id="id6" name="id6">Rationale</a></li>
303 <li><a class="reference" href="#backwards-compatibility" id="id7" name="id7">Backwards Compatibility</a></li>
304 <li><a class="reference" href="#specification" id="id8" name="id8">Specification</a></li>
305 <li><a class="reference" href="#copyright" id="id9" name="id9">Copyright</a></li>
306 </ul>
307 </div>
308 <div class="section">
309 <h1><a class="toc-backref" href="#id4" id="abstract" name="abstract">Abstract</a></h1>
310 <p>This GLEP is a replacement of the keywording scheme from GLEP 22
311 <a class="footnote-reference" href="#glep22" id="id1" name="id1">[1]</a>. The current use of keywords is retained in favour of
312 4-tuple keywords. This GLEP defines how current keywords are to be
313 interpreted, and how future keywords should be constructed.</p>
314 </div>
315 <div class="section">
316 <h1><a class="toc-backref" href="#id5" id="motivation" name="motivation">Motivation</a></h1>
317 <p>Although the state of GLEP 22 <a class="footnote-reference" href="#glep22" id="id2" name="id2">[1]</a> is final, its keywording scheme
318 was never propagated through the tree. In fact, 4-tuple keywords are
319 not used at all. This GLEP defines a keywording scheme that is
320 compatible with the scheme that is currently in use.</p>
321 </div>
322 <div class="section">
323 <h1><a class="toc-backref" href="#id6" id="rationale" name="rationale">Rationale</a></h1>
324 <p>The Gentoo/Alt project deals with different Operating Systems and
325 architectures. Recently Gentoo/FreeBSD for Sparc was introduced after
326 support for x86 platforms. This yielded in another new keyword.
327 For these kind of platforms, a single field keyword is not enough to
328 properly describe the OS and architecture. While four fields in a
329 keyword are overkill, two fields in a keyword should be enough for
330 everyone.</p>
331 </div>
332 <div class="section">
333 <h1><a class="toc-backref" href="#id7" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
334 <p>The proposed keywording scheme is fully compatible with the current
335 situation of the portage tree, this in contrast to GLEP 22. The
336 variables provided by GLEP 22 can't be extracted from the new keyword,
337 but since GLEP 22-style keywords aren't in the tree at the moment, that
338 is not a problem. The same information can be extracted from the
339 <tt class="docutils literal"><span class="pre">CHOST</span></tt> variable, if necessary. No modifications to ebuilds will have
340 to be made.</p>
341 </div>
342 <div class="section">
343 <h1><a class="toc-backref" href="#id8" id="specification" name="specification">Specification</a></h1>
344 <p>Keywords will consist out of two parts separated by a hyphen (<tt class="docutils literal"><span class="pre">-</span></tt>).
345 The left hand part of the keyword is the architecture, such as <cite>x86</cite>,
346 <cite>sparc</cite> or <cite>ppc</cite>. The right hand part indicates the operating system or
347 distribution, such as <cite>linux</cite>, <cite>macos</cite>, <cite>solaris</cite> or <cite>fbsd</cite>. If the
348 right hand part is omitted, it implies the operating system/distribution
349 type is GNU/Linux. In such case the hyphen is also omitted. Examples
350 of such keywords are <tt class="docutils literal"><span class="pre">x86</span></tt> and <tt class="docutils literal"><span class="pre">sparc-fbsd</span></tt>. This is fully
351 compatible with the current keywords used in the tree. Examples of
352 OS/distributions for the right hand side of the keyword are:</p>
353 <pre class="literal-block">
354 (linux) GNU/Linux (Gentoo biased, but not fixed)
355 fbsd FreeBSD
356 macos Apple Mac OS
357 solaris Sun Solaris
358 </pre>
359 <p>Both architecture as well as OS/distribution are lower-case ASCII
360 (alpha) numeric character sequences. A valid keyword matches the
361 following expression:</p>
362 <blockquote>
363 <tt class="docutils literal"><span class="pre">[a-z0-9]+(-[a-z0-9]+)?</span></tt></blockquote>
364 <p>Note that no limit on the length of both fields in the keyword are
365 imposed. However, we cannot overemphasize our preference to keep
366 keywords small and sensible.</p>
367 <table class="docutils footnote" frame="void" id="glep22" rules="none">
368 <colgroup><col class="label" /><col /></colgroup>
369 <tbody valign="top">
370 <tr><td class="label"><a name="glep22">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>)</em> GLEP 22, New &quot;keyword&quot; system to incorporate various
371 userlands/kernels/archs, Goodyear,
372 (<a class="reference" href="http://glep.gentoo.org/glep-0022.html">http://glep.gentoo.org/glep-0022.html</a>)</td></tr>
373 </tbody>
374 </table>
375 </div>
376 <div class="section">
377 <h1><a class="toc-backref" href="#id9" id="copyright" name="copyright">Copyright</a></h1>
378 <p>This document has been placed in the public domain.</p>
379 </div>
380
381 </div>
382 <div class="footer">
383 <hr class="footer" />
384 <a class="reference" href="glep-0053.txt">View document source</a>.
385 Generated on: 2007-08-12 08:33 UTC.
386 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.
387
388 </div>
389 </body>
390 </html>

  ViewVC Help
Powered by ViewVC 1.1.20