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

Diff of /xml/htdocs/proj/en/glep/glep-0042.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.2 Revision 1.14
6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links 6PEP, see http://www.python.org/peps/pep-0001.html for instructions and links
7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! 7to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE!
8--> 8-->
9<head> 9<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.9: http://docutils.sourceforge.net/" /> 11 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 42 -- Critical News Reporting</title> 12 <title>GLEP 42 -- Critical News Reporting</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 13 <style type="text/css">
14
15/*
16:Author: David Goodger
17:Contact: goodger@users.sourceforge.net
18:date: $Date: 2006/09/05 20:36:38 $
19:version: $Revision: 1.14 $
20:copyright: This stylesheet has been placed in the public domain.
21
22Default 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
66a.toc-backref {
67 text-decoration: none ;
68 color: black }
69
70body {
71 margin: 0px ;
72 margin-bottom: 1em ;
73 padding: 0px }
74
75dd {
76 margin-bottom: 0.5em }
77
78div.section {
79 margin-left: 1em ;
80 margin-right: 1em ;
81 margin-bottom: 1.5em }
82
83div.section div.section {
84 margin-left: 0em ;
85 margin-right: 0em ;
86 margin-top: 1.5em }
87
88div.abstract {
89 margin: 2em 5em }
90
91div.abstract p.topic-title {
92 font-weight: bold ;
93 text-align: center }
94
95div.attention, div.caution, div.danger, div.error, div.hint,
96div.important, div.note, div.tip, div.warning {
97 margin: 2em ;
98 border: medium outset ;
99 padding: 1em }
100
101div.attention p.admonition-title, div.caution p.admonition-title,
102div.danger p.admonition-title, div.error p.admonition-title,
103div.warning p.admonition-title {
104 color: red ;
105 font-weight: bold ;
106 font-family: sans-serif }
107
108div.hint p.admonition-title, div.important p.admonition-title,
109div.note p.admonition-title, div.tip p.admonition-title {
110 font-weight: bold ;
111 font-family: sans-serif }
112
113div.figure {
114 margin-left: 2em }
115
116div.footer, div.header {
117 font-size: smaller }
118
119div.footer {
120 margin-left: 1em ;
121 margin-right: 1em }
122
123div.system-messages {
124 margin: 5em }
125
126div.system-messages h1 {
127 color: red }
128
129div.system-message {
130 border: medium outset ;
131 padding: 1em }
132
133div.system-message p.system-message-title {
134 color: red ;
135 font-weight: bold }
136
137div.topic {
138 margin: 2em }
139
140h1 {
141 font-family: sans-serif ;
142 font-size: large }
143
144h2 {
145 font-family: sans-serif ;
146 font-size: medium }
147
148h3 {
149 font-family: sans-serif ;
150 font-size: small }
151
152h4 {
153 font-family: sans-serif ;
154 font-style: italic ;
155 font-size: small }
156
157h5 {
158 font-family: sans-serif;
159 font-size: x-small }
160
161h6 {
162 font-family: sans-serif;
163 font-style: italic ;
164 font-size: x-small }
165
166.section hr {
167 width: 75% }
168
169ol.simple, ul.simple {
170 margin-bottom: 1em }
171
172ol.arabic {
173 list-style: decimal }
174
175ol.loweralpha {
176 list-style: lower-alpha }
177
178ol.upperalpha {
179 list-style: upper-alpha }
180
181ol.lowerroman {
182 list-style: lower-roman }
183
184ol.upperroman {
185 list-style: upper-roman }
186
187p.caption {
188 font-style: italic }
189
190p.credits {
191 font-style: italic ;
192 font-size: smaller }
193
194p.label {
195 white-space: nowrap }
196
197p.topic-title {
198 font-family: sans-serif ;
199 font-weight: bold }
200
201pre.line-block {
202 font-family: serif ;
203 font-size: 100% }
204
205pre.literal-block, pre.doctest-block {
206 margin-left: 2em ;
207 margin-right: 2em ;
208 background-color: #eeeeee }
209
210span.classifier {
211 font-family: sans-serif ;
212 font-style: oblique }
213
214span.classifier-delimiter {
215 font-family: sans-serif ;
216 font-weight: bold }
217
218span.interpreted {
219 font-family: sans-serif }
220
221span.option-argument {
222 font-style: italic }
223
224span.pre {
225 white-space: pre }
226
227span.problematic {
228 color: red }
229
230table {
231 margin-top: 0.5em ;
232 margin-bottom: 0.5em }
233
234td, th {
235 padding-left: 0.5em ;
236 padding-right: 0.5em ;
237 vertical-align: top }
238
239td.num {
240 text-align: right }
241
242th.field-name {
243 font-weight: bold ;
244 text-align: left ;
245 white-space: nowrap }
246
247h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
248 font-size: 100% }
249
250tt {
251 background-color: #eeeeee }
252
253ul.auto-toc {
254 list-style-type: none }
255
256</style>
14</head> 257</head>
15<body bgcolor="white"> 258<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 259<table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0"> 260 width="100%" border="0">
18<tr><td class="navicon" width="150" height="35"> 261<tr><td class="navicon" width="150" height="35">
19<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> 262<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" 263<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td> 264 border="0" width="150" height="35" /></a></td>
22<td class="textlinks" align="left"> 265<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 266[<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>] 267[<b><a href="http://www.gentoo.org/peps">GLEP Index</a></b>]
25[<b><a href="./glep-0042.txt">GLEP Source</a></b>] 268[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0042.txt">GLEP Source</a></b>]
26</td></tr></table> 269</td></tr></table>
27<table class="rfc2822 docutils field-list" frame="void" rules="none"> 270<table class="rfc2822 docutils field-list" frame="void" rules="none">
28<col class="field-name" /> 271<col class="field-name" />
29<col class="field-body" /> 272<col class="field-body" />
30<tbody valign="top"> 273<tbody valign="top">
31<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td> 274<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td>
32</tr> 275</tr>
33<tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td> 276<tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td>
34</tr> 277</tr>
35<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.1</td> 278<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.11</td>
36</tr> 279</tr>
37<tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh &lt;ciaranm&#32;&#97;t&#32;gentoo.org&gt;</td> 280<tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh &lt;ciaranm&#32;&#97;t&#32;gentoo.org&gt;,
281Stephen Bennett &lt;spb&#32;&#97;t&#32;gentoo.org&gt;,
282Zach Medico &lt;zmedico&#32;&#97;t&#32;gentoo.org&gt;</td>
38</tr> 283</tr>
39<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-0042.txt?cvsroot=gentoo">2005/11/05 03:32:09</a></td> 284<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-0042.txt?cvsroot=gentoo">2006/09/05 20:33:04</a></td>
40</tr> 285</tr>
41<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 286<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
42</tr> 287</tr>
43<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 288<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
44</tr> 289</tr>
45<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="http://www.python.org/peps/glep-0012.html">text/x-rst</a></td> 290<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>
46</tr> 291</tr>
47<tr class="field"><th class="field-name">Created:</th><td class="field-body">31-October-2005</td> 292<tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td>
48</tr> 293</tr>
49<tr class="field"><th class="field-name">Post-Date:</th><td class="field-body">1-November-2005, 5-November-2005</td> 294<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005, 18-Dec-2005, 5-Jan-2006, 2-Mar-2006, 6-Mar-2006, 12-Jun-2006, 5-Sep-2006</td>
50</tr> 295</tr>
51</tbody> 296</tbody>
52</table> 297</table>
53<hr /> 298<hr />
54<div class="contents topic" id="contents"> 299<div class="contents topic">
55<p class="topic-title first"><a name="contents">Contents</a></p> 300<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
56<ul class="simple"> 301<ul class="simple">
57<li><a class="reference" href="#abstract" id="id14" name="id14">Abstract</a></li> 302<li><a class="reference" href="#abstract" id="id22" name="id22">Abstract</a></li>
58<li><a class="reference" href="#motivation" id="id15" name="id15">Motivation</a></li> 303<li><a class="reference" href="#motivation" id="id23" name="id23">Motivation</a></li>
59<li><a class="reference" href="#requirements" id="id16" name="id16">Requirements</a></li> 304<li><a class="reference" href="#requirements" id="id24" name="id24">Requirements</a></li>
60<li><a class="reference" href="#specification" id="id17" name="id17">Specification</a><ul> 305<li><a class="reference" href="#specification" id="id25" name="id25">Specification</a><ul>
61<li><a class="reference" href="#overview" id="id18" name="id18">Overview</a></li> 306<li><a class="reference" href="#overview" id="id26" name="id26">Overview</a></li>
307<li><a class="reference" href="#required-portage-enhancements" id="id27" name="id27">Required Portage Enhancements</a></li>
308<li><a class="reference" href="#news-item-identities" id="id28" name="id28">News Item Identities</a></li>
309<li><a class="reference" href="#news-item-directories" id="id29" name="id29">News Item Directories</a></li>
62<li><a class="reference" href="#news-item-file-format" id="id19" name="id19">News Item File Format</a><ul> 310<li><a class="reference" href="#news-item-files" id="id30" name="id30">News Item Files</a><ul>
63<li><a class="reference" href="#news-item-headers" id="id20" name="id20">News Item Headers</a></li> 311<li><a class="reference" href="#news-item-headers" id="id31" name="id31">News Item Headers</a></li>
64<li><a class="reference" href="#news-item-body" id="id21" name="id21">News Item Body</a></li> 312<li><a class="reference" href="#news-item-body" id="id32" name="id32">News Item Body</a></li>
65<li><a class="reference" href="#example-news-item" id="id22" name="id22">Example News Item</a></li> 313<li><a class="reference" href="#example-news-item" id="id33" name="id33">Example News Item</a></li>
66</ul> 314</ul>
67</li> 315</li>
68<li><a class="reference" href="#news-item-quality-control" id="id23" name="id23">News Item Quality Control</a></li> 316<li><a class="reference" href="#news-item-quality-control" id="id34" name="id34">News Item Quality Control</a></li>
69<li><a class="reference" href="#news-item-distribution" id="id24" name="id24">News Item Distribution</a><ul> 317<li><a class="reference" href="#news-item-distribution" id="id35" name="id35">News Item Distribution</a><ul>
70<li><a class="reference" href="#server-side" id="id25" name="id25">Server Side</a></li> 318<li><a class="reference" href="#server-side" id="id36" name="id36">Server Side</a></li>
71<li><a class="reference" href="#client-side" id="id26" name="id26">Client Side</a></li> 319<li><a class="reference" href="#client-side" id="id37" name="id37">Client Side</a></li>
72</ul> 320</ul>
73</li> 321</li>
74<li><a class="reference" href="#news-item-clients" id="id27" name="id27">News Item Clients</a></li> 322<li><a class="reference" href="#news-item-clients" id="id38" name="id38">News Item Clients</a></li>
75<li><a class="reference" href="#news-item-removal" id="id28" name="id28">News Item Removal</a></li> 323<li><a class="reference" href="#news-item-removal" id="id39" name="id39">News Item Removal</a></li>
76</ul> 324</ul>
77</li> 325</li>
78<li><a class="reference" href="#integration-with-existing-systems" id="id29" name="id29">Integration with Existing Systems</a></li> 326<li><a class="reference" href="#integration-with-existing-systems" id="id40" name="id40">Integration with Existing Systems</a></li>
79<li><a class="reference" href="#backwards-compatibility" id="id30" name="id30">Backwards Compatibility</a></li> 327<li><a class="reference" href="#backwards-compatibility" id="id41" name="id41">Backwards Compatibility</a></li>
80<li><a class="reference" href="#reference-implementation" id="id31" name="id31">Reference Implementation</a><ul> 328<li><a class="reference" href="#reference-implementation" id="id42" name="id42">Reference Implementation</a></li>
81<li><a class="reference" href="#portage-code" id="id32" name="id32">Portage Code</a></li> 329<li><a class="reference" href="#credits" id="id43" name="id43">Credits</a></li>
82<li><a class="reference" href="#simple-eselect-news-client" id="id33" name="id33">Simple <tt class="docutils literal"><span class="pre">eselect</span></tt> News Client</a></li> 330<li><a class="reference" href="#example-files" id="id44" name="id44">Example Files</a></li>
83<li><a class="reference" href="#simple-news-to-mail-forwarder" id="id34" name="id34">Simple News to Mail Forwarder</a></li> 331<li><a class="reference" href="#references" id="id45" name="id45">References</a></li>
332<li><a class="reference" href="#copyright" id="id46" name="id46">Copyright</a></li>
84</ul> 333</ul>
85</li>
86<li><a class="reference" href="#credits" id="id35" name="id35">Credits</a></li>
87<li><a class="reference" href="#references" id="id36" name="id36">References</a></li>
88<li><a class="reference" href="#copyright" id="id37" name="id37">Copyright</a></li>
89</ul>
90</div> 334</div>
91<div class="section" id="abstract"> 335<div class="section">
92<h1><a class="toc-backref" href="#id14" name="abstract">Abstract</a></h1> 336<h1><a class="toc-backref" href="#id22" id="abstract" name="abstract">Abstract</a></h1>
93<p>This GLEP proposes a new way of informing users about important updates and news 337<p>This GLEP proposes a new way of informing users about important updates and news
94regarding tree-related items.</p> 338related to the tree.</p>
95</div> 339</div>
96<div class="section" id="motivation"> 340<div class="section">
97<h1><a class="toc-backref" href="#id15" name="motivation">Motivation</a></h1> 341<h1><a class="toc-backref" href="#id23" id="motivation" name="motivation">Motivation</a></h1>
98<p>There are currently several ways of getting news out to our users, none of them 342<p>Although most package updates are clean and require little user action,
99particularly effective:</p> 343occasionally an upgrade requires user intervention. Recent examples of the
344latter include the <tt class="docutils literal"><span class="pre">gcc-3.4</span></tt> stabilisation on <tt class="docutils literal"><span class="pre">x86</span></tt> and the <tt class="docutils literal"><span class="pre">mysql-4.1</span></tt>
345database format changes.</p>
346<p>There are currently several ways of delivering important news items to our
347users, none of them particularly effective:</p>
100<ul class="simple"> 348<ul class="simple">
101<li>Gentoo Weekly News</li> 349<li>Gentoo Weekly News</li>
102<li>The <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list</li> 350<li>The <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt>, <tt class="docutils literal"><span class="pre">gentoo-user</span></tt> and <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt> mailing lists</li>
103<li>The Gentoo Forums</li> 351<li>The Gentoo Forums</li>
104<li>The main Gentoo website</li> 352<li>The main Gentoo website</li>
105<li>RSS feeds of Gentoo news</li> 353<li>RSS feeds of Gentoo news</li>
354<li><tt class="docutils literal"><span class="pre">einfo</span></tt> and <tt class="docutils literal"><span class="pre">ewarn</span></tt> messages in <tt class="docutils literal"><span class="pre">pkg_setup</span></tt> or <tt class="docutils literal"><span class="pre">pkg_postinst</span></tt></li>
106</ul> 355</ul>
107<p>A more reliable way of getting news of critical updates out to users is required 356<p>A more reliable way of getting news of critical updates out to users is required
108to avoid repeats of the various recent upgrade debacles. This GLEP proposes a 357to avoid repeats of various prior upgrade debacles. This GLEP proposes a
109solution based around pushing news items out to the user via the <tt class="docutils literal"><span class="pre">rsync</span></tt> tree.</p> 358solution based around pushing news items out to the user via the <tt class="docutils literal"><span class="pre">rsync</span></tt> tree.</p>
359<div class="important">
360<p class="first admonition-title">Important</p>
361<p class="last">This GLEP does not seek to replace or modify <tt class="docutils literal"><span class="pre">einfo</span></tt> messages
362which are displayed post-install. That is a separate issue which is handled
363by <tt class="docutils literal"><span class="pre">elog</span></tt> <a class="footnote-reference" href="#bug-11359" id="id1" name="id1">[1]</a>.</p>
110</div> 364</div>
111<div class="section" id="requirements"> 365</div>
366<div class="section">
112<h1><a class="toc-backref" href="#id16" name="requirements">Requirements</a></h1> 367<h1><a class="toc-backref" href="#id24" id="requirements" name="requirements">Requirements</a></h1>
113<p>An adequate solution must meet all of the following requirements:</p> 368<p>An adequate solution must meet all of the following requirements:</p>
114<dl class="docutils"> 369<dl class="docutils">
115<dt>Preemptive</dt> 370<dt>Preemptive</dt>
116<dd>Users should be told of changes <em>before</em> they break the user's system, 371<dd>Users should be told of changes <em>before</em> they break a system, not after the
117not after the damage has already been done.</dd> 372damage has already been done. Ideally, the system administrator would be
373given ample warning to plan difficult upgrades and changes, rather than only
374being told just before action is necessary.</dd>
118<dt>No user subscription required</dt> 375<dt>No user subscription required</dt>
119<dd>It has already been demonstrated <a class="footnote-reference" href="#forums-whining" id="id1" name="id1">[4]</a> that many users do not 376<dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id2" name="id2">[5]</a> that many users do not
120read the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list or <tt class="docutils literal"><span class="pre">RSS</span></tt> feeds. A solution which 377read the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list or <tt class="docutils literal"><span class="pre">RSS</span></tt> feeds. A solution that
121requires subscription has no advantage over current methods.</dd> 378requires subscription has no advantage over current methods.</dd>
122<dt>No user monitoring required</dt> 379<dt>No user monitoring required</dt>
123<dd>It has already been demonstrated <a class="footnote-reference" href="#forums-whining" id="id2" name="id2">[4]</a> that many users do not 380<dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id3" name="id3">[5]</a> that many users do not
124read news items posted to the Gentoo website, or do not read news items 381read news items posted to the Gentoo website, or do not read news items
125until it is too late. A solution that relies upon active monitoring of a 382until it is too late. A solution that relies upon active monitoring of a
126particular source has no advantage over current methods.</dd> 383particular source has no advantage over current methods.</dd>
127<dt>Relevant</dt> 384<dt>Relevant</dt>
128<dd>System administrators who do not use a particular package should not have to 385<dd>System administrators who do not use a particular package should not have to
129read news items which affect purely that package. Some news items may be of 386read news items which affect purely that package. Some news items may be of
130relevance to most or all users, but those that are not should not be forced 387relevance to most or all users, but those that are not should not be forced
131upon users unnecessarily.</dd> 388upon users unnecessarily.</dd>
132<dt>Lightweight</dt> 389<dt>Lightweight</dt>
133<dd>It is not reasonable to expect all users to have an MTA, web browser, email 390<dd>It is not reasonable to expect all users to have an MTA, web browser, email
134client, cron daemon or text processing suite available on their system.</dd> 391client, cron daemon or text processing suite available on their system.
392Users must not be forced to install unreasonable extra software to be able
393to read news items.</dd>
135<dt>No privacy violations</dt> 394<dt>No privacy violations</dt>
136<dd>Users of the solution should not be required to provide information about 395<dd>Users of the solution should not be required to provide information about
137their systems (for example, IP addresses or installed packages).</dd> 396their systems (for example, IP addresses or installed packages).</dd>
138<dt>Multiple delivery method support</dt> 397<dt>Multiple delivery method support</dt>
139<dd>Some users may wish to view news items via email, some via a terminal and 398<dd>Some users may wish to view news items via email, some via a terminal and
140some via a web browser. A solution should either support all of these 399some via a web browser. A solution should either support all of these
141methods or (better still) make it trivial to write clients for displaying 400methods or (better still) make it simple to write clients for displaying
142news items in different ways.</dd> 401news items in different ways.</dd>
143</dl> 402</dl>
144<p>The following characteristics would be desirable:</p> 403<p>The following characteristics would be desirable:</p>
145<dl class="docutils"> 404<dl class="docutils">
146<dt>Internationalisable</dt> 405<dt>Internationalisable</dt>
147<dd>Being able to provide messages in multiple languages may be beneficial.</dd> 406<dd>Being able to provide messages in multiple languages may be beneficial.</dd>
148<dt>Quality control</dt> 407<dt>Quality control</dt>
149<dd>There should be some way to ensure that badly written or irrelevant messages 408<dd>There should be some way to ensure that badly written or irrelevant messages
150are not sent out, for example by inexperienced developers, those whose 409are not sent out, for example by inexperienced developers or those whose
151English language skills are below par or morons.</dd> 410English language skills are below par.</dd>
152<dt>Simple for developers</dt> 411<dt>Simple for developers</dt>
153<dd>Posting news items should be as simple as is reasonably possible.</dd> 412<dd>Posting news items should be as simple as is reasonably possible.</dd>
154<dt>Simple for users</dt> 413<dt>Simple for users</dt>
155<dd>Reading relevant news items should be as simple as is reasonably possible.</dd> 414<dd>Reading relevant news items should be as simple as is reasonably possible.</dd>
156<dt>Compatibility with existing and future news sources</dt> 415<dt>Compatibility with existing and future news sources</dt>
158sources (for example, Forums, GWN, the main Gentoo website) without 417sources (for example, Forums, GWN, the main Gentoo website) without
159excessive difficulty. Similarly, easy interoperation with any future news 418excessive difficulty. Similarly, easy interoperation with any future news
160sources should not be precluded.</dd> 419sources should not be precluded.</dd>
161</dl> 420</dl>
162</div> 421</div>
163<div class="section" id="specification"> 422<div class="section">
164<h1><a class="toc-backref" href="#id17" name="specification">Specification</a></h1> 423<h1><a class="toc-backref" href="#id25" id="specification" name="specification">Specification</a></h1>
165<div class="section" id="overview"> 424<div class="section">
166<h2><a class="toc-backref" href="#id18" name="overview">Overview</a></h2> 425<h2><a class="toc-backref" href="#id26" id="overview" name="overview">Overview</a></h2>
167<p>News items are published and delivered to users as follows:</p> 426<p>News items are published and delivered to users as follows:</p>
168<ol class="arabic simple"> 427<ol class="arabic simple">
169<li>A news item is written. The format to be used is described in 428<li>A news item is written. The format to be used is described below.</li>
170<a class="reference" href="#news-item-file-format">News Item File Format</a>.</li>
171<li>The news item is reviewed, following the process described in 429<li>The news item is reviewed, following the process described in
172<a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li> 430<a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li>
173<li>The news item is committed to a CVS (or Subversion <a class="footnote-reference" href="#glep-36" id="id3" name="id3">[8]</a>) repository. 431<li>The news item is committed to a CVS (or Subversion <a class="footnote-reference" href="#glep-36" id="id4" name="id4">[9]</a>) repository.
174From here, it is merged with the rsync tree. This is described in <a class="reference" href="#news-item-distribution">News Item 432From here, it is merged with the rsync tree. This is described in <a class="reference" href="#news-item-distribution">News Item
175Distribution</a>.</li> 433Distribution</a>.</li>
176<li>The news item is merged with the rsync tree. Implementation details of this
177point are beyond the scope of this GLEP; existing solutions are in place
178for merging GLSAs to the tree.</li>
179<li>Users fetch the news item when they sync. This ensures that the news items in 434<li>Users fetch the news item when they sync. This ensures that the news items in
180question are pushed to the user before the user accidentally makes an 435question are pushed to the user before the user accidentally makes an
181unwanted change. No changes to the existing rsync process are required by 436unwanted change. No changes to the existing rsync process are required by
182this GLEP.</li> 437this GLEP.</li>
183<li>Portage filters the news item and, if it is relevant, installs it in a 438<li>The package manager filters the news item and, if it is relevant, marks the
184special location to be read by a news item reader. Messages are also 439news item for reading. The package manager should also display a notice
185displayed to inform the user that news is available.</li> 440informing the user that there are unread news items.</li>
186<li>The news item is handled by the user's choice of news item reader. See <a class="reference" href="#news-item-clients">News 441<li>The news item is handled by the user's choice of news item reader. See <a class="reference" href="#news-item-clients">News
187Item Clients</a>.</li> 442Item Clients</a>.</li>
188</ol> 443</ol>
189</div> 444</div>
190<div class="section" id="news-item-file-format"> 445<div class="section">
446<h2><a class="toc-backref" href="#id27" id="required-portage-enhancements" name="required-portage-enhancements">Required Portage Enhancements</a></h2>
447<p>The following extensions to Portage are required:</p>
448<ul class="simple">
449<li>Every repository (including overlays) will require a unique identifier. It is
450assumed that an identifier will be a string consisting of characters from
451<tt class="docutils literal"><span class="pre">a</span></tt> to <tt class="docutils literal"><span class="pre">z</span></tt>, <tt class="docutils literal"><span class="pre">A</span></tt> to <tt class="docutils literal"><span class="pre">Z</span></tt>, <tt class="docutils literal"><span class="pre">0</span></tt> to <tt class="docutils literal"><span class="pre">9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen)
452<tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</li>
453<li>Portage must provide a way for external programs to obtain a list of all
454repository identifiers for a given system. It is assumed that this will be in
455the form of a <tt class="docutils literal"><span class="pre">portageq</span></tt> command (e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">get_repo_ids</span></tt>).</li>
456<li>Portage must provide a way for external programs to obtain the base path for
457a repository with a given ID. It is assumed that this will be in the form of
458a <tt class="docutils literal"><span class="pre">portageq</span></tt> command (e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">get_repo_root</span> <span class="pre">gentoo-x86</span></tt>).</li>
459<li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">has_version</span></tt> to support restrictions to a
460given repository ID.</li>
461<li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span></tt> to implement a command which returns whether
462or not the profile used for a given repository ID is exactly the given profile
463(e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">profile_used</span> <span class="pre">default-linux/sparc/sparc64/2004.3</span>
464<span class="pre">gentoo-x86</span></tt>).</li>
465</ul>
466<p>These extensions are assumed during the following specification.</p>
467</div>
468<div class="section">
469<h2><a class="toc-backref" href="#id28" id="news-item-identities" name="news-item-identities">News Item Identities</a></h2>
470<p>Each news item will have a unique identifier. This identifier will be in the
471form <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name</span></tt>, where <tt class="docutils literal"><span class="pre">yyyy</span></tt> is the year (e.g. <tt class="docutils literal"><span class="pre">2005</span></tt>),
472<tt class="docutils literal"><span class="pre">mm</span></tt> is the month (<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">12</span></tt>) and dd is the day of the month
473(<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">31</span></tt>). The <tt class="docutils literal"><span class="pre">short-name</span></tt> is a very short name describing the
474news item (e.g. <tt class="docutils literal"><span class="pre">yoursql-updates</span></tt>), consisting only of the characters <tt class="docutils literal"><span class="pre">a-z</span></tt>,
475<tt class="docutils literal"><span class="pre">0-9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen) and <tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</p>
476</div>
477<div class="section">
478<h2><a class="toc-backref" href="#id29" id="news-item-directories" name="news-item-directories">News Item Directories</a></h2>
479<p>Each news item will be represented by a directory whose name is the same as the
480news item's identifier.</p>
481<p>The directory will contain a file named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.en.txt</span></tt>, which
482contains the text of the news item, in English, in the format described below.</p>
483<p>If a news item is translated, other files named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.xx.txt</span></tt>
484(where <tt class="docutils literal"><span class="pre">xx</span></tt> is the ISO 639 <a class="footnote-reference" href="#iso-639" id="id5" name="id5">[11]</a> two letter country code, and the date
485remains the same as the original news item) will also be provided. However, only
486the English version of a news item is authoritative. This anglocentricity is
487justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p>
488</div>
489<div class="section">
191<h2><a class="toc-backref" href="#id19" name="news-item-file-format">News Item File Format</a></h2> 490<h2><a class="toc-backref" href="#id30" id="news-item-files" name="news-item-files">News Item Files</a></h2>
192<p>Each news item will be represented by a single text file. This file will be 491<p>A news item file is a text file, encoded using UTF-8 <a class="footnote-reference" href="#rfc-3629" id="id7" name="id7">[14]</a> for
193encoded using UTF-8 for compatibility with and for the same reason as existing 492compatibility with and for the same reasons as existing Gentoo documentation
194Gentoo documentation <a class="footnote-reference" href="#docs-policy" id="id4" name="id4">[1]</a> and tree <a class="footnote-reference" href="#glep-31" id="id5" name="id5">[6]</a> practices.</p> 493<a class="footnote-reference" href="#docs-policy" id="id8" name="id8">[2]</a> and the tree <a class="footnote-reference" href="#glep-31" id="id9" name="id9">[7]</a>.</p>
195<p>The news item will be named in the form <tt class="docutils literal"><span class="pre">yyyy-mm-dd-item-name.en.txt</span></tt>, where 494<p>News items must be signed with a detached GPG signature.:</p>
196<tt class="docutils literal"><span class="pre">item-name</span></tt> is a very short name (e.g. <tt class="docutils literal"><span class="pre">apache-updates</span></tt>) and <tt class="docutils literal"><span class="pre">en</span></tt> is the 495<pre class="literal-block">
197two letter ISO 639 <a class="footnote-reference" href="#iso-639" id="id6" name="id6">[9]</a> language code for the news item. The short name 496gpg --armour --detach-sign ????-??-??-*.??.txt
198must consist only of characters <tt class="docutils literal"><span class="pre">a-z</span></tt>, <tt class="docutils literal"><span class="pre">A-Z</span></tt>, <tt class="docutils literal"><span class="pre">0-9</span></tt> and <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen).</p> 497</pre>
199<p>News items may be signed using GPG. If this is done, a detached signature should 498<p>This GLEP does not specify the type or strength of signature to be used, nor
200be used.</p> 499does it discuss how, if at all, a centralised keychain will be provided. These
201<p>The directory and file name rules are designed specifically to allow easy 500issues should be handled as part of the signing policy discussions.</p>
202sorting by date.</p>
203<p>An English (<tt class="docutils literal"><span class="pre">en</span></tt>) version must be available for all news items. Other
204languages may be provided either by the original author or by other translators
205who have commit access. This anglocentricity is justified on the grounds that
206nobody objected to it with GLEP 34 <a class="footnote-reference" href="#glep-34" id="id7" name="id7">[7]</a>.</p>
207<p>A news item's content will consist of an <a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> <a class="footnote-reference" href="#rfc-822" id="id8" name="id8">[11]</a> style header 501<p>A news item file's content will consist of an <a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> style header <a class="footnote-reference" href="#rfc-822" id="id10" name="id10">[13]</a>
208followed by the main body of the message as plain text. This GLEP defines 502followed by the main body of the message as plain text. This GLEP defines
209various optional and mandatory headers. Future GLEPs may propose new headers -- 503various optional and mandatory headers. Future GLEPs may propose new headers
210tools handling these news items must ignore any unrecognised header.</p> 504tools handling these news items must ignore any unrecognised header.</p>
211<div class="section" id="news-item-headers"> 505<div class="section">
212<h3><a class="toc-backref" href="#id20" name="news-item-headers">News Item Headers</a></h3> 506<h3><a class="toc-backref" href="#id31" id="news-item-headers" name="news-item-headers">News Item Headers</a></h3>
213<p>The following headers describe the purpose and format of the news item:</p> 507<p>The following headers describe the purpose and format of the news item:</p>
214<dl class="docutils"> 508<dl class="docutils">
215<dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt> 509<dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt>
216<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd> 510<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd>
217<dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt> 511<dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt>
218<dd>Author's name and email address, in the form <tt class="docutils literal"><span class="pre">Real</span> <span class="pre">Name</span> <span class="pre">&lt;email&#64;address&gt;</span></tt>. 512<dd>Author's name and email address, in the form <tt class="docutils literal"><span class="pre">Real</span> <span class="pre">Name</span> <span class="pre">&lt;email&#64;address&gt;</span></tt>.
219Mandatory, multiple author fields may be specified if appropriate.</dd> 513Mandatory; multiple author headers may be specified if appropriate.</dd>
220<dt><tt class="docutils literal"><span class="pre">Translator:</span></tt></dt> 514<dt><tt class="docutils literal"><span class="pre">Translator:</span></tt></dt>
221<dd>For translated news items, the translator's name and email address.</dd> 515<dd>For translated news items, the translator's name and email address. Multiple
516translator headers may be specified if appropriate.</dd>
222<dt><tt class="docutils literal"><span class="pre">Content-Type:</span></tt></dt> 517<dt><tt class="docutils literal"><span class="pre">Content-Type:</span></tt></dt>
223<dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd> 518<dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd>
224<dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt> 519<dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt>
225<dd>Date of posting, in <tt class="docutils literal"><span class="pre">dd-mmm-yyyy</span></tt> format (e.g. 14-Aug-2001). UTC time in 520<dd>Date of posting, in <tt class="docutils literal"><span class="pre">yyyy-mm-dd</span></tt> format (e.g. 2005-12-18) for
226<tt class="docutils literal"><span class="pre">hh-mm-ss</span> <span class="pre">+0000</span></tt> format may also be included. This field is mandatory.</dd> 521compatibility with GLEP 45 <a class="footnote-reference" href="#glep-45" id="id11" name="id11">[10]</a>. Translations should use the date
522of the original news item. Mandatory.</dd>
227<dt><tt class="docutils literal"><span class="pre">Version:</span></tt></dt> 523<dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt>
228<dd>Initially 1. Incremented every time a non-trivial change is made. Changes 524<dd>Initially 1. Should be incremented every time a change is made to the news
229which require a re-read of the news item should instead use a new news item 525item. Changes that require a re-read of the news item (i.e., most changes
230file.</dd> 526that are not spelling or formatting related) should instead use a new news
527item. Mandatory.</dd>
231<dt><tt class="docutils literal"><span class="pre">News-Item-Format:</span></tt></dt> 528<dt><tt class="docutils literal"><span class="pre">News-Item-Format:</span></tt></dt>
232<dd>Must be <tt class="docutils literal"><span class="pre">1.0</span></tt>. Future revisions to the format may increment the minor 529<dd>Must be <tt class="docutils literal"><span class="pre">1.0</span></tt>. Future revisions to the format may increment the minor
233number for backwards-compatible changes, or the major number for major 530number for backwards-compatible changes, or the major number for major
234changes.</dd> 531changes.</dd>
235</dl> 532</dl>
236<p>The following headers are used for filtering. If none of these headers are 533<p>The following headers are used for filtering:</p>
237specified, the news item is displayed for all users. Otherwise, the news item is
238displayed if <em>at least one</em> header matches.</p>
239<dl class="docutils"> 534<dl class="docutils">
240<dt><tt class="docutils literal"><span class="pre">Display-If-Installed:</span></tt></dt> 535<dt><tt class="docutils literal"><span class="pre">Display-If-Installed:</span></tt></dt>
241<dd>A dependency atom or simple package name (for example, 536<dd>A dependency atom (for example, <tt class="docutils literal"><span class="pre">&lt;dev-lang/php-5_alpha</span></tt> or
242<tt class="docutils literal"><span class="pre">&lt;dev-lang/php-5_alpha</span></tt> or <tt class="docutils literal"><span class="pre">net-www/apache</span></tt>). If the user has the 537<tt class="docutils literal"><span class="pre">net-www/apache</span></tt>). If the user has the package specified installed from
243package specified installed, the news item should be displayed.</dd> 538the repository from which the news item was obtained, the news item should
539be displayed.</dd>
244<dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt> 540<dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt>
245<dd>A keyword <a class="footnote-reference" href="#glep-22" id="id9" name="id9">[5]</a> name, for example <tt class="docutils literal"><span class="pre">mips</span></tt>. If the user is on the arch 541<dd>A keyword <a class="footnote-reference" href="#glep-22" id="id12" name="id12">[6]</a> name, for example <tt class="docutils literal"><span class="pre">mips</span></tt> or <tt class="docutils literal"><span class="pre">x86-fbsd</span></tt>. If the
246in question, the news item should be displayed.</dd> 542user is on the keyword in question, the news item should be displayed.</dd>
247<dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt> 543<dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt>
248<dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. If the 544<dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. If the
249user is using the exact profile in question, the news item should be 545user is using the exact profile in question, the news item should be
250displayed. This header may be used to replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the 546displayed. This header may be used to replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the
251future.</dd> 547future.</dd>
252</dl> 548</dl>
549<div class="note">
550<p class="first admonition-title">Note</p>
551<p class="last">When performing package moves, developers must also update any
552relevant <tt class="docutils literal"><span class="pre">Display-If-Installed</span></tt> headers in news files.</p>
253</div> 553</div>
254<div class="section" id="news-item-body"> 554<p>The algorithm used to determine whether a news item is 'relevant' is as
555follows:</p>
556<ul class="simple">
557<li>For each <tt class="docutils literal"><span class="pre">Display-If-</span></tt> header type which occurs at least once:<ul>
558<li>The news item is not relevant if none of the headers of this type are
559successfully matched.</li>
560</ul>
561</li>
562<li>Otherwise the news item is relevant.</li>
563</ul>
564<p>In particular, if no <tt class="docutils literal"><span class="pre">Display-If-</span></tt> header is specified, a news item will be
565relevant for all users.</p>
566<p>This algorithm was chosen because it makes conditions like &quot;display this news
567item for <tt class="docutils literal"><span class="pre">YourSQL</span></tt> users who are on <tt class="docutils literal"><span class="pre">sparc</span></tt> or <tt class="docutils literal"><span class="pre">x86-obsd</span></tt> relatively
568simple to specify — it is believed that these kinds of condition are far more
569likely to occur than &quot;display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or
570for people on <tt class="docutils literal"><span class="pre">sparc</span></tt> or <tt class="docutils literal"><span class="pre">x86-obsd</span></tt>&quot; or &quot;display these news items for
571people who use <tt class="docutils literal"><span class="pre">YourSQL</span></tt> and who are on both <tt class="docutils literal"><span class="pre">sparc</span></tt> and <tt class="docutils literal"><span class="pre">x86-obsd</span></tt>&quot;.</p>
572</div>
573<div class="section">
255<h3><a class="toc-backref" href="#id21" name="news-item-body">News Item Body</a></h3> 574<h3><a class="toc-backref" href="#id32" id="news-item-body" name="news-item-body">News Item Body</a></h3>
256<p>The header section must be followed by a blank line, then the main body of the 575<p>The header section must be followed by a blank line, then the main body of the
257text.</p> 576text.</p>
258<p>The text body should be wrapped at 72 characters. No fancy formatting or tab 577<p>The text body should be wrapped at 72 characters. No fancy formatting or tab
259characters should be used -- the news item may be being displayed directly to a 578characters should be used the news item may be being displayed directly to a
260terminal. Paragraphs should be separated by a blank line.</p> 579terminal. Paragraphs should be separated by a blank line.</p>
261<p>Hyperlinks may be used to refer to further information (for example, an upgrade 580<p>Hyperlinks may be used to refer to further information (for example, an upgrade
262guide). However, the main body of the news item should be descriptive and not 581guide). However, the main body of the news item should be descriptive and not
263simply a &quot;read this link&quot; text. It is assumed that the user will have access to 582simply a &quot;read this link&quot; text. It is assumed that the user will have access to
264a web browser <em>somewhere</em>, but not necessarily on the box which is being 583a web browser <em>somewhere</em>, but not necessarily on the box which is being
265administrated -- this will be the case on may servers and routers, for example.</p> 584administrated this will be the case on many servers and routers, for example.</p>
266</div> 585</div>
267<div class="section" id="example-news-item"> 586<div class="section">
268<h3><a class="toc-backref" href="#id22" name="example-news-item">Example News Item</a></h3> 587<h3><a class="toc-backref" href="#id33" id="example-news-item" name="example-news-item">Example News Item</a></h3>
269<p>The following hypothetical news item could be used for an upgrade to the 588<p><a class="reference" href="glep-0042-extras/example-news-item.txt">This hypothetical news item</a> <a class="footnote-reference" href="#id20" id="id21" name="id21">[18]</a> could be used for an upgrade to the
270<tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility. It should be 589<tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p>
271named <tt class="docutils literal"><span class="pre">2005-11/2005-11-01-yoursql-upgrades.en.txt</span></tt>.</p>
272<pre class="literal-block">
273Title: YourSQL Upgrades from 4.0 to 4.1
274Author: Ciaran McCreesh &lt;ciaranm&#64;gentoo.org&gt;
275Content-Type: text/plain
276Posted: 01-Nov-2005
277Display-If-Installed: &lt;dev-db/yoursql-4.1_alpha
278
279YourSQL databases created using YourSQL version 4.0 are incompatible
280with YourSQL version 4.1 or later. There is no reliable way to
281automate the database format conversion, so action from the system
282administrator is required before an upgrade can take place.
283
284Please see the Gentoo YourSQL Upgrade Guide for instructions:
285
286 http://www.gentoo.org/doc/en/yoursql-upgrading.xml
287
288Also see the official YourSQL documentation:
289
290 http://dev.yoursql.com/doc/refman/4.1/en/upgrading-from-4-0.html
291
292After upgrading, you should also recompile any packages which link
293against YourSQL:
294
295 revdep-rebuild --library=libyoursqlclient.so.12
296
297The revdep-rebuild tool is provided by app-portage/gentoolkit.
298</pre>
299</div> 590</div>
300</div> 591</div>
301<div class="section" id="news-item-quality-control"> 592<div class="section">
302<h2><a class="toc-backref" href="#id23" name="news-item-quality-control">News Item Quality Control</a></h2> 593<h2><a class="toc-backref" href="#id34" id="news-item-quality-control" name="news-item-quality-control">News Item Quality Control</a></h2>
303<p>There have been complaints regarding the comprehensibility of some upgrade 594<p>There have been complaints regarding the comprehensibility of some upgrade
304notices and news items in the past. This is understandable -- not every Gentoo 595notices and news items in the past. This is understandable not every Gentoo
305developer speaks English as a first language. However, for the sake of clarity 596developer speaks English as a first language. However, for the sake of clarity,
306and professionalism it is important that any language problems be corrected 597professionalism and avoiding making us look like prats, it is important that any
307before inflicting a news item upon end users.</p> 598language problems be corrected before inflicting a news item upon end users.</p>
308<p>Thus, all proposed news items must be posted to the <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt> or 599<p>Thus, at least 72 hours before a proposed news item is committed, it must be
309<tt class="docutils literal"><span class="pre">gentoo-core</span></tt> mailing list, and <tt class="docutils literal"><span class="pre">Cc:</span></tt>ed to <tt class="docutils literal"><span class="pre">pr&#64;gentoo.org</span></tt> at least 72 600posted to the <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt> mailing list and <tt class="docutils literal"><span class="pre">Cc:</span></tt>ed to <tt class="docutils literal"><span class="pre">pr&#64;gentoo.org</span></tt>
310hours before being committed (exceptions may be made in exceptional 601(exceptions may be made in exceptional circumstances). Any complaints — for
311circumstances). Any complaints regarding wording or clarity <strong>must</strong> be 602example regarding wording, clarity or accuracy — <strong>must</strong> be addressed before
312addressed before the news item goes live.</p> 603the news item goes live.</p>
313<p>News items must only be for <strong>important</strong> changes that may cause serious upgrade 604<p>News items must only be for <strong>important</strong> changes that may cause serious upgrade
314or compatibility problems. Ordinary upgrade messages and non-critical news items 605or compatibility problems. Ordinary upgrade messages and non-critical news items
315should remain in <tt class="docutils literal"><span class="pre">einfo</span></tt> notices. The importance of the message to its 606should remain in <tt class="docutils literal"><span class="pre">einfo</span></tt> notices. The importance of the message to its
316intended audience should be justified with the proposal.</p> 607intended audience should be justified with the proposal.</p>
317<div class="important"> 608<div class="important">
320news items which are aimed at users of an uncommon package or architecture. 611news items which are aimed at users of an uncommon package or architecture.
321Thus, the justification should be in the form &quot;this message is important to 612Thus, the justification should be in the form &quot;this message is important to
322YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p> 613YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p>
323</div> 614</div>
324</div> 615</div>
325<div class="section" id="news-item-distribution"> 616<div class="section">
326<h2><a class="toc-backref" href="#id24" name="news-item-distribution">News Item Distribution</a></h2> 617<h2><a class="toc-backref" href="#id35" id="news-item-distribution" name="news-item-distribution">News Item Distribution</a></h2>
327<div class="section" id="server-side"> 618<div class="section">
328<h3><a class="toc-backref" href="#id25" name="server-side">Server Side</a></h3> 619<h3><a class="toc-backref" href="#id36" id="server-side" name="server-side">Server Side</a></h3>
329<p>News items are to be made available via the Portage tree. This removes any 620<p>News items are to be made available via the standard rsync tree. This removes
330need for polling of a remote source.</p> 621any need for polling of a remote source.</p>
331<p>A new repository will be created for news items. The type (CVS or Subversion), 622<p>A new repository will be created for news items. The type (CVS or Subversion),
332location and access controls on this repository are beyond the scope of this 623location and access controls on this repository are beyond the scope of this
333GLEP.</p> 624GLEP.</p>
334<div class="note"> 625<div class="note">
335<p class="first admonition-title">Note</p> 626<p class="first admonition-title">Note</p>
336<p class="last">A previous draft of this GLEP instead used the main <tt class="docutils literal"><span class="pre">gentoo-x86</span></tt> 627<p class="last">A previous draft of this GLEP instead used the main <tt class="docutils literal"><span class="pre">gentoo-x86</span></tt>
337tree. This was changed following advice from Infrastructure 628tree. This was changed following advice from Infrastructure
338<a class="footnote-reference" href="#ramereth-repo" id="id10" name="id10">[10]</a>. Both solutions have the same end result.</p> 629<a class="footnote-reference" href="#ramereth-repo" id="id14" name="id14">[12]</a>. Both solutions have the same end result.</p>
339</div> 630</div>
340<p>This repository will contain directories named <tt class="docutils literal"><span class="pre">yyyy-mm/</span></tt>, where <tt class="docutils literal"><span class="pre">yyyy</span></tt> is 631<p>This repository will contain directories named <tt class="docutils literal"><span class="pre">yyyy/mm/</span></tt>, where <tt class="docutils literal"><span class="pre">yyyy</span></tt> is
341the current year and <tt class="docutils literal"><span class="pre">mm</span></tt> is the current month number (01 for January through 632the current year and <tt class="docutils literal"><span class="pre">mm</span></tt> is the current month number (01 for January through
34212 for December). This separation will help keep news items more manageable.</p> 63312 for December). This separation will help keep news items more manageable.</p>
343<p>The contents of this repository will automatically be merged with the main rsync 634<p>The contents of this repository will automatically be merged with the main rsync
344tree, placing the items under a top-level <tt class="docutils literal"><span class="pre">news/</span></tt> directory. The method used 635tree, placing the items in a <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory. The method used for
345for merging these items is beyond the scope of this GLEP -- a similar setup is 636merging these items and the frequency at which it will occur is beyond the scope
346already used for merging GLSAs into the rsync tree.</p> 637of this GLEP; a similar setup is already used for merging GLSAs into the rsync
638tree.</p>
639<p>The main rsync tree will <strong>not</strong> use the <tt class="docutils literal"><span class="pre">yyyy/mm/</span></tt> subdirectory layout. The
640news item directories will all be immediately under the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt>
641directory.</p>
642</div>
347<div class="note"> 643<div class="section">
348<p class="first admonition-title">Note</p>
349<p class="last">The <tt class="docutils literal"><span class="pre">profiles/</span></tt> directory will <em>not</em> be used. This fits in with
350the Portage team's future plans for <tt class="docutils literal"><span class="pre">profiles/</span></tt> and <tt class="docutils literal"><span class="pre">metadata/</span></tt>
351separation.</p>
352</div>
353</div>
354<div class="section" id="client-side">
355<h3><a class="toc-backref" href="#id26" name="client-side">Client Side</a></h3> 644<h3><a class="toc-backref" href="#id37" id="client-side" name="client-side">Client Side</a></h3>
356<p>Whenever relevant unread news items are found, <tt class="docutils literal"><span class="pre">emerge</span></tt> will copy or symlink 645<p>Whenever relevant unread news items are found, the package manager will create a
357the news file into <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/</span></tt>.</p> 646file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-${repoid}.unread</span></tt> (if it does not
647already exist) and append the news item identifier (eg
648<tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p>
649<p>All news item related files should be root owned and in the <tt class="docutils literal"><span class="pre">portage</span></tt> group
650with the group write (and, for directories, execute) bits set. News files should
651be world readable.</p>
358<p>Notification that new relevant news items will be displayed via the 652<p>Notification that new relevant news items will be displayed via the
359<tt class="docutils literal"><span class="pre">emerge</span></tt> tool in a similar way to the existing &quot;configuration files need 653<tt class="docutils literal"><span class="pre">emerge</span></tt> tool in a similar way to the existing &quot;configuration files need
360updating&quot; messages:</p> 654updating&quot; messages:</p>
361<pre class="literal-block"> 655<pre class="literal-block">
362* Important: 3 config files in /etc need updating.
363* Type emerge --help config to learn how to update config files.
364
365* Important: there are 5 unread news items. 656* Important: there are 5 unread news items.
366* Type emerge --help news to learn how to read news files. 657* Type emerge --help news to learn how to read news files.
367</pre> 658</pre>
368<p>The unread news message will also be displayed immediately after an 659<p>Checks for new news messages should be displayed:</p>
660<ul class="simple">
369<tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">sync</span></tt>.</p> 661<li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">sync</span></tt></li>
370<p>Portage may also warn of unread news items using, for example, a red flashy 662<li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">--pretend</span></tt></li>
371before actions such as merging a package.</p> 663<li>Before an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">&lt;target&gt;</span></tt> (which may also include a red warning message)</li>
372<p>Portage must keep track of news items which have already been installed to avoid 664</ul>
373repeatedly reinstalling a deleted news item.</p> 665<p>The package manager does not need to know how to launch the user's choice of
666news client. This is consistent with the way configuration file updates are
667handled.</p>
668<p>The package manager may use a timestamp check file to avoid having to process
669news items unnecessarily.</p>
670<p>The package manager must keep track of news items that have already been added
671to the unread list to avoid repeatedly marking a deleted news item. This could
672be handled via a <tt class="docutils literal"><span class="pre">news-${repoid}.skip</span></tt> file containing the IDs of news items
673that have already been added to a <tt class="docutils literal"><span class="pre">news-${repoid}.unread</span></tt> file, but this
674method is not required by this GLEP.</p>
374<p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to 675<p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to
375filter out the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p> 676filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p>
376</div> 677</div>
377</div> 678</div>
378<div class="section" id="news-item-clients"> 679<div class="section">
379<h2><a class="toc-backref" href="#id27" name="news-item-clients">News Item Clients</a></h2> 680<h2><a class="toc-backref" href="#id38" id="news-item-clients" name="news-item-clients">News Item Clients</a></h2>
380<p>Once a news item is 'installed', third party tools (or a traditional Unix pager 681<p>Once a news item is marked for reading, third party tools (or traditional core
381and <tt class="docutils literal"><span class="pre">rm</span></tt>) can be used to display and view the news files. An <tt class="docutils literal"><span class="pre">eselect</span></tt> 682Unix tools) can be used to display and view the news files.</p>
382<a class="footnote-reference" href="#eselect" id="id11" name="id11">[2]</a> module shall be created as the 'suggested' display tool; other 683<p>When a news item is read, its name should be removed from the
684<tt class="docutils literal"><span class="pre">news-${repoid}.unread</span></tt> file. If a news client acts as an interactive reader
685rather than a gateway, it should then add the name to a <tt class="docutils literal"><span class="pre">news-${repoid}.read</span></tt>
686file in the same directory with the same file format.</p>
687<p>An <tt class="docutils literal"><span class="pre">eselect</span></tt> <a class="footnote-reference" href="#eselect" id="id15" name="id15">[3]</a> module shall be created as the 'suggested' display
383display tools (for example, a news to email forwarder, which would be ideal for 688tool; other display tools (for example, a news to email forwarder, which would
384users who sync on a cron) are left as options for those who desire them -- the 689be ideal for users who sync on a <tt class="docutils literal"><span class="pre">cron</span></tt>) are left as options for those who
385simple file format make this relatively simple.</p> 690desire them.</p>
386</div> 691</div>
387<div class="section" id="news-item-removal"> 692<div class="section">
388<h2><a class="toc-backref" href="#id28" name="news-item-removal">News Item Removal</a></h2> 693<h2><a class="toc-backref" href="#id39" id="news-item-removal" name="news-item-removal">News Item Removal</a></h2>
389<p>News items can be removed (by removing the news file from the main tree) when 694<p>News items can be removed (by removing the news file from the main tree) when
390they are no longer relevant, if they are made obsolete by a future news item or 695they are no longer relevant, if they are made obsolete by a future news item or
391after a long period of time. This is the same as the method used for <tt class="docutils literal"><span class="pre">updates</span></tt> 696after a long period of time. This is the same as the method used for <tt class="docutils literal"><span class="pre">updates</span></tt>
392entries.</p> 697entries.</p>
393</div> 698</div>
394</div> 699</div>
395<div class="section" id="integration-with-existing-systems"> 700<div class="section">
396<h1><a class="toc-backref" href="#id29" name="integration-with-existing-systems">Integration with Existing Systems</a></h1> 701<h1><a class="toc-backref" href="#id40" id="integration-with-existing-systems" name="integration-with-existing-systems">Integration with Existing Systems</a></h1>
397<p>It would be trivial to convert these news items into the format used for news 702<p>It would be simple to convert these news items into the format used for news
398items on the Gentoo website or posts for the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list.</p> 703items on the Gentoo website or posts for the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list.</p>
399<p>There is an existing automated tool <a class="footnote-reference" href="#forums-glsa" id="id12" name="id12">[3]</a> for posting GLSAs to the 704<p>There is an existing automated tool <a class="footnote-reference" href="#forums-glsa" id="id16" name="id16">[4]</a> for posting GLSAs to the
400forums. A similar tool can be used for these news items.</p> 705forums. A similar tool can be used for these news items.</p>
401</div> 706</div>
402<div class="section" id="backwards-compatibility"> 707<div class="section">
403<h1><a class="toc-backref" href="#id30" name="backwards-compatibility">Backwards Compatibility</a></h1> 708<h1><a class="toc-backref" href="#id41" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
404<p>Backwards compatibility is not a concern here. Existing tools will simply ignore 709<p>Backwards compatibility is not a concern here. Existing tools will simply ignore
405the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p> 710the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p>
406</div> 711</div>
407<div class="section" id="reference-implementation"> 712<div class="section">
408<h1><a class="toc-backref" href="#id31" name="reference-implementation">Reference Implementation</a></h1> 713<h1><a class="toc-backref" href="#id42" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1>
409<div class="section" id="portage-code"> 714<p>A reference implementation of the required package manager support can be found
410<h2><a class="toc-backref" href="#id32" name="portage-code">Portage Code</a></h2> 715in Paludis <a class="footnote-reference" href="#paludis" id="id17" name="id17">[15]</a>, along with a reference newsreader implemented as an
411<p>TODO</p> 716eselect module <a class="footnote-reference" href="#eselect-news" id="id18" name="id18">[16]</a>.</p>
412</div> 717</div>
413<div class="section" id="simple-eselect-news-client">
414<h2><a class="toc-backref" href="#id33" name="simple-eselect-news-client">Simple <tt class="docutils literal docutils literal"><span class="pre">eselect</span></tt> News Client</a></h2>
415<p>A demonstration <tt class="docutils literal"><span class="pre">eselect</span></tt> news display script follows:</p>
416<pre class="literal-block">
417# Copyright 1999-2005 Gentoo Foundation
418# Distributed under the terms of the GNU General Public License v2
419# $Id: glep-0042.html,v 1.2 2005/11/07 17:02:42 ciaranm Exp $
420
421DESCRIPTION=&quot;Read important Gentoo news items&quot;
422MAINTAINER=&quot;ciaranm&#64;gentoo.org&quot;
423SVN_DATE='$Date: 2005/11/07 17:02:42 $'
424VERSION=$(svn_date_to_version &quot;${SVN_DATE}&quot; )
425
426get_news_item_list() {
427 [[ -d &quot;${ROOT}/var/lib/gentoo/news&quot; ]] || return
428 (
429 local news
430 for news in &quot;${ROOT}/var/lib/gentoo/news/&quot;*.txt ; do
431 echo $(basename ${news%%.*} )
432 done
433 ) | sort -u
434}
435
436get_filename() {
437 local best_lang=${LANG%%_*} lang= filename=&quot;${1}&quot;
438 [[ -e &quot;/${filename}&quot; ]] || for lang in &quot;${best_lang}&quot; &quot;en&quot; ; do
439 filename=&quot;${ROOT}/var/lib/gentoo/news/${1}.${lang}.txt&quot;
440 [[ -e &quot;${filename}&quot; ]] &amp;&amp; break
441 done
442 [[ -e &quot;${filename}&quot; ]] &amp;&amp; echo &quot;${filename}&quot; || die -q &quot;Can't find '${1}'&quot;
443}
444
445get_all_filenames() {
446 if [[ -z &quot;${1}&quot; ]] ; then
447 echo &quot;${ROOT}/var/lib/gentoo/news/&quot;*.??&quot;.txt&quot;
448 else
449 echo &quot;${ROOT}/var/lib/gentoo/news/${1}.&quot;??&quot;.txt&quot;
450 fi
451}
452
453get_headers() {
454 sed -e '/^$/Q' &lt; $(get_filename &quot;${1}&quot; )
455}
456
457get_body() {
458 sed -e '1,/^$/d' &lt; $(get_filename &quot;${1}&quot; )
459}
460
461get_title() {
462 get_headers &quot;${1}&quot; | sed -n -e '/^[Tt]itle: /s/^[^:]\+:[ \t]*//p'
463}
464
465### list action
466
467## {{{ list stuff
468describe_list() {
469 echo &quot;List available news items&quot;
470}
471
472do_list() {
473 write_list_start &quot;Available news items:&quot;
474 local empty=yes n=1
475 for news in $(get_news_item_list ) ; do
476 write_numbered_list_entry ${n} &quot;$(highlight $(get_title ${news} ) ) (${news})&quot;
477 n=$(( n + 1 ))
478 done
479}
480## }}}
481
482## {{{ show stuff
483describe_show(){
484 echo &quot;Show a news item&quot;
485}
486
487do_show() {
488 [[ -z &quot;${1}&quot; ]] &amp;&amp; die -q &quot;You didn't tell me which news item to read&quot;
489
490 local target=${1} filename=
491 if is_number &quot;${target}&quot; &amp;&amp; [[ ${target} -ge 1 ]] ; then
492 targets=( $(get_news_item_list ) )
493 target=${targets[$(( ${target} - 1 ))]}
494 fi
495
496 (
497 get_headers &quot;${target}&quot; | grep -v '^Display-If-\|Content-Type:'
498 echo
499 get_body &quot;${target}&quot;
500 ) | ${PAGER:-cat}
501}
502## }}}
503
504# {{{ delete stuff
505describe_delete() {
506 echo &quot;Delete a news item&quot;
507}
508
509do_delete() {
510 [[ -z &quot;${1}&quot; ]] &amp;&amp; die -q &quot;You didn't tell me which news item to delete&quot;
511
512 for target in $&#64; ; do
513 if is_number &quot;${target}&quot; &amp;&amp; [[ ${target} -ge 1 ]] ; then
514 targets=( $(get_news_item_list ) )
515 target=${targets[$(( ${target} - 1 ))]}
516 fi
517
518 rm $(get_all_filenames &quot;${target}&quot; ) || die -q &quot;Couldn't delete ${target}&quot;
519 done
520}
521# }}}
522
523# {{{ delete-all
524describe_delete-all() {
525 echo &quot;Delete all news items&quot;
526}
527
528do_delete-all() {
529 rm $(get_all_filenames ) || die -q &quot;Couldn't delete news items&quot;
530}
531# }}}
532</pre>
533</div>
534<div class="section" id="simple-news-to-mail-forwarder">
535<h2><a class="toc-backref" href="#id34" name="simple-news-to-mail-forwarder">Simple News to Mail Forwarder</a></h2>
536<p>A demonstration shell script which delivers news items via email follows:</p>
537<pre class="literal-block">
538#!/bin/bash
539
540to_address=&quot;root&#64;localhost&quot;
541mail=&quot;mailx&quot;
542best_lang=&quot;${LANG%%_*}&quot;
543
544for news in /var/lib/gentoo/news/*.*.txt ; do
545 [[ -z &quot;${best_lang}&quot; ]] || news=&quot;${news%%.*}.${best_lang}.txt&quot;
546 [[ -f &quot;${news}&quot; ]] || news=&quot;${news%%.*}.en.txt&quot;
547 [[ -f &quot;${news}&quot; ]] || continue
548 title=$(sed -n -e '/^Title:/ { s,^[^:]\+:[ \t]\+,,p ; q }' &lt; ${news} )
549 sed -e '1,/^$/ { /^Display-If\|Content-Type/d }' &lt; &quot;${news}&quot; | \
550 ${mail} -s &quot;Gentoo news: ${title}&quot; &quot;${to_address}&quot; &amp;&amp; \
551 for file in ${news%%.*}.*.txt ; do rm &quot;${file}&quot; ; done
552done
553</pre>
554</div>
555</div>
556<div class="section" id="credits"> 718<div class="section">
557<h1><a class="toc-backref" href="#id35" name="credits">Credits</a></h1> 719<h1><a class="toc-backref" href="#id43" id="credits" name="credits">Credits</a></h1>
558<p>The idea behind notifying users of news updates via Portage comes from Stuart 720<p>The idea behind notifying users of news updates via Portage comes from Stuart
559Herbert <a class="footnote-reference" href="#stuart-blog" id="id13" name="id13">[12]</a>.</p> 721Herbert <a class="footnote-reference" href="#stuart-blog" id="id19" name="id19">[17]</a>.</p>
560<p>Thanks to Lance Albertson, Donnie Berkholz, Grant Goodyear, Brian Harring, Dan 722<p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear,
561Meltzer, Paul de Vrieze and Alec Warner for input. Some of the ideas presented 723Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec
724Warner for input. Some of the ideas presented here are theirs, others go
562here are theirs, others go completely against their suggestions.</p> 725completely against their suggestions.</p>
563</div> 726</div>
564<div class="section" id="references"> 727<div class="section">
728<h1><a class="toc-backref" href="#id44" id="example-files" name="example-files">Example Files</a></h1>
729<dl class="docutils">
730<dt><a class="reference" href="glep-0042-extras/example-news-item.txt">example-news-item.txt</a></dt>
731<dd>An example news item.</dd>
732</dl>
733</div>
734<div class="section">
565<h1><a class="toc-backref" href="#id36" name="references">References</a></h1> 735<h1><a class="toc-backref" href="#id45" id="references" name="references">References</a></h1>
736<table class="docutils footnote" frame="void" id="bug-11359" rules="none">
737<colgroup><col class="label" /><col /></colgroup>
738<tbody valign="top">
739<tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359
740&quot;[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging&quot;,
741<a class="reference" href="https://bugs.gentoo.org/show_bug.cgi?id=11359">https://bugs.gentoo.org/show_bug.cgi?id=11359</a></td></tr>
742</tbody>
743</table>
566<table class="docutils footnote" frame="void" id="docs-policy" rules="none"> 744<table class="docutils footnote" frame="void" id="docs-policy" rules="none">
567<colgroup><col class="label" /><col /></colgroup> 745<colgroup><col class="label" /><col /></colgroup>
568<tbody valign="top"> 746<tbody valign="top">
569<tr><td class="label"><a class="fn-backref" href="#id4" name="docs-policy">[1]</a></td><td>Gentoo XML Guide, Daniel Robbins et al., 747<tr><td class="label"><a class="fn-backref" href="#id8" name="docs-policy">[2]</a></td><td>Gentoo XML Guide, Daniel Robbins et al.,
570<a class="reference" href="http://www.gentoo.org/doc/en/xml-guide.xml">http://www.gentoo.org/doc/en/xml-guide.xml</a></td></tr> 748<a class="reference" href="http://www.gentoo.org/doc/en/xml-guide.xml">http://www.gentoo.org/doc/en/xml-guide.xml</a></td></tr>
571</tbody> 749</tbody>
572</table> 750</table>
573<table class="docutils footnote" frame="void" id="eselect" rules="none"> 751<table class="docutils footnote" frame="void" id="eselect" rules="none">
574<colgroup><col class="label" /><col /></colgroup> 752<colgroup><col class="label" /><col /></colgroup>
575<tbody valign="top"> 753<tbody valign="top">
576<tr><td class="label"><a class="fn-backref" href="#id11" name="eselect">[2]</a></td><td>eselect modular framework for configuration and 754<tr><td class="label"><a class="fn-backref" href="#id15" name="eselect">[3]</a></td><td>eselect modular framework for configuration and
577administration utilities, 755administration utilities,
578<a class="reference" href="http://www.gentoo.org/proj/en/eselect/index.xml">http://www.gentoo.org/proj/en/eselect/index.xml</a></td></tr> 756<a class="reference" href="http://www.gentoo.org/proj/en/eselect/index.xml">http://www.gentoo.org/proj/en/eselect/index.xml</a></td></tr>
579</tbody> 757</tbody>
580</table> 758</table>
581<table class="docutils footnote" frame="void" id="forums-glsa" rules="none"> 759<table class="docutils footnote" frame="void" id="forums-glsa" rules="none">
582<colgroup><col class="label" /><col /></colgroup> 760<colgroup><col class="label" /><col /></colgroup>
583<tbody valign="top"> 761<tbody valign="top">
584<tr><td class="label"><a class="fn-backref" href="#id12" name="forums-glsa">[3]</a></td><td>Forums user GLSA, 762<tr><td class="label"><a class="fn-backref" href="#id16" name="forums-glsa">[4]</a></td><td>Forums user GLSA,
585<a class="reference" href="http://forums.gentoo.org/profile.php?mode=viewprofile&amp;u=55648">http://forums.gentoo.org/profile.php?mode=viewprofile&amp;u=55648</a></td></tr> 763<a class="reference" href="http://forums.gentoo.org/profile.php?mode=viewprofile&amp;u=55648">http://forums.gentoo.org/profile.php?mode=viewprofile&amp;u=55648</a></td></tr>
586</tbody> 764</tbody>
587</table> 765</table>
588<table class="docutils footnote" frame="void" id="forums-whining" rules="none"> 766<table class="docutils footnote" frame="void" id="forums-apache2" rules="none">
589<colgroup><col class="label" /><col /></colgroup> 767<colgroup><col class="label" /><col /></colgroup>
590<tbody valign="top"> 768<tbody valign="top">
591<tr><td class="label"><a name="forums-whining">[4]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>)</em> Forums thread &quot;Gentoo Apache2 Config Change Idiocy&quot;, 769<tr><td class="label"><a name="forums-apache2">[5]</a></td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id3">2</a>)</em> Forums thread &quot;Gentoo Apache2 Config Change Idiocy&quot;,
592<a class="reference" href="http://forums.gentoo.org/viewtopic-t-384368.html">http://forums.gentoo.org/viewtopic-t-384368.html</a></td></tr> 770<a class="reference" href="http://forums.gentoo.org/viewtopic-t-384368.html">http://forums.gentoo.org/viewtopic-t-384368.html</a></td></tr>
593</tbody> 771</tbody>
594</table> 772</table>
595<table class="docutils footnote" frame="void" id="glep-22" rules="none"> 773<table class="docutils footnote" frame="void" id="glep-22" rules="none">
596<colgroup><col class="label" /><col /></colgroup> 774<colgroup><col class="label" /><col /></colgroup>
597<tbody valign="top"> 775<tbody valign="top">
598<tr><td class="label"><a class="fn-backref" href="#id9" name="glep-22">[5]</a></td><td>GLEP 22: &quot;New &quot;keyword&quot; system to incorporate various 776<tr><td class="label"><a class="fn-backref" href="#id12" name="glep-22">[6]</a></td><td>GLEP 22: &quot;New &quot;keyword&quot; system to incorporate various
599userlands/kernels/archs&quot;, Grant Goodyear, 777userlands/kernels/archs&quot;, Grant Goodyear,
600<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0022.html">http://www.gentoo.org/proj/en/glep/glep-0022.html</a></td></tr> 778<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0022.html">http://www.gentoo.org/proj/en/glep/glep-0022.html</a></td></tr>
601</tbody> 779</tbody>
602</table> 780</table>
603<table class="docutils footnote" frame="void" id="glep-31" rules="none"> 781<table class="docutils footnote" frame="void" id="glep-31" rules="none">
604<colgroup><col class="label" /><col /></colgroup> 782<colgroup><col class="label" /><col /></colgroup>
605<tbody valign="top"> 783<tbody valign="top">
606<tr><td class="label"><a class="fn-backref" href="#id5" name="glep-31">[6]</a></td><td>GLEP 31: &quot;Character Sets for Portage Tree Items&quot;, Ciaran 784<tr><td class="label"><a class="fn-backref" href="#id9" name="glep-31">[7]</a></td><td>GLEP 31: &quot;Character Sets for Portage Tree Items&quot;, Ciaran
607McCreesh, 785McCreesh,
608<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0031.html">http://www.gentoo.org/proj/en/glep/glep-0031.html</a></td></tr> 786<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0031.html">http://www.gentoo.org/proj/en/glep/glep-0031.html</a></td></tr>
609</tbody> 787</tbody>
610</table> 788</table>
611<table class="docutils footnote" frame="void" id="glep-34" rules="none"> 789<table class="docutils footnote" frame="void" id="glep-34" rules="none">
612<colgroup><col class="label" /><col /></colgroup> 790<colgroup><col class="label" /><col /></colgroup>
613<tbody valign="top"> 791<tbody valign="top">
614<tr><td class="label"><a class="fn-backref" href="#id7" name="glep-34">[7]</a></td><td>GLEP 34: &quot;Per-Category metadata.xml Files&quot;, Ciaran McCreesh, 792<tr><td class="label"><a class="fn-backref" href="#id6" name="glep-34">[8]</a></td><td>GLEP 34: &quot;Per-Category metadata.xml Files&quot;, Ciaran McCreesh,
615<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0034.html">http://www.gentoo.org/proj/en/glep/glep-0034.html</a></td></tr> 793<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0034.html">http://www.gentoo.org/proj/en/glep/glep-0034.html</a></td></tr>
616</tbody> 794</tbody>
617</table> 795</table>
618<table class="docutils footnote" frame="void" id="glep-36" rules="none"> 796<table class="docutils footnote" frame="void" id="glep-36" rules="none">
619<colgroup><col class="label" /><col /></colgroup> 797<colgroup><col class="label" /><col /></colgroup>
620<tbody valign="top"> 798<tbody valign="top">
621<tr><td class="label"><a class="fn-backref" href="#id3" name="glep-36">[8]</a></td><td>GLEP 36: &quot;Subversion/CVS for Gentoo Hosted Projects&quot;, Aaron 799<tr><td class="label"><a class="fn-backref" href="#id4" name="glep-36">[9]</a></td><td>GLEP 36: &quot;Subversion/CVS for Gentoo Hosted Projects&quot;, Aaron
622Walker, 800Walker,
623<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0036.html">http://www.gentoo.org/proj/en/glep/glep-0036.html</a></td></tr> 801<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0036.html">http://www.gentoo.org/proj/en/glep/glep-0036.html</a></td></tr>
624</tbody> 802</tbody>
625</table> 803</table>
804<table class="docutils footnote" frame="void" id="glep-45" rules="none">
805<colgroup><col class="label" /><col /></colgroup>
806<tbody valign="top">
807<tr><td class="label"><a class="fn-backref" href="#id11" name="glep-45">[10]</a></td><td>GLEP 45: &quot;GLEP date format&quot;, Henrik Brix Andersen,
808<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0045.html">http://www.gentoo.org/proj/en/glep/glep-0045.html</a></td></tr>
809</tbody>
810</table>
626<table class="docutils footnote" frame="void" id="iso-639" rules="none"> 811<table class="docutils footnote" frame="void" id="iso-639" rules="none">
627<colgroup><col class="label" /><col /></colgroup> 812<colgroup><col class="label" /><col /></colgroup>
628<tbody valign="top"> 813<tbody valign="top">
629<tr><td class="label"><a class="fn-backref" href="#id6" name="iso-639">[9]</a></td><td>ISO 639 &quot;Code for the representation of names of languages&quot;</td></tr> 814<tr><td class="label"><a class="fn-backref" href="#id5" name="iso-639">[11]</a></td><td>ISO 639 &quot;Code for the representation of names of languages&quot;</td></tr>
630</tbody> 815</tbody>
631</table> 816</table>
632<table class="docutils footnote" frame="void" id="ramereth-repo" rules="none"> 817<table class="docutils footnote" frame="void" id="ramereth-repo" rules="none">
633<colgroup><col class="label" /><col /></colgroup> 818<colgroup><col class="label" /><col /></colgroup>
634<tbody valign="top"> 819<tbody valign="top">
635<tr><td class="label"><a class="fn-backref" href="#id10" name="ramereth-repo">[10]</a></td><td>&quot;Re: [gentoo-dev] GLEP ??: Critical News Reporting&quot;, Lance 820<tr><td class="label"><a class="fn-backref" href="#id14" name="ramereth-repo">[12]</a></td><td>&quot;Re: [gentoo-dev] GLEP ??: Critical News Reporting&quot;, Lance
636Albertson, 821Albertson,
637<a class="reference" href="http://marc.theaimsgroup.com/?l=gentoo-dev&amp;m=113111585907703&amp;w=2">http://marc.theaimsgroup.com/?l=gentoo-dev&amp;m=113111585907703&amp;w=2</a></td></tr> 822<a class="reference" href="http://marc.theaimsgroup.com/?l=gentoo-dev&amp;m=113111585907703&amp;w=2">http://marc.theaimsgroup.com/?l=gentoo-dev&amp;m=113111585907703&amp;w=2</a></td></tr>
638</tbody> 823</tbody>
639</table> 824</table>
640<table class="docutils footnote" frame="void" id="rfc-822" rules="none"> 825<table class="docutils footnote" frame="void" id="rfc-822" rules="none">
641<colgroup><col class="label" /><col /></colgroup> 826<colgroup><col class="label" /><col /></colgroup>
642<tbody valign="top"> 827<tbody valign="top">
643<tr><td class="label"><a class="fn-backref" href="#id8" name="rfc-822">[11]</a></td><td><a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> &quot;Standard for the format of ARPA Internet text messages&quot;</td></tr> 828<tr><td class="label"><a class="fn-backref" href="#id10" name="rfc-822">[13]</a></td><td><a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> &quot;Standard for the format of ARPA Internet text messages&quot;</td></tr>
829</tbody>
830</table>
831<table class="docutils footnote" frame="void" id="rfc-3629" rules="none">
832<colgroup><col class="label" /><col /></colgroup>
833<tbody valign="top">
834<tr><td class="label"><a class="fn-backref" href="#id7" name="rfc-3629">[14]</a></td><td><a class="reference" href="http://www.faqs.org/rfcs/rfc3629.html">RFC 3629</a>: &quot;UTF-8, a transformation format of ISO 10646&quot;
835<a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr>
836</tbody>
837</table>
838<table class="docutils footnote" frame="void" id="paludis" rules="none">
839<colgroup><col class="label" /><col /></colgroup>
840<tbody valign="top">
841<tr><td class="label"><a class="fn-backref" href="#id17" name="paludis">[15]</a></td><td>Paludis homepage, <a class="reference" href="http://paludis.berlios.de">http://paludis.berlios.de</a></td></tr>
842</tbody>
843</table>
844<table class="docutils footnote" frame="void" id="eselect-news" rules="none">
845<colgroup><col class="label" /><col /></colgroup>
846<tbody valign="top">
847<tr><td class="label"><a class="fn-backref" href="#id18" name="eselect-news">[16]</a></td><td>news.eselect, <a class="reference" href="http://svn.berlios.de/svnroot/repos/paludis/trunk/eselect/news.eselect">http://svn.berlios.de/svnroot/repos/paludis/trunk/eselect/news.eselect</a></td></tr>
644</tbody> 848</tbody>
645</table> 849</table>
646<table class="docutils footnote" frame="void" id="stuart-blog" rules="none"> 850<table class="docutils footnote" frame="void" id="stuart-blog" rules="none">
647<colgroup><col class="label" /><col /></colgroup> 851<colgroup><col class="label" /><col /></colgroup>
648<tbody valign="top"> 852<tbody valign="top">
649<tr><td class="label"><a class="fn-backref" href="#id13" name="stuart-blog">[12]</a></td><td>&quot;Favouring an automatic news mechanism&quot;, Stuart Herbert, 853<tr><td class="label"><a class="fn-backref" href="#id19" name="stuart-blog">[17]</a></td><td>&quot;Favouring an automatic news mechanism&quot;, Stuart Herbert,
650<a class="reference" href="http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism">http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism</a></td></tr> 854<a class="reference" href="http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism">http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism</a></td></tr>
651</tbody> 855</tbody>
652</table> 856</table>
857<table class="docutils footnote" frame="void" id="id20" rules="none">
858<colgroup><col class="label" /><col /></colgroup>
859<tbody valign="top">
860<tr><td class="label"><a class="fn-backref" href="#id21" name="id20">[18]</a></td><td><a class="reference" href="glep-0042-extras/example-news-item.txt">glep-0042-extras/example-news-item.txt</a></td></tr>
861</tbody>
862</table>
653</div> 863</div>
654<div class="section" id="copyright"> 864<div class="section">
655<h1><a class="toc-backref" href="#id37" name="copyright">Copyright</a></h1> 865<h1><a class="toc-backref" href="#id46" id="copyright" name="copyright">Copyright</a></h1>
656<p>This document has been placed in the public domain.</p> 866<p>This document has been placed in the public domain.</p>
657<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : --> 867<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
658</div> 868</div>
659 869
660</div> 870</div>
661<div class="footer"> 871<div class="footer">
662<hr class="footer" /> 872<hr class="footer" />
663<a class="reference" href="glep-0042.txt">View document source</a>. 873<a class="reference" href="glep-0042.txt">View document source</a>.
664Generated on: 2005-11-07 17:01 UTC. 874Generated on: 2006-09-05 20:36 UTC.
665Generated 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. 875Generated 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.
666 876
667</div> 877</div>
668</body> 878</body>
669</html> 879</html>

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.14

  ViewVC Help
Powered by ViewVC 1.1.20