/[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.6 Revision 1.12
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/06/12 22:03:32 $
19:version: $Revision: 1.12 $
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">$Revision: 1.6 $</td> 278<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.10</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;</td>
38</tr> 281</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">$Date: 2005/12/18 04:16:44 $</a></td> 282<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/06/12 22:03:07</a></td>
40</tr> 283</tr>
41<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 284<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
42</tr> 285</tr>
43<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 286<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
44</tr> 287</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> 288<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td>
46</tr> 289</tr>
47<tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td> 290<tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td>
48</tr> 291</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</td> 292<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</td>
50</tr> 293</tr>
51</tbody> 294</tbody>
52</table> 295</table>
53<hr /> 296<hr />
54<div class="contents topic" id="contents"> 297<div class="contents topic">
55<p class="topic-title first"><a name="contents">Contents</a></p> 298<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
56<ul class="simple"> 299<ul class="simple">
57<li><a class="reference" href="#abstract" id="id20" name="id20">Abstract</a></li> 300<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> 301<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> 302<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> 303<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> 304<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> 305<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> 306<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> 307<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> 308<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> 309<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> 310<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> 311<li><a class="reference" href="#example-news-item" id="id33" name="id33">Example News Item</a></li>
69</ul> 312</ul>
70</li> 313</li>
71<li><a class="reference" href="#news-item-quality-control" id="id32" name="id32">News Item Quality Control</a></li> 314<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> 315<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> 316<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> 317<li><a class="reference" href="#client-side" id="id37" name="id37">Client Side</a></li>
75</ul> 318</ul>
76</li> 319</li>
77<li><a class="reference" href="#news-item-clients" id="id36" name="id36">News Item Clients</a></li> 320<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> 321<li><a class="reference" href="#news-item-removal" id="id39" name="id39">News Item Removal</a></li>
79</ul> 322</ul>
80</li> 323</li>
81<li><a class="reference" href="#integration-with-existing-systems" id="id38" name="id38">Integration with Existing Systems</a></li> 324<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> 325<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> 326<li><a class="reference" href="#reference-implementation" id="id42" name="id42">Reference Implementation</a></li>
327<li><a class="reference" href="#credits" id="id43" name="id43">Credits</a></li>
328<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> 329<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> 330<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> 331</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> 332</div>
95<div class="section" id="abstract"> 333<div class="section">
96<h1><a class="toc-backref" href="#id20" name="abstract">Abstract</a></h1> 334<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 335<p>This GLEP proposes a new way of informing users about important updates and news
98regarding tree-related items.</p> 336related to the tree.</p>
99</div> 337</div>
100<div class="section" id="motivation"> 338<div class="section">
101<h1><a class="toc-backref" href="#id21" name="motivation">Motivation</a></h1> 339<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, 340<p>Although most package updates are clean and require little user action,
103occasionally an upgrade requires user intervention during the upgrade process. 341occasionally 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> 342latter 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> 343database format changes.</p>
106<p>There are currently several ways of delivering important news items to our 344<p>There are currently several ways of delivering important news items to our
107users, none of them particularly effective:</p> 345users, none of them particularly effective:</p>
108<ul class="simple"> 346<ul class="simple">
109<li>Gentoo Weekly News</li> 347<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> 348<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> 350<li>The main Gentoo website</li>
113<li>RSS feeds of Gentoo news</li> 351<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> 352<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> 353</ul>
116<p>A more reliable way of getting news of critical updates out to users is required 354<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 355to 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> 356solution 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"> 357<div class="important">
120<p class="first admonition-title">Important</p> 358<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 359<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 360which 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> 361by <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> 362</div>
125</div> 363</div>
126<div class="section" id="requirements"> 364<div class="section">
127<h1><a class="toc-backref" href="#id22" name="requirements">Requirements</a></h1> 365<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> 366<p>An adequate solution must meet all of the following requirements:</p>
129<dl class="docutils"> 367<dl class="docutils">
130<dt>Preemptive</dt> 368<dt>Preemptive</dt>
131<dd>Users should be told of changes <em>before</em> they break a system, not after the 369<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 370damage has already been done. Ideally, the system administrator would be
133given ample warning to plan difficult upgrades and changes, rather than only 371given ample warning to plan difficult upgrades and changes, rather than only
134being told just before action is necessary.</dd> 372being told just before action is necessary.</dd>
135<dt>No user subscription required</dt> 373<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 374<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 375read 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> 376requires subscription has no advantage over current methods.</dd>
139<dt>No user monitoring required</dt> 377<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 378<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 379read 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 380until it is too late. A solution that relies upon active monitoring of a
177sources (for example, Forums, GWN, the main Gentoo website) without 415sources (for example, Forums, GWN, the main Gentoo website) without
178excessive difficulty. Similarly, easy interoperation with any future news 416excessive difficulty. Similarly, easy interoperation with any future news
179sources should not be precluded.</dd> 417sources should not be precluded.</dd>
180</dl> 418</dl>
181</div> 419</div>
182<div class="section" id="specification"> 420<div class="section">
183<h1><a class="toc-backref" href="#id23" name="specification">Specification</a></h1> 421<h1><a class="toc-backref" href="#id25" id="specification" name="specification">Specification</a></h1>
184<div class="section" id="overview"> 422<div class="section">
185<h2><a class="toc-backref" href="#id24" name="overview">Overview</a></h2> 423<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> 424<p>News items are published and delivered to users as follows:</p>
187<ol class="arabic simple"> 425<ol class="arabic simple">
188<li>A news item is written. The format to be used is described below.</li> 426<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 427<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> 428<a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li>
200informing the user that there are unread news items.</li> 438informing the user that there are unread news items.</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 439<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> 440Item Clients</a>.</li>
203</ol> 441</ol>
204</div> 442</div>
205<div class="section" id="required-portage-enhancements"> 443<div class="section">
206<h2><a class="toc-backref" href="#id25" name="required-portage-enhancements">Required Portage Enhancements</a></h2> 444<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> 445<p>The following extensions to Portage are required:</p>
208<p>TODO: ferringb wants spaces added to the first item on the list. I don't,
209because it makes repo id -&gt; filename mappings nasty.</p>
210<ul class="simple"> 446<ul class="simple">
211<li>Every repository (including overlays) will require a unique identifier. It is 447<li>Every repository (including overlays) will require a unique identifier. It is
212assumed that an identifier will be a string consisting of characters from 448assumed that an identifier will be a string consisting of characters from
213<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), 449<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)
214<tt class="docutils literal"><span class="pre">:</span></tt> (colon) and <tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</li> 450<tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</li>
215<li>Portage must provide a way for external programs to obtain a list of all 451<li>Portage must provide a way for external programs to obtain a list of all
216repository identifiers for a given system. It is assumed that this will be in 452repository identifiers for a given system. It is assumed that this will be in
217the 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> 453the 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>
218<li>Portage must provide a way for external programs to obtain the base path for 454<li>Portage must provide a way for external programs to obtain the base path for
219a repository with a given ID. It is assumed that this will be in the form of 455a repository with a given ID. It is assumed that this will be in the form of
220a <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> 456a <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>
221<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 457<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
222given repository ID.</li> 458given repository ID.</li>
223<li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span></tt> to implement a command which returns whether 459<li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span></tt> to implement a command which returns whether
224or not the profile used for a given repository ID matches a certain base path 460or not the profile used for a given repository ID is exactly the given profile
225(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> 461(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>
462<span class="pre">gentoo-x86</span></tt>).</li>
226</ul> 463</ul>
227<p>These extensions are assumed during the following specification.</p> 464<p>These extensions are assumed during the following specification.</p>
228</div> 465</div>
229<div class="section" id="news-item-identities"> 466<div class="section">
230<h2><a class="toc-backref" href="#id26" name="news-item-identities">News Item Identities</a></h2> 467<h2><a class="toc-backref" href="#id28" id="news-item-identities" name="news-item-identities">News Item Identities</a></h2>
231<p>Each news item will have a unique identifier. This identifier will be in the 468<p>Each news item will have a unique identifier. This identifier will be in the
232form <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>), 469form <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>),
233<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 470<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
234(<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 471(<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
235news 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>, 472news 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>,
236<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> (colon), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen) and <tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</p> 473<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>
237</div> 474</div>
238<div class="section" id="news-item-directories"> 475<div class="section">
239<h2><a class="toc-backref" href="#id27" name="news-item-directories">News Item Directories</a></h2> 476<h2><a class="toc-backref" href="#id29" id="news-item-directories" name="news-item-directories">News Item Directories</a></h2>
240<p>Each news item will be represented by a directory whose name is the same as the 477<p>Each news item will be represented by a directory whose name is the same as the
241news item's identifier.</p> 478news item's identifier.</p>
242<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 479<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
243contains the text of the news item, in English, in the format described below.</p> 480contains the text of the news item, in English, in the format described below.</p>
244<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> 481<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>
245(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 482(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
246provided. However, only the English version of a news item is authoritative. 483remains the same as the original news item) will also be provided. However, only
484the English version of a news item is authoritative. This anglocentricity is
247This anglocentricity is justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p> 485justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p>
248</div> 486</div>
249<div class="section" id="news-item-files"> 487<div class="section">
250<h2><a class="toc-backref" href="#id28" name="news-item-files">News Item Files</a></h2> 488<h2><a class="toc-backref" href="#id30" id="news-item-files" name="news-item-files">News Item Files</a></h2>
251<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 489<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
252compatibility with and for the same reasons as existing Gentoo documentation 490compatibility with and for the same reasons as existing Gentoo documentation
253<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> 491<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>
254<p>News items should be signed with a detached GPG signature:</p> 492<p>News items must be signed with a detached GPG signature.:</p>
255<pre class="literal-block"> 493<pre class="literal-block">
256gpg --armour --detach-sign ????-??-??-*.??.txt 494gpg --armour --detach-sign ????-??-??-*.??.txt
257</pre> 495</pre>
496<p>This GLEP does not specify the type or strength of signature to be used, nor
497does it discuss how, if at all, a centralised keychain will be provided. These
498issues should be handled as part of the signing policy discussions.</p>
258<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> 499<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>
259followed by the main body of the message as plain text. This GLEP defines 500followed by the main body of the message as plain text. This GLEP defines
260various optional and mandatory headers. Future GLEPs may propose new headers — 501various optional and mandatory headers. Future GLEPs may propose new headers —
261tools handling these news items must ignore any unrecognised header.</p> 502tools handling these news items must ignore any unrecognised header.</p>
262<div class="section" id="news-item-headers"> 503<div class="section">
263<h3><a class="toc-backref" href="#id29" name="news-item-headers">News Item Headers</a></h3> 504<h3><a class="toc-backref" href="#id31" id="news-item-headers" name="news-item-headers">News Item Headers</a></h3>
264<p>The following headers describe the purpose and format of the news item:</p> 505<p>The following headers describe the purpose and format of the news item:</p>
265<dl class="docutils"> 506<dl class="docutils">
266<dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt> 507<dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt>
267<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd> 508<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd>
268<dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt> 509<dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt>
273translator headers may be specified if appropriate.</dd> 514translator headers may be specified if appropriate.</dd>
274<dt><tt class="docutils literal"><span class="pre">Content-Type:</span></tt></dt> 515<dt><tt class="docutils literal"><span class="pre">Content-Type:</span></tt></dt>
275<dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd> 516<dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd>
276<dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt> 517<dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt>
277<dd>Date of posting, in <tt class="docutils literal"><span class="pre">yyyy-mm-dd</span></tt> format (e.g. 2005-12-18) for 518<dd>Date of posting, in <tt class="docutils literal"><span class="pre">yyyy-mm-dd</span></tt> format (e.g. 2005-12-18) for
278compatibility with GLEP 45 <a class="footnote-reference" href="#glep-45" id="id11" name="id11">[10]</a>. Mandatory.</dd> 519compatibility with GLEP 45 <a class="footnote-reference" href="#glep-45" id="id11" name="id11">[10]</a>. Translations should use the date
520of the original news item. Mandatory.</dd>
279<dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt> 521<dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt>
280<dd>Initially 1. Incremented every time a non-trivial change is made. Changes 522<dd>Initially 1. Should be incremented every time a change is made to the news
281which require a re-read of the news item should instead use a new news item 523item. Changes that require a re-read of the news item (i.e., most changes
524that are not spelling or formatting related) should instead use a new news
282file. Mandatory.</dd> 525item. Mandatory.</dd>
283<dt><tt class="docutils literal"><span class="pre">News-Item-Format:</span></tt></dt> 526<dt><tt class="docutils literal"><span class="pre">News-Item-Format:</span></tt></dt>
284<dd>Must be <tt class="docutils literal"><span class="pre">1.0</span></tt>. Future revisions to the format may increment the minor 527<dd>Must be <tt class="docutils literal"><span class="pre">1.0</span></tt>. Future revisions to the format may increment the minor
285number for backwards-compatible changes, or the major number for major 528number for backwards-compatible changes, or the major number for major
286changes.</dd> 529changes.</dd>
287</dl> 530</dl>
288<p>The following headers are used for filtering:</p> 531<p>The following headers are used for filtering:</p>
289<dl class="docutils"> 532<dl class="docutils">
290<dt><tt class="docutils literal"><span class="pre">Display-If-Installed:</span></tt></dt> 533<dt><tt class="docutils literal"><span class="pre">Display-If-Installed:</span></tt></dt>
291<dd>A dependency atom or simple package name (for example, 534<dd>A dependency atom (for example, <tt class="docutils literal"><span class="pre">&lt;dev-lang/php-5_alpha</span></tt> or
292<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 535<tt class="docutils literal"><span class="pre">net-www/apache</span></tt>). If the user has the package specified installed from
293package specified installed from the repository from which the news item was 536the repository from which the news item was obtained, the news item should
294obtained, the news item should be displayed.</dd> 537be displayed.</dd>
295<dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt> 538<dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt>
296<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 539<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
297user is on the keyword in question, the news item should be displayed.</dd> 540user is on the keyword in question, the news item should be displayed.</dd>
298<dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt> 541<dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt>
299<dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. If the 542<dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. If the
300user is using the exact profile in question, or a subprofile of this 543user is using the exact profile in question, the news item should be
301profile, the news item should be displayed. This header may be used to
302replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the future.</dd> 544displayed. This header may be used to replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the
545future.</dd>
303</dl> 546</dl>
304<div class="note"> 547<div class="note">
305<p class="first admonition-title">Note</p> 548<p class="first admonition-title">Note</p>
306<p class="last">When performing package moves, developers must also update any 549<p class="last">When performing package moves, developers must also update any
307relevant <tt class="docutils literal"><span class="pre">Display-If-Installed</span></tt> headers in news files.</p> 550relevant <tt class="docutils literal"><span class="pre">Display-If-Installed</span></tt> headers in news files.</p>
323simple to specify — it is believed that these kinds of condition are far more 566simple to specify — it is believed that these kinds of condition are far more
324likely to occur than &quot;display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or 567likely to occur than &quot;display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or
325for 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 568for 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
326people 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> 569people 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>
327</div> 570</div>
328<div class="section" id="news-item-body"> 571<div class="section">
329<h3><a class="toc-backref" href="#id30" name="news-item-body">News Item Body</a></h3> 572<h3><a class="toc-backref" href="#id32" id="news-item-body" name="news-item-body">News Item Body</a></h3>
330<p>The header section must be followed by a blank line, then the main body of the 573<p>The header section must be followed by a blank line, then the main body of the
331text.</p> 574text.</p>
332<p>The text body should be wrapped at 72 characters. No fancy formatting or tab 575<p>The text body should be wrapped at 72 characters. No fancy formatting or tab
333characters should be used — the news item may be being displayed directly to a 576characters should be used — the news item may be being displayed directly to a
334terminal. Paragraphs should be separated by a blank line.</p> 577terminal. Paragraphs should be separated by a blank line.</p>
335<p>Hyperlinks may be used to refer to further information (for example, an upgrade 578<p>Hyperlinks may be used to refer to further information (for example, an upgrade
336guide). However, the main body of the news item should be descriptive and not 579guide). However, the main body of the news item should be descriptive and not
337simply a &quot;read this link&quot; text. It is assumed that the user will have access to 580simply a &quot;read this link&quot; text. It is assumed that the user will have access to
338a web browser <em>somewhere</em>, but not necessarily on the box which is being 581a web browser <em>somewhere</em>, but not necessarily on the box which is being
339administrated — this will be the case on may servers and routers, for example.</p> 582administrated — this will be the case on many servers and routers, for example.</p>
340</div> 583</div>
341<div class="section" id="example-news-item"> 584<div class="section">
342<h3><a class="toc-backref" href="#id31" name="example-news-item">Example News Item</a></h3> 585<h3><a class="toc-backref" href="#id33" id="example-news-item" name="example-news-item">Example News Item</a></h3>
343<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 586<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
344<tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p> 587<tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p>
345</div> 588</div>
346</div> 589</div>
347<div class="section" id="news-item-quality-control"> 590<div class="section">
348<h2><a class="toc-backref" href="#id32" name="news-item-quality-control">News Item Quality Control</a></h2> 591<h2><a class="toc-backref" href="#id34" id="news-item-quality-control" name="news-item-quality-control">News Item Quality Control</a></h2>
349<p>There have been complaints regarding the comprehensibility of some upgrade 592<p>There have been complaints regarding the comprehensibility of some upgrade
350notices and news items in the past. This is understandable — not every Gentoo 593notices and news items in the past. This is understandable — not every Gentoo
351developer speaks English as a first language. However, for the sake of clarity, 594developer speaks English as a first language. However, for the sake of clarity,
352professionalism and avoiding making us look like prats, it is important that any 595professionalism and avoiding making us look like prats, it is important that any
353language problems be corrected before inflicting a news item upon end users.</p> 596language problems be corrected before inflicting a news item upon end users.</p>
354<p>Thus, at least 72 hours before a proposed news item is committed, it must be 597<p>Thus, at least 72 hours before a proposed news item is committed, it must be
355posted 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> 598posted 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>
356(exceptions may be made in exceptional circumstances). Any complaints — for 599(exceptions may be made in exceptional circumstances). Any complaints — for
357example regarding wording, clarity or accuracy — <strong>must</strong> be addressed before 600example regarding wording, clarity or accuracy — <strong>must</strong> be addressed before
358the news item goes live.</p> 601the news item goes live.</p>
359<div class="note">
360<p class="first admonition-title">Note</p>
361<p class="last">A previous draft of this GLEP allowed news items to be sent to
362<tt class="docutils literal"><span class="pre">gentoo-core</span></tt> instead of <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt>. It is possible that a situation
363may arise where this will be necessary (for example, a security update which
364must break backwards compatibility and which cannot be revealed to the public
365before a given date).</p>
366</div>
367<p>News items must only be for <strong>important</strong> changes that may cause serious upgrade 602<p>News items must only be for <strong>important</strong> changes that may cause serious upgrade
368or compatibility problems. Ordinary upgrade messages and non-critical news items 603or compatibility problems. Ordinary upgrade messages and non-critical news items
369should remain in <tt class="docutils literal"><span class="pre">einfo</span></tt> notices. The importance of the message to its 604should remain in <tt class="docutils literal"><span class="pre">einfo</span></tt> notices. The importance of the message to its
370intended audience should be justified with the proposal.</p> 605intended audience should be justified with the proposal.</p>
371<div class="important"> 606<div class="important">
374news items which are aimed at users of an uncommon package or architecture. 609news items which are aimed at users of an uncommon package or architecture.
375Thus, the justification should be in the form &quot;this message is important to 610Thus, the justification should be in the form &quot;this message is important to
376YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p> 611YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p>
377</div> 612</div>
378</div> 613</div>
379<div class="section" id="news-item-distribution"> 614<div class="section">
380<h2><a class="toc-backref" href="#id33" name="news-item-distribution">News Item Distribution</a></h2> 615<h2><a class="toc-backref" href="#id35" id="news-item-distribution" name="news-item-distribution">News Item Distribution</a></h2>
381<div class="section" id="server-side"> 616<div class="section">
382<h3><a class="toc-backref" href="#id34" name="server-side">Server Side</a></h3> 617<h3><a class="toc-backref" href="#id36" id="server-side" name="server-side">Server Side</a></h3>
383<p>News items are to be made available via the standard rsync tree. This removes 618<p>News items are to be made available via the standard rsync tree. This removes
384any need for polling of a remote source.</p> 619any need for polling of a remote source.</p>
385<p>A new repository will be created for news items. The type (CVS or Subversion), 620<p>A new repository will be created for news items. The type (CVS or Subversion),
386location and access controls on this repository are beyond the scope of this 621location and access controls on this repository are beyond the scope of this
387GLEP.</p> 622GLEP.</p>
394<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 629<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
395the current year and <tt class="docutils literal"><span class="pre">mm</span></tt> is the current month number (01 for January through 630the current year and <tt class="docutils literal"><span class="pre">mm</span></tt> is the current month number (01 for January through
39612 for December). This separation will help keep news items more manageable.</p> 63112 for December). This separation will help keep news items more manageable.</p>
397<p>The contents of this repository will automatically be merged with the main rsync 632<p>The contents of this repository will automatically be merged with the main rsync
398tree, placing the items in a <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory. The method used for 633tree, placing the items in a <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory. The method used for
399merging these items is beyond the scope of this GLEP — a similar setup is 634merging these items and the frequency at which it will occur is beyond the scope
400already used for merging GLSAs into the rsync tree.</p> 635of this GLEP; a similar setup is already used for merging GLSAs into the rsync
636tree.</p>
401<p>The main rsync tree will <strong>not</strong> use the <tt class="docutils literal"><span class="pre">yyyy/mm/</span></tt> subdirectory layout.</p> 637<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
638news item directories will all be immediately under the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt>
639directory.</p>
402</div> 640</div>
403<div class="section" id="client-side"> 641<div class="section">
404<h3><a class="toc-backref" href="#id35" name="client-side">Client Side</a></h3> 642<h3><a class="toc-backref" href="#id37" id="client-side" name="client-side">Client Side</a></h3>
405<p>Whenever relevant unread news items are found, the package manager will create a 643<p>Whenever relevant unread news items are found, the package manager will create a
406file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-repoid.unread</span></tt> (if it does not 644file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-${repoid}.unread</span></tt> (if it does not
407already exist) and append the news item identifier (eg 645already exist) and append the news item identifier (eg
408<tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p> 646<tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p>
647<p>All news item related files should be root owned and in the <tt class="docutils literal"><span class="pre">portage</span></tt> group
648with the group write (and, for directories, execute) bits set. News files should
649be world readable.</p>
409<p>Notification that new relevant news items will be displayed via the 650<p>Notification that new relevant news items will be displayed via the
410<tt class="docutils literal"><span class="pre">emerge</span></tt> tool in a similar way to the existing &quot;configuration files need 651<tt class="docutils literal"><span class="pre">emerge</span></tt> tool in a similar way to the existing &quot;configuration files need
411updating&quot; messages:</p> 652updating&quot; messages:</p>
412<pre class="literal-block"> 653<pre class="literal-block">
413* Important: there are 5 unread news items. 654* Important: there are 5 unread news items.
416<p>Checks for new news messages should be displayed:</p> 657<p>Checks for new news messages should be displayed:</p>
417<ul class="simple"> 658<ul class="simple">
418<li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">sync</span></tt></li> 659<li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">sync</span></tt></li>
419<li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">--pretend</span></tt></li> 660<li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">--pretend</span></tt></li>
420<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> 661<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>
421<li>Before an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">--ask</span> <span class="pre">&lt;target&gt;</span></tt> sequence</li>
422</ul> 662</ul>
663<p>The package manager does not need to know how to launch the user's choice of
664news client. This is consistent with the way configuration file updates are
665handled.</p>
423<p>The package manager may use a timestamp check file to avoid having to process 666<p>The package manager may use a timestamp check file to avoid having to process
424news items unnecessarily.</p> 667news items unnecessarily.</p>
425<p>The package manager must keep track of news items that have already been added 668<p>The package manager must keep track of news items that have already been added
426to the unread list to avoid repeatedly marking a deleted news item. This could 669to the unread list to avoid repeatedly marking a deleted news item. This could
427be handled via a <tt class="docutils literal"><span class="pre">news-repoid.skip</span></tt> file containing the IDs of news items that 670be handled via a <tt class="docutils literal"><span class="pre">news-${repoid}.skip</span></tt> file containing the IDs of news items
428have already been added to a <tt class="docutils literal"><span class="pre">news-repoid.unread</span></tt> file, but this method is not 671that have already been added to a <tt class="docutils literal"><span class="pre">news-${repoid}.unread</span></tt> file, but this
429required by this GLEP.</p> 672method is not required by this GLEP.</p>
430<p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to 673<p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to
431filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p> 674filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p>
432</div> 675</div>
433</div> 676</div>
434<div class="section" id="news-item-clients"> 677<div class="section">
435<h2><a class="toc-backref" href="#id36" name="news-item-clients">News Item Clients</a></h2> 678<h2><a class="toc-backref" href="#id38" id="news-item-clients" name="news-item-clients">News Item Clients</a></h2>
436<p>Once a news item is marked for reading, third party tools (or traditional core 679<p>Once a news item is marked for reading, third party tools (or traditional core
437Unix tools) can be used to display and view the news files.</p> 680Unix tools) can be used to display and view the news files.</p>
438<p>When a news item is read, its name should be removed from the 681<p>When a news item is read, its name should be removed from the
439<tt class="docutils literal"><span class="pre">news-repoid.unread</span></tt> file. If a news client acts as an interactive reader 682<tt class="docutils literal"><span class="pre">news-${repoid}.unread</span></tt> file. If a news client acts as an interactive reader
440rather than a gateway, it should then add the name to a <tt class="docutils literal"><span class="pre">news-repoid.read</span></tt> 683rather than a gateway, it should then add the name to a <tt class="docutils literal"><span class="pre">news-${repoid}.read</span></tt>
441file in the same directory with the same file format.</p> 684file in the same directory with the same file format.</p>
442<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 685<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
443tool; other display tools (for example, a news to email forwarder, which would 686tool; other display tools (for example, a news to email forwarder, which would
444be ideal for users who sync on a <tt class="docutils literal"><span class="pre">cron</span></tt>) are left as options for those who 687be ideal for users who sync on a <tt class="docutils literal"><span class="pre">cron</span></tt>) are left as options for those who
445desire them.</p> 688desire them.</p>
446</div> 689</div>
447<div class="section" id="news-item-removal"> 690<div class="section">
448<h2><a class="toc-backref" href="#id37" name="news-item-removal">News Item Removal</a></h2> 691<h2><a class="toc-backref" href="#id39" id="news-item-removal" name="news-item-removal">News Item Removal</a></h2>
449<p>News items can be removed (by removing the news file from the main tree) when 692<p>News items can be removed (by removing the news file from the main tree) when
450they are no longer relevant, if they are made obsolete by a future news item or 693they are no longer relevant, if they are made obsolete by a future news item or
451after a long period of time. This is the same as the method used for <tt class="docutils literal"><span class="pre">updates</span></tt> 694after a long period of time. This is the same as the method used for <tt class="docutils literal"><span class="pre">updates</span></tt>
452entries.</p> 695entries.</p>
453</div> 696</div>
454</div> 697</div>
455<div class="section" id="integration-with-existing-systems"> 698<div class="section">
456<h1><a class="toc-backref" href="#id38" name="integration-with-existing-systems">Integration with Existing Systems</a></h1> 699<h1><a class="toc-backref" href="#id40" id="integration-with-existing-systems" name="integration-with-existing-systems">Integration with Existing Systems</a></h1>
457<p>It would be simple to convert these news items into the format used for news 700<p>It would be simple to convert these news items into the format used for news
458items on the Gentoo website or posts for the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list.</p> 701items on the Gentoo website or posts for the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list.</p>
459<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 702<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
460forums. A similar tool can be used for these news items.</p> 703forums. A similar tool can be used for these news items.</p>
461</div> 704</div>
462<div class="section" id="backwards-compatibility"> 705<div class="section">
463<h1><a class="toc-backref" href="#id39" name="backwards-compatibility">Backwards Compatibility</a></h1> 706<h1><a class="toc-backref" href="#id41" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
464<p>Backwards compatibility is not a concern here. Existing tools will simply ignore 707<p>Backwards compatibility is not a concern here. Existing tools will simply ignore
465the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p> 708the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p>
466</div> 709</div>
467<div class="section" id="reference-implementation"> 710<div class="section">
468<h1><a class="toc-backref" href="#id40" name="reference-implementation">Reference Implementation</a></h1> 711<h1><a class="toc-backref" href="#id42" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1>
469<div class="section" id="portage-code"> 712<p>A reference implementation of the required package manager support can be found
470<h2><a class="toc-backref" href="#id41" name="portage-code">Portage Code</a></h2> 713in Paludis <a class="footnote-reference" href="#paludis" id="id17" name="id17">[15]</a>, along with a reference newsreader implemented as an
471<p>TODO</p> 714eselect module <a class="footnote-reference" href="#eselect-news" id="id18" name="id18">[16]</a>.</p>
472</div> 715</div>
473<div class="section" id="simple-eselect-news-client">
474<h2><a class="toc-backref" href="#id42" name="simple-eselect-news-client">Simple <tt class="docutils literal docutils literal"><span class="pre">eselect</span></tt> News Client</a></h2>
475<p>TODO Removed until the exact format details are figured out.</p>
476</div>
477<div class="section" id="simple-news-to-mail-forwarder">
478<h2><a class="toc-backref" href="#id43" name="simple-news-to-mail-forwarder">Simple News to Mail Forwarder</a></h2>
479<p>TODO Removed until the exact format details are figured out.</p>
480</div>
481</div>
482<div class="section" id="credits"> 716<div class="section">
483<h1><a class="toc-backref" href="#id44" name="credits">Credits</a></h1> 717<h1><a class="toc-backref" href="#id43" id="credits" name="credits">Credits</a></h1>
484<p>The idea behind notifying users of news updates via Portage comes from Stuart 718<p>The idea behind notifying users of news updates via Portage comes from Stuart
485Herbert <a class="footnote-reference" href="#stuart-blog" id="id17" name="id17">[15]</a>.</p> 719Herbert <a class="footnote-reference" href="#stuart-blog" id="id19" name="id19">[17]</a>.</p>
486<p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, 720<p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear,
487Brian Harring, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec Warner for 721Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec
488input. Some of the ideas presented here are theirs, others go completely 722Warner for input. Some of the ideas presented here are theirs, others go
489against their suggestions.</p> 723completely against their suggestions.</p>
490</div> 724</div>
491<div class="section" id="example-files"> 725<div class="section">
492<h1><a class="toc-backref" href="#id45" name="example-files">Example Files</a></h1> 726<h1><a class="toc-backref" href="#id44" id="example-files" name="example-files">Example Files</a></h1>
493<p>TODO Removed until the exact format details are figured out.</p> 727<dl class="docutils">
728<dt><a class="reference" href="glep-0042-extras/example-news-item.txt">example-news-item.txt</a></dt>
729<dd>An example news item.</dd>
730</dl>
494</div> 731</div>
495<div class="section" id="references"> 732<div class="section">
496<h1><a class="toc-backref" href="#id46" name="references">References</a></h1> 733<h1><a class="toc-backref" href="#id45" id="references" name="references">References</a></h1>
497<table class="docutils footnote" frame="void" id="bug-11359" rules="none"> 734<table class="docutils footnote" frame="void" id="bug-11359" rules="none">
498<colgroup><col class="label" /><col /></colgroup> 735<colgroup><col class="label" /><col /></colgroup>
499<tbody valign="top"> 736<tbody valign="top">
500<tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359 737<tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359
501&quot;[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging&quot;, 738&quot;[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging&quot;,
594<tbody valign="top"> 831<tbody valign="top">
595<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; 832<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;
596<a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr> 833<a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr>
597</tbody> 834</tbody>
598</table> 835</table>
836<table class="docutils footnote" frame="void" id="paludis" rules="none">
837<colgroup><col class="label" /><col /></colgroup>
838<tbody valign="top">
839<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>
840</tbody>
841</table>
842<table class="docutils footnote" frame="void" id="eselect-news" rules="none">
843<colgroup><col class="label" /><col /></colgroup>
844<tbody valign="top">
845<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>
846</tbody>
847</table>
599<table class="docutils footnote" frame="void" id="stuart-blog" rules="none"> 848<table class="docutils footnote" frame="void" id="stuart-blog" rules="none">
600<colgroup><col class="label" /><col /></colgroup> 849<colgroup><col class="label" /><col /></colgroup>
601<tbody valign="top"> 850<tbody valign="top">
602<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, 851<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,
603<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> 852<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>
604</tbody> 853</tbody>
605</table> 854</table>
606<table class="docutils footnote" frame="void" id="id18" rules="none"> 855<table class="docutils footnote" frame="void" id="id20" rules="none">
607<colgroup><col class="label" /><col /></colgroup> 856<colgroup><col class="label" /><col /></colgroup>
608<tbody valign="top"> 857<tbody valign="top">
609<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> 858<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>
610</tbody> 859</tbody>
611</table> 860</table>
612</div> 861</div>
613<div class="section" id="copyright"> 862<div class="section">
614<h1><a class="toc-backref" href="#id47" name="copyright">Copyright</a></h1> 863<h1><a class="toc-backref" href="#id46" id="copyright" name="copyright">Copyright</a></h1>
615<p>This document has been placed in the public domain.</p> 864<p>This document has been placed in the public domain.</p>
616<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : --> 865<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
617</div> 866</div>
618 867
619</div> 868</div>
620<div class="footer"> 869<div class="footer">
621<hr class="footer" /> 870<hr class="footer" />
622<a class="reference" href="glep-0042.txt">View document source</a>. 871<a class="reference" href="glep-0042.txt">View document source</a>.
623Generated on: 2005-12-18 04:15 UTC. 872Generated on: 2006-06-12 22:11 UTC.
624Generated 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. 873Generated 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.
625 874
626</div> 875</div>
627</body> 876</body>
628</html> 877</html>

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.12

  ViewVC Help
Powered by ViewVC 1.1.20