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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.2 - (show annotations) (download) (as text)
Sun Oct 14 14:12:09 2007 UTC (10 years, 8 months ago) by antarus
Branch: MAIN
Changes since 1.1: +4 -251 lines
File MIME type: text/html
use glep 53 as a canary for new html changes.

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">
5 <head>
6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
8 <title>GLEP 53 -- Keywording scheme</title>
9 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
10 </head>
11 <body bgcolor="white">
12 <table class="navigation" cellpadding="0" cellspacing="0"
13 width="100%" border="0">
14 <tr><td class="navicon" width="150" height="35">
15 <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
16 <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
17 border="0" width="150" height="35" /></a></td>
18 <td class="textlinks" align="left">
19 [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
20 [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
21 [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0053.txt">GLEP Source</a></b>]
22 </td></tr></table>
23 <table class="rfc2822 docutils field-list" frame="void" rules="none">
24 <col class="field-name" />
25 <col class="field-body" />
26 <tbody valign="top">
27 <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">53</td>
28 </tr>
29 <tr class="field"><th class="field-name">Title:</th><td class="field-body">Keywording scheme</td>
30 </tr>
31 <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td>
32 </tr>
33 <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>
34 </tr>
35 <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>
36 </tr>
37 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td>
38 </tr>
39 <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
40 </tr>
41 <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>
42 </tr>
43 <tr class="field"><th class="field-name">Created:</th><td class="field-body">11-Dec-2005</td>
44 </tr>
45 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">13-Apr-2007</td>
46 </tr>
47 </tbody>
48 </table>
49 <hr />
50 <div class="contents topic">
51 <p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
52 <ul class="simple">
53 <li><a class="reference" href="#abstract" id="id4" name="id4">Abstract</a></li>
54 <li><a class="reference" href="#motivation" id="id5" name="id5">Motivation</a></li>
55 <li><a class="reference" href="#rationale" id="id6" name="id6">Rationale</a></li>
56 <li><a class="reference" href="#backwards-compatibility" id="id7" name="id7">Backwards Compatibility</a></li>
57 <li><a class="reference" href="#specification" id="id8" name="id8">Specification</a></li>
58 <li><a class="reference" href="#copyright" id="id9" name="id9">Copyright</a></li>
59 </ul>
60 </div>
61 <div class="section">
62 <h1><a class="toc-backref" href="#id4" id="abstract" name="abstract">Abstract</a></h1>
63 <p>This GLEP is a replacement of the keywording scheme from GLEP 22
64 <a class="footnote-reference" href="#glep22" id="id1" name="id1">[1]</a>. The current use of keywords is retained in favour of
65 4-tuple keywords. This GLEP defines how current keywords are to be
66 interpreted, and how future keywords should be constructed.</p>
67 </div>
68 <div class="section">
69 <h1><a class="toc-backref" href="#id5" id="motivation" name="motivation">Motivation</a></h1>
70 <p>Although the state of GLEP 22 <a class="footnote-reference" href="#glep22" id="id2" name="id2">[1]</a> is final, its keywording scheme
71 was never propagated through the tree. In fact, 4-tuple keywords are
72 not used at all. This GLEP defines a keywording scheme that is
73 compatible with the scheme that is currently in use.</p>
74 </div>
75 <div class="section">
76 <h1><a class="toc-backref" href="#id6" id="rationale" name="rationale">Rationale</a></h1>
77 <p>The Gentoo/Alt project deals with different Operating Systems and
78 architectures. Recently Gentoo/FreeBSD for Sparc was introduced after
79 support for x86 platforms. This yielded in another new keyword.
80 For these kind of platforms, a single field keyword is not enough to
81 properly describe the OS and architecture. While four fields in a
82 keyword are overkill, two fields in a keyword should be enough for
83 everyone.</p>
84 </div>
85 <div class="section">
86 <h1><a class="toc-backref" href="#id7" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
87 <p>The proposed keywording scheme is fully compatible with the current
88 situation of the portage tree, this in contrast to GLEP 22. The
89 variables provided by GLEP 22 can't be extracted from the new keyword,
90 but since GLEP 22-style keywords aren't in the tree at the moment, that
91 is not a problem. The same information can be extracted from the
92 <tt class="docutils literal"><span class="pre">CHOST</span></tt> variable, if necessary. No modifications to ebuilds will have
93 to be made.</p>
94 </div>
95 <div class="section">
96 <h1><a class="toc-backref" href="#id8" id="specification" name="specification">Specification</a></h1>
97 <p>Keywords will consist out of two parts separated by a hyphen (<tt class="docutils literal"><span class="pre">-</span></tt>).
98 The left hand part of the keyword is the architecture, such as <cite>x86</cite>,
99 <cite>sparc</cite> or <cite>ppc</cite>. The right hand part indicates the operating system or
100 distribution, such as <cite>linux</cite>, <cite>macos</cite>, <cite>solaris</cite> or <cite>fbsd</cite>. If the
101 right hand part is omitted, it implies the operating system/distribution
102 type is GNU/Linux. In such case the hyphen is also omitted. Examples
103 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
104 compatible with the current keywords used in the tree. Examples of
105 OS/distributions for the right hand side of the keyword are:</p>
106 <pre class="literal-block">
107 (linux) GNU/Linux (Gentoo biased, but not fixed)
108 fbsd FreeBSD
109 macos Apple Mac OS
110 solaris Sun Solaris
111 </pre>
112 <p>Both architecture as well as OS/distribution are lower-case ASCII
113 (alpha) numeric character sequences. A valid keyword matches the
114 following expression:</p>
115 <blockquote>
116 <tt class="docutils literal"><span class="pre">[a-z0-9]+(-[a-z0-9]+)?</span></tt></blockquote>
117 <p>Note that no limit on the length of both fields in the keyword are
118 imposed. However, we cannot overemphasize our preference to keep
119 keywords small and sensible.</p>
120 <table class="docutils footnote" frame="void" id="glep22" rules="none">
121 <colgroup><col class="label" /><col /></colgroup>
122 <tbody valign="top">
123 <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
124 userlands/kernels/archs, Goodyear,
125 (<a class="reference" href="http://glep.gentoo.org/glep-0022.html">http://glep.gentoo.org/glep-0022.html</a>)</td></tr>
126 </tbody>
127 </table>
128 </div>
129 <div class="section">
130 <h1><a class="toc-backref" href="#id9" id="copyright" name="copyright">Copyright</a></h1>
131 <p>This document has been placed in the public domain.</p>
132 </div>
134 </div>
135 <div class="footer">
136 <hr class="footer" />
137 <a class="reference" href="glep-0053.txt">View document source</a>.
138 Generated on: 2007-10-13 13:39 UTC.
139 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.
141 </div>
142 </body>
143 </html>

  ViewVC Help
Powered by ViewVC 1.1.20