/[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.8 Revision 1.14
… …
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.4: 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">
… …
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.7</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.cgi/xml/htdocs/proj/en/glep/glep-0042.txt?cvsroot=gentoo">2006/01/05 15:10:45</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="glep-0002.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-Oct-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-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</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"> 299<div class="contents topic">
55<p class="topic-title first"><a id="contents" 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="id20" name="id20">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="id21" name="id21">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="id22" name="id22">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="id23" name="id23">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="id24" name="id24">Overview</a></li> 306<li><a class="reference" href="#overview" id="id26" name="id26">Overview</a></li>
62<li><a class="reference" href="#required-portage-enhancements" id="id25" name="id25">Required Portage Enhancements</a></li> 307<li><a class="reference" href="#required-portage-enhancements" id="id27" name="id27">Required Portage Enhancements</a></li>
63<li><a class="reference" href="#news-item-identities" id="id26" name="id26">News Item Identities</a></li> 308<li><a class="reference" href="#news-item-identities" id="id28" name="id28">News Item Identities</a></li>
64<li><a class="reference" href="#news-item-directories" id="id27" name="id27">News Item Directories</a></li> 309<li><a class="reference" href="#news-item-directories" id="id29" name="id29">News Item Directories</a></li>
65<li><a class="reference" href="#news-item-files" id="id28" name="id28">News Item Files</a><ul> 310<li><a class="reference" href="#news-item-files" id="id30" name="id30">News Item Files</a><ul>
66<li><a class="reference" href="#news-item-headers" id="id29" name="id29">News Item Headers</a></li> 311<li><a class="reference" href="#news-item-headers" id="id31" name="id31">News Item Headers</a></li>
67<li><a class="reference" href="#news-item-body" id="id30" name="id30">News Item Body</a></li> 312<li><a class="reference" href="#news-item-body" id="id32" name="id32">News Item Body</a></li>
68<li><a class="reference" href="#example-news-item" id="id31" name="id31">Example News Item</a></li> 313<li><a class="reference" href="#example-news-item" id="id33" name="id33">Example News Item</a></li>
69</ul> 314</ul>
70</li> 315</li>
71<li><a class="reference" href="#news-item-quality-control" id="id32" name="id32">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>
72<li><a class="reference" href="#news-item-distribution" id="id33" name="id33">News Item Distribution</a><ul> 317<li><a class="reference" href="#news-item-distribution" id="id35" name="id35">News Item Distribution</a><ul>
73<li><a class="reference" href="#server-side" id="id34" name="id34">Server Side</a></li> 318<li><a class="reference" href="#server-side" id="id36" name="id36">Server Side</a></li>
74<li><a class="reference" href="#client-side" id="id35" name="id35">Client Side</a></li> 319<li><a class="reference" href="#client-side" id="id37" name="id37">Client Side</a></li>
75</ul> 320</ul>
76</li> 321</li>
77<li><a class="reference" href="#news-item-clients" id="id36" name="id36">News Item Clients</a></li> 322<li><a class="reference" href="#news-item-clients" id="id38" name="id38">News Item Clients</a></li>
78<li><a class="reference" href="#news-item-removal" id="id37" name="id37">News Item Removal</a></li> 323<li><a class="reference" href="#news-item-removal" id="id39" name="id39">News Item Removal</a></li>
79</ul> 324</ul>
80</li> 325</li>
81<li><a class="reference" href="#integration-with-existing-systems" id="id38" name="id38">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>
82<li><a class="reference" href="#backwards-compatibility" id="id39" name="id39">Backwards Compatibility</a></li> 327<li><a class="reference" href="#backwards-compatibility" id="id41" name="id41">Backwards Compatibility</a></li>
83<li><a class="reference" href="#reference-implementation" id="id40" name="id40">Reference Implementation</a><ul> 328<li><a class="reference" href="#reference-implementation" id="id42" name="id42">Reference Implementation</a></li>
329<li><a class="reference" href="#credits" id="id43" name="id43">Credits</a></li>
330<li><a class="reference" href="#example-files" id="id44" name="id44">Example Files</a></li>
84<li><a class="reference" href="#portage-code" id="id41" name="id41">Portage Code</a></li> 331<li><a class="reference" href="#references" id="id45" name="id45">References</a></li>
85<li><a class="reference" href="#simple-eselect-news-client" id="id42" name="id42">Simple <tt class="docutils literal"><span class="pre">eselect</span></tt> News Client</a></li> 332<li><a class="reference" href="#copyright" id="id46" name="id46">Copyright</a></li>
86<li><a class="reference" href="#simple-news-to-mail-forwarder" id="id43" name="id43">Simple News to Mail Forwarder</a></li>
87</ul> 333</ul>
88</li>
89<li><a class="reference" href="#credits" id="id44" name="id44">Credits</a></li>
90<li><a class="reference" href="#example-files" id="id45" name="id45">Example Files</a></li>
91<li><a class="reference" href="#references" id="id46" name="id46">References</a></li>
92<li><a class="reference" href="#copyright" id="id47" name="id47">Copyright</a></li>
93</ul>
94</div> 334</div>
95<div class="section"> 335<div class="section">
96<h1><a class="toc-backref" href="#id20" id="abstract" name="abstract">Abstract</a></h1> 336<h1><a class="toc-backref" href="#id22" id="abstract" name="abstract">Abstract</a></h1>
97<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
98regarding tree-related items.</p> 338related to the tree.</p>
99</div> 339</div>
100<div class="section"> 340<div class="section">
101<h1><a class="toc-backref" href="#id21" id="motivation" name="motivation">Motivation</a></h1> 341<h1><a class="toc-backref" href="#id23" id="motivation" name="motivation">Motivation</a></h1>
102<p>Although most package updates are clean and require little user action, 342<p>Although most package updates are clean and require little user action,
103occasionally an upgrade requires user intervention during the upgrade process. 343occasionally an upgrade requires user intervention. Recent examples of the
104Recent examples of the latter 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> 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>
105and the <tt class="docutils literal"><span class="pre">mysql-4.1</span></tt> database format changes.</p> 345database format changes.</p>
106<p>There are currently several ways of delivering important news items to our 346<p>There are currently several ways of delivering important news items to our
107users, none of them particularly effective:</p> 347users, none of them particularly effective:</p>
108<ul class="simple"> 348<ul class="simple">
109<li>Gentoo Weekly News</li> 349<li>Gentoo Weekly News</li>
110<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> 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>
… …
112<li>The main Gentoo website</li> 352<li>The main Gentoo website</li>
113<li>RSS feeds of Gentoo news</li> 353<li>RSS feeds of Gentoo news</li>
114<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> 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>
115</ul> 355</ul>
116<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
117to avoid repeats of the various recent upgrade debacles. This GLEP proposes a 357to avoid repeats of various prior upgrade debacles. This GLEP proposes a
118solution 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>
119<div class="important"> 359<div class="important">
120<p class="first admonition-title">Important</p> 360<p class="first admonition-title">Important</p>
121<p class="last">This GLEP does not seek to replace or modify <tt class="docutils literal"><span class="pre">einfo</span></tt> messages 361<p class="last">This GLEP does not seek to replace or modify <tt class="docutils literal"><span class="pre">einfo</span></tt> messages
122which are displayed post-install. That is a separate issue which is handled 362which are displayed post-install. That is a separate issue which is handled
123by <tt class="docutils literal"><span class="pre">elog</span></tt> <a class="footnote-reference" href="#bug-11359" id="id1" name="id1">[1]</a>.</p> 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>
124</div> 364</div>
125</div> 365</div>
126<div class="section"> 366<div class="section">
127<h1><a class="toc-backref" href="#id22" id="requirements" name="requirements">Requirements</a></h1> 367<h1><a class="toc-backref" href="#id24" id="requirements" name="requirements">Requirements</a></h1>
128<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>
129<dl class="docutils"> 369<dl class="docutils">
130<dt>Preemptive</dt> 370<dt>Preemptive</dt>
131<dd>Users should be told of changes <em>before</em> they break a system, not after the 371<dd>Users should be told of changes <em>before</em> they break a system, not after the
132damage has already been done. Ideally, the system administrator would be 372damage has already been done. Ideally, the system administrator would be
133given ample warning to plan difficult upgrades and changes, rather than only 373given ample warning to plan difficult upgrades and changes, rather than only
134being told just before action is necessary.</dd> 374being told just before action is necessary.</dd>
135<dt>No user subscription required</dt> 375<dt>No user subscription required</dt>
136<dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id2" name="id2">[5]</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
137read 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
138requires subscription has no advantage over current methods.</dd> 378requires subscription has no advantage over current methods.</dd>
139<dt>No user monitoring required</dt> 379<dt>No user monitoring required</dt>
140<dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id3" name="id3">[5]</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
141read 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
142until 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
… …
178excessive difficulty. Similarly, easy interoperation with any future news 418excessive difficulty. Similarly, easy interoperation with any future news
179sources should not be precluded.</dd> 419sources should not be precluded.</dd>
180</dl> 420</dl>
181</div> 421</div>
182<div class="section"> 422<div class="section">
183<h1><a class="toc-backref" href="#id23" id="specification" name="specification">Specification</a></h1> 423<h1><a class="toc-backref" href="#id25" id="specification" name="specification">Specification</a></h1>
184<div class="section"> 424<div class="section">
185<h2><a class="toc-backref" href="#id24" id="overview" name="overview">Overview</a></h2> 425<h2><a class="toc-backref" href="#id26" id="overview" name="overview">Overview</a></h2>
186<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>
187<ol class="arabic simple"> 427<ol class="arabic simple">
188<li>A news item is written. The format to be used is described below.</li> 428<li>A news item is written. The format to be used is described below.</li>
189<li>The news item is reviewed, following the process described in 429<li>The news item is reviewed, following the process described in
190<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>
… …
201<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
202Item Clients</a>.</li> 442Item Clients</a>.</li>
203</ol> 443</ol>
204</div> 444</div>
205<div class="section"> 445<div class="section">
206<h2><a class="toc-backref" href="#id25" id="required-portage-enhancements" name="required-portage-enhancements">Required Portage Enhancements</a></h2> 446<h2><a class="toc-backref" href="#id27" id="required-portage-enhancements" name="required-portage-enhancements">Required Portage Enhancements</a></h2>
207<p>The following extensions to Portage are required:</p> 447<p>The following extensions to Portage are required:</p>
208<ul class="simple"> 448<ul class="simple">
209<li>Every repository (including overlays) will require a unique identifier. It is 449<li>Every repository (including overlays) will require a unique identifier. It is
210assumed that an identifier will be a string consisting of characters from 450assumed that an identifier will be a string consisting of characters from
211<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) 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)
… …
217a repository with a given ID. It is assumed that this will be in the form of 457a repository with a given ID. It is assumed that this will be in the form of
218a <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> 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>
219<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 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
220given repository ID.</li> 460given repository ID.</li>
221<li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span></tt> to implement a command which returns whether 461<li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span></tt> to implement a command which returns whether
222or not the profile used for a given repository ID matches a certain base path 462or not the profile used for a given repository ID is exactly the given profile
223(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> <span class="pre">gentoo-x86</span></tt>).</li> 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>
224</ul> 465</ul>
225<p>These extensions are assumed during the following specification.</p> 466<p>These extensions are assumed during the following specification.</p>
226</div> 467</div>
227<div class="section"> 468<div class="section">
228<h2><a class="toc-backref" href="#id26" id="news-item-identities" name="news-item-identities">News Item Identities</a></h2> 469<h2><a class="toc-backref" href="#id28" id="news-item-identities" name="news-item-identities">News Item Identities</a></h2>
229<p>Each news item will have a unique identifier. This identifier will be in the 470<p>Each news item will have a unique identifier. This identifier will be in the
230form <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>), 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>),
231<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 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
232(<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 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
233news 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>, 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>,
234<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> 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>
235</div> 476</div>
236<div class="section"> 477<div class="section">
237<h2><a class="toc-backref" href="#id27" id="news-item-directories" name="news-item-directories">News Item Directories</a></h2> 478<h2><a class="toc-backref" href="#id29" id="news-item-directories" name="news-item-directories">News Item Directories</a></h2>
238<p>Each news item will be represented by a directory whose name is the same as the 479<p>Each news item will be represented by a directory whose name is the same as the
239news item's identifier.</p> 480news item's identifier.</p>
240<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 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
241contains the text of the news item, in English, in the format described below.</p> 482contains the text of the news item, in English, in the format described below.</p>
242<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> 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>
243(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) will also be 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
244provided. However, only the English version of a news item is authoritative. 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
245This anglocentricity is justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p> 487justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p>
246</div> 488</div>
247<div class="section"> 489<div class="section">
248<h2><a class="toc-backref" href="#id28" id="news-item-files" name="news-item-files">News Item Files</a></h2> 490<h2><a class="toc-backref" href="#id30" id="news-item-files" name="news-item-files">News Item Files</a></h2>
249<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 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
250compatibility with and for the same reasons as existing Gentoo documentation 492compatibility with and for the same reasons as existing Gentoo documentation
251<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> 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>
252<p>News items must be signed with a detached GPG signature.:</p> 494<p>News items must be signed with a detached GPG signature.:</p>
253<pre class="literal-block"> 495<pre class="literal-block">
… …
259<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> 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>
260followed 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
261various optional and mandatory headers. Future GLEPs may propose new headers — 503various optional and mandatory headers. Future GLEPs may propose new headers —
262tools handling these news items must ignore any unrecognised header.</p> 504tools handling these news items must ignore any unrecognised header.</p>
263<div class="section"> 505<div class="section">
264<h3><a class="toc-backref" href="#id29" id="news-item-headers" 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>
265<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>
266<dl class="docutils"> 508<dl class="docutils">
267<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>
268<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd> 510<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd>
269<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>
… …
274translator headers may be specified if appropriate.</dd> 516translator headers may be specified if appropriate.</dd>
275<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>
276<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>
277<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>
278<dd>Date of posting, in <tt class="docutils literal"><span class="pre">yyyy-mm-dd</span></tt> format (e.g. 2005-12-18) for 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
279compatibility with GLEP 45 <a class="footnote-reference" href="#glep-45" id="id11" name="id11">[10]</a>. 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>
280<dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt> 523<dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt>
281<dd>Initially 1. Should be incremented every time a change is made to the news 524<dd>Initially 1. Should be incremented every time a change is made to the news
282item. Changes that require a re-read of the news item (i.e., most changes 525item. Changes that require a re-read of the news item (i.e., most changes
283that are not spelling or formatting related) should instead use a new news 526that are not spelling or formatting related) should instead use a new news
284item. Mandatory.</dd> 527item. Mandatory.</dd>
… …
297<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>
298<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 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
299user is on the keyword in question, the news item should be displayed.</dd> 542user is on the keyword in question, the news item should be displayed.</dd>
300<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>
301<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
302user is using the exact profile in question, or a subprofile of this 545user is using the exact profile in question, the news item should be
303profile, the news item should be displayed. This header may be used to
304replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the future.</dd> 546displayed. This header may be used to replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the
547future.</dd>
305</dl> 548</dl>
306<div class="note"> 549<div class="note">
307<p class="first admonition-title">Note</p> 550<p class="first admonition-title">Note</p>
308<p class="last">When performing package moves, developers must also update any 551<p class="last">When performing package moves, developers must also update any
309relevant <tt class="docutils literal"><span class="pre">Display-If-Installed</span></tt> headers in news files.</p> 552relevant <tt class="docutils literal"><span class="pre">Display-If-Installed</span></tt> headers in news files.</p>
… …
326likely to occur than &quot;display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or 569likely to occur than &quot;display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or
327for 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 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
328people 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> 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>
329</div> 572</div>
330<div class="section"> 573<div class="section">
331<h3><a class="toc-backref" href="#id30" id="news-item-body" 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>
332<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
333text.</p> 576text.</p>
334<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
335characters 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
336terminal. Paragraphs should be separated by a blank line.</p> 579terminal. Paragraphs should be separated by a blank line.</p>
… …
339simply 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
340a 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
341administrated — this will be the case on many servers and routers, for example.</p> 584administrated — this will be the case on many servers and routers, for example.</p>
342</div> 585</div>
343<div class="section"> 586<div class="section">
344<h3><a class="toc-backref" href="#id31" id="example-news-item" 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>
345<p><a class="reference" href="glep-0042-extras/example-news-item.txt">This hypothetical news item</a> <a class="footnote-reference" href="#id18" id="id19" name="id19">[16]</a> 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
346<tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p> 589<tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p>
347</div> 590</div>
348</div> 591</div>
349<div class="section"> 592<div class="section">
350<h2><a class="toc-backref" href="#id32" id="news-item-quality-control" 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>
351<p>There have been complaints regarding the comprehensibility of some upgrade 594<p>There have been complaints regarding the comprehensibility of some upgrade
352notices 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
353developer 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,
354professionalism and avoiding making us look like prats, it is important that any 597professionalism and avoiding making us look like prats, it is important that any
355language problems be corrected before inflicting a news item upon end users.</p> 598language problems be corrected before inflicting a news item upon end users.</p>
… …
369Thus, 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
370YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p> 613YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p>
371</div> 614</div>
372</div> 615</div>
373<div class="section"> 616<div class="section">
374<h2><a class="toc-backref" href="#id33" id="news-item-distribution" 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>
375<div class="section"> 618<div class="section">
376<h3><a class="toc-backref" href="#id34" id="server-side" 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>
377<p>News items are to be made available via the standard rsync tree. This removes 620<p>News items are to be made available via the standard rsync tree. This removes
378any need for polling of a remote source.</p> 621any need for polling of a remote source.</p>
379<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),
380location 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
381GLEP.</p> 624GLEP.</p>
… …
396<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 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
397news item directories will all be immediately under the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> 640news item directories will all be immediately under the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt>
398directory.</p> 641directory.</p>
399</div> 642</div>
400<div class="section"> 643<div class="section">
401<h3><a class="toc-backref" href="#id35" id="client-side" 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>
402<p>Whenever relevant unread news items are found, the package manager will create a 645<p>Whenever relevant unread news items are found, the package manager will create a
403file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-${repoid}.unread</span></tt> (if it does not 646file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-${repoid}.unread</span></tt> (if it does not
404already exist) and append the news item identifier (eg 647already exist) and append the news item identifier (eg
405<tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p> 648<tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p>
406<p>All news item related files should be root owned and in the <tt class="docutils literal"><span class="pre">portage</span></tt> group 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
… …
432<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
433filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p> 676filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p>
434</div> 677</div>
435</div> 678</div>
436<div class="section"> 679<div class="section">
437<h2><a class="toc-backref" href="#id36" id="news-item-clients" 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>
438<p>Once a news item is marked for reading, third party tools (or traditional core 681<p>Once a news item is marked for reading, third party tools (or traditional core
439Unix tools) can be used to display and view the news files.</p> 682Unix tools) can be used to display and view the news files.</p>
440<p>When a news item is read, its name should be removed from the 683<p>When a news item is read, its name should be removed from the
441<tt class="docutils literal"><span class="pre">news-repoid.unread</span></tt> file. If a news client acts as an interactive reader 684<tt class="docutils literal"><span class="pre">news-${repoid}.unread</span></tt> file. If a news client acts as an interactive reader
442rather than a gateway, it should then add the name to a <tt class="docutils literal"><span class="pre">news-repoid.read</span></tt> 685rather than a gateway, it should then add the name to a <tt class="docutils literal"><span class="pre">news-${repoid}.read</span></tt>
443file in the same directory with the same file format.</p> 686file in the same directory with the same file format.</p>
444<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 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
445tool; other display tools (for example, a news to email forwarder, which would 688tool; other display tools (for example, a news to email forwarder, which would
446be ideal for users who sync on a <tt class="docutils literal"><span class="pre">cron</span></tt>) are left as options for those who 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
447desire them.</p> 690desire them.</p>
448</div> 691</div>
449<div class="section"> 692<div class="section">
450<h2><a class="toc-backref" href="#id37" id="news-item-removal" 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>
451<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
452they 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
453after 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>
454entries.</p> 697entries.</p>
455</div> 698</div>
456</div> 699</div>
457<div class="section"> 700<div class="section">
458<h1><a class="toc-backref" href="#id38" id="integration-with-existing-systems" 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>
459<p>It would be simple 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
460items 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>
461<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 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
462forums. A similar tool can be used for these news items.</p> 705forums. A similar tool can be used for these news items.</p>
463</div> 706</div>
464<div class="section"> 707<div class="section">
465<h1><a class="toc-backref" href="#id39" id="backwards-compatibility" 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>
466<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
467the <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>
468</div> 711</div>
469<div class="section"> 712<div class="section">
470<h1><a class="toc-backref" href="#id40" id="reference-implementation" 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>
471<div class="section"> 714<p>A reference implementation of the required package manager support can be found
472<h2><a class="toc-backref" href="#id41" id="portage-code" 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
473<p>TODO</p> 716eselect module <a class="footnote-reference" href="#eselect-news" id="id18" name="id18">[16]</a>.</p>
474</div> 717</div>
475<div class="section"> 718<div class="section">
476<h2><a class="toc-backref" href="#id42" id="simple-eselect-news-client" name="simple-eselect-news-client">Simple <tt class="docutils literal"><span class="pre">eselect</span></tt> News Client</a></h2>
477<p>TODO Removed until the exact format details are figured out.</p>
478</div>
479<div class="section">
480<h2><a class="toc-backref" href="#id43" id="simple-news-to-mail-forwarder" name="simple-news-to-mail-forwarder">Simple News to Mail Forwarder</a></h2>
481<p>TODO Removed until the exact format details are figured out.</p>
482</div>
483</div>
484<div class="section">
485<h1><a class="toc-backref" href="#id44" id="credits" name="credits">Credits</a></h1> 719<h1><a class="toc-backref" href="#id43" id="credits" name="credits">Credits</a></h1>
486<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
487Herbert <a class="footnote-reference" href="#stuart-blog" id="id17" name="id17">[15]</a>.</p> 721Herbert <a class="footnote-reference" href="#stuart-blog" id="id19" name="id19">[17]</a>.</p>
488<p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, 722<p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear,
489Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec 723Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec
490Warner for input. Some of the ideas presented here are theirs, others go 724Warner for input. Some of the ideas presented here are theirs, others go
491completely against their suggestions.</p> 725completely against their suggestions.</p>
492</div> 726</div>
493<div class="section"> 727<div class="section">
494<h1><a class="toc-backref" href="#id45" id="example-files" name="example-files">Example Files</a></h1> 728<h1><a class="toc-backref" href="#id44" id="example-files" name="example-files">Example Files</a></h1>
495<p>TODO Removed until the exact format details are figured out.</p> 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>
496</div> 733</div>
497<div class="section"> 734<div class="section">
498<h1><a class="toc-backref" href="#id46" id="references" name="references">References</a></h1> 735<h1><a class="toc-backref" href="#id45" id="references" name="references">References</a></h1>
499<table class="docutils footnote" frame="void" id="bug-11359" rules="none"> 736<table class="docutils footnote" frame="void" id="bug-11359" rules="none">
500<colgroup><col class="label" /><col /></colgroup> 737<colgroup><col class="label" /><col /></colgroup>
501<tbody valign="top"> 738<tbody valign="top">
502<tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359 739<tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359
503&quot;[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging&quot;, 740&quot;[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging&quot;,
… …
596<tbody valign="top"> 833<tbody valign="top">
597<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; 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;
598<a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr> 835<a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr>
599</tbody> 836</tbody>
600</table> 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>
848</tbody>
849</table>
601<table class="docutils footnote" frame="void" id="stuart-blog" rules="none"> 850<table class="docutils footnote" frame="void" id="stuart-blog" rules="none">
602<colgroup><col class="label" /><col /></colgroup> 851<colgroup><col class="label" /><col /></colgroup>
603<tbody valign="top"> 852<tbody valign="top">
604<tr><td class="label"><a class="fn-backref" href="#id17" name="stuart-blog">[15]</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,
605<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>
606</tbody> 855</tbody>
607</table> 856</table>
608<table class="docutils footnote" frame="void" id="id18" rules="none"> 857<table class="docutils footnote" frame="void" id="id20" rules="none">
609<colgroup><col class="label" /><col /></colgroup> 858<colgroup><col class="label" /><col /></colgroup>
610<tbody valign="top"> 859<tbody valign="top">
611<tr><td class="label"><a class="fn-backref" href="#id19" name="id18">[16]</a></td><td><a class="reference" href="glep-0042-extras/example-news-item.txt">glep-0042-extras/example-news-item.txt</a></td></tr> 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>
612</tbody> 861</tbody>
613</table> 862</table>
614</div> 863</div>
615<div class="section"> 864<div class="section">
616<h1><a class="toc-backref" href="#id47" id="copyright" name="copyright">Copyright</a></h1> 865<h1><a class="toc-backref" href="#id46" id="copyright" name="copyright">Copyright</a></h1>
617<p>This document has been placed in the public domain.</p> 866<p>This document has been placed in the public domain.</p>
618<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : --> 867<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
619</div> 868</div>
620 869
621</div> 870</div>
622<div class="footer"> 871<div class="footer">
623<hr class="footer" /> 872<hr class="footer" />
624<a class="reference" href="glep-0042.txt">View document source</a>. 873<a class="reference" href="glep-0042.txt">View document source</a>.
625Generated on: 2006-02-13 16:26 UTC. 874Generated on: 2006-09-05 20:36 UTC.
626Generated 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.
627 876
628</div> 877</div>
629</body> 878</body>
630</html> 879</html>
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.14
  ViewVC Help
Powered by ViewVC 1.1.20