/[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.5 Revision 1.8
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 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14</head> 14</head>
15<body bgcolor="white"> 15<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 16<table class="navigation" cellpadding="0" cellspacing="0"
19<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> 19<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" 20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td> 21 border="0" width="150" height="35" /></a></td>
22<td class="textlinks" align="left"> 22<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 23[<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>] 24[<b><a href="http://www.gentoo.org/peps">GLEP Index</a></b>]
25[<b><a href="./glep-0042.txt">GLEP Source</a></b>] 25[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0042.txt">GLEP Source</a></b>]
26</td></tr></table> 26</td></tr></table>
27<table class="rfc2822 docutils field-list" frame="void" rules="none"> 27<table class="rfc2822 docutils field-list" frame="void" rules="none">
28<col class="field-name" /> 28<col class="field-name" />
29<col class="field-body" /> 29<col class="field-body" />
30<tbody valign="top"> 30<tbody valign="top">
31<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td> 31<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td>
32</tr> 32</tr>
33<tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td> 33<tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td>
34</tr> 34</tr>
35<tr class="field"><th class="field-name">Version:</th><td class="field-body">$Revision: 1.5 $</td> 35<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.7</td>
36</tr> 36</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> 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>
38</tr> 38</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/13 03:21:59 $</a></td> 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>
40</tr> 40</tr>
41<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 41<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
42</tr> 42</tr>
43<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 43<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
44</tr> 44</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> 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>
46</tr> 46</tr>
47<tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td> 47<tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td>
48</tr> 48</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</td> 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>
50</tr> 50</tr>
51</tbody> 51</tbody>
52</table> 52</table>
53<hr /> 53<hr />
54<div class="contents topic" id="contents"> 54<div class="contents topic">
55<p class="topic-title first"><a name="contents">Contents</a></p> 55<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
56<ul class="simple"> 56<ul class="simple">
57<li><a class="reference" href="#abstract" id="id20" name="id20">Abstract</a></li> 57<li><a class="reference" href="#abstract" id="id20" name="id20">Abstract</a></li>
58<li><a class="reference" href="#motivation" id="id21" name="id21">Motivation</a></li> 58<li><a class="reference" href="#motivation" id="id21" name="id21">Motivation</a></li>
59<li><a class="reference" href="#requirements" id="id22" name="id22">Requirements</a></li> 59<li><a class="reference" href="#requirements" id="id22" name="id22">Requirements</a></li>
60<li><a class="reference" href="#specification" id="id23" name="id23">Specification</a><ul> 60<li><a class="reference" href="#specification" id="id23" name="id23">Specification</a><ul>
61<li><a class="reference" href="#overview" id="id24" name="id24">Overview</a></li> 61<li><a class="reference" href="#overview" id="id24" name="id24">Overview</a></li>
62<li><a class="reference" href="#required-portage-enhancements" id="id25" name="id25">Required Portage Enhancements</a></li>
62<li><a class="reference" href="#news-item-identities" id="id25" name="id25">News Item Identities</a></li> 63<li><a class="reference" href="#news-item-identities" id="id26" name="id26">News Item Identities</a></li>
63<li><a class="reference" href="#news-item-directories" id="id26" name="id26">News Item Directories</a></li> 64<li><a class="reference" href="#news-item-directories" id="id27" name="id27">News Item Directories</a></li>
64<li><a class="reference" href="#news-item-files" id="id27" name="id27">News Item Files</a><ul> 65<li><a class="reference" href="#news-item-files" id="id28" name="id28">News Item Files</a><ul>
65<li><a class="reference" href="#news-item-headers" id="id28" name="id28">News Item Headers</a></li> 66<li><a class="reference" href="#news-item-headers" id="id29" name="id29">News Item Headers</a></li>
66<li><a class="reference" href="#news-item-body" id="id29" name="id29">News Item Body</a></li> 67<li><a class="reference" href="#news-item-body" id="id30" name="id30">News Item Body</a></li>
67<li><a class="reference" href="#example-news-item" id="id30" name="id30">Example News Item</a></li> 68<li><a class="reference" href="#example-news-item" id="id31" name="id31">Example News Item</a></li>
68</ul> 69</ul>
69</li> 70</li>
70<li><a class="reference" href="#news-item-quality-control" id="id31" name="id31">News Item Quality Control</a></li> 71<li><a class="reference" href="#news-item-quality-control" id="id32" name="id32">News Item Quality Control</a></li>
71<li><a class="reference" href="#news-item-distribution" id="id32" name="id32">News Item Distribution</a><ul> 72<li><a class="reference" href="#news-item-distribution" id="id33" name="id33">News Item Distribution</a><ul>
72<li><a class="reference" href="#server-side" id="id33" name="id33">Server Side</a></li> 73<li><a class="reference" href="#server-side" id="id34" name="id34">Server Side</a></li>
73<li><a class="reference" href="#client-side" id="id34" name="id34">Client Side</a></li> 74<li><a class="reference" href="#client-side" id="id35" name="id35">Client Side</a></li>
74</ul> 75</ul>
75</li> 76</li>
76<li><a class="reference" href="#news-item-clients" id="id35" name="id35">News Item Clients</a></li> 77<li><a class="reference" href="#news-item-clients" id="id36" name="id36">News Item Clients</a></li>
77<li><a class="reference" href="#news-item-removal" id="id36" name="id36">News Item Removal</a></li> 78<li><a class="reference" href="#news-item-removal" id="id37" name="id37">News Item Removal</a></li>
78</ul> 79</ul>
79</li> 80</li>
80<li><a class="reference" href="#integration-with-existing-systems" id="id37" name="id37">Integration with Existing Systems</a></li> 81<li><a class="reference" href="#integration-with-existing-systems" id="id38" name="id38">Integration with Existing Systems</a></li>
81<li><a class="reference" href="#backwards-compatibility" id="id38" name="id38">Backwards Compatibility</a></li> 82<li><a class="reference" href="#backwards-compatibility" id="id39" name="id39">Backwards Compatibility</a></li>
82<li><a class="reference" href="#reference-implementation" id="id39" name="id39">Reference Implementation</a><ul> 83<li><a class="reference" href="#reference-implementation" id="id40" name="id40">Reference Implementation</a><ul>
83<li><a class="reference" href="#portage-code" id="id40" name="id40">Portage Code</a></li> 84<li><a class="reference" href="#portage-code" id="id41" name="id41">Portage Code</a></li>
84<li><a class="reference" href="#simple-eselect-news-client" id="id41" name="id41">Simple <tt class="docutils literal"><span class="pre">eselect</span></tt> News Client</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>
85<li><a class="reference" href="#simple-news-to-mail-forwarder" id="id42" name="id42">Simple News to Mail Forwarder</a></li> 86<li><a class="reference" href="#simple-news-to-mail-forwarder" id="id43" name="id43">Simple News to Mail Forwarder</a></li>
86</ul> 87</ul>
87</li> 88</li>
88<li><a class="reference" href="#credits" id="id43" name="id43">Credits</a></li> 89<li><a class="reference" href="#credits" id="id44" name="id44">Credits</a></li>
89<li><a class="reference" href="#example-files" id="id44" name="id44">Example Files</a></li> 90<li><a class="reference" href="#example-files" id="id45" name="id45">Example Files</a></li>
90<li><a class="reference" href="#references" id="id45" name="id45">References</a></li> 91<li><a class="reference" href="#references" id="id46" name="id46">References</a></li>
91<li><a class="reference" href="#copyright" id="id46" name="id46">Copyright</a></li> 92<li><a class="reference" href="#copyright" id="id47" name="id47">Copyright</a></li>
92</ul> 93</ul>
93</div> 94</div>
94<div class="section" id="abstract"> 95<div class="section">
95<h1><a class="toc-backref" href="#id20" name="abstract">Abstract</a></h1> 96<h1><a class="toc-backref" href="#id20" id="abstract" name="abstract">Abstract</a></h1>
96<p>This GLEP proposes a new way of informing users about important updates and news 97<p>This GLEP proposes a new way of informing users about important updates and news
97regarding tree-related items.</p> 98regarding tree-related items.</p>
98</div> 99</div>
99<div class="section" id="motivation"> 100<div class="section">
100<h1><a class="toc-backref" href="#id21" name="motivation">Motivation</a></h1> 101<h1><a class="toc-backref" href="#id21" id="motivation" name="motivation">Motivation</a></h1>
101<p>Although most package updates are clean and require little user action, 102<p>Although most package updates are clean and require little user action,
102occasionally an upgrade requires user intervention during the upgrade process. 103occasionally an upgrade requires user intervention during the upgrade process.
103Recent 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> 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>
104and the <tt class="docutils literal"><span class="pre">mysql-4.1</span></tt> database format changes.</p> 105and the <tt class="docutils literal"><span class="pre">mysql-4.1</span></tt> database format changes.</p>
105<p>There are currently several ways of delivering important news items to our 106<p>There are currently several ways of delivering important news items to our
120<p class="last">This GLEP does not seek to replace or modify <tt class="docutils literal"><span class="pre">einfo</span></tt> messages 121<p class="last">This GLEP does not seek to replace or modify <tt class="docutils literal"><span class="pre">einfo</span></tt> messages
121which are displayed post-install. That is a separate issue which is handled 122which are displayed post-install. That is a separate issue which is handled
122by <tt class="docutils literal"><span class="pre">elog</span></tt> <a class="footnote-reference" href="#bug-11359" id="id1" name="id1">[1]</a>.</p> 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>
123</div> 124</div>
124</div> 125</div>
125<div class="section" id="requirements"> 126<div class="section">
126<h1><a class="toc-backref" href="#id22" name="requirements">Requirements</a></h1> 127<h1><a class="toc-backref" href="#id22" id="requirements" name="requirements">Requirements</a></h1>
127<p>An adequate solution must meet all of the following requirements:</p> 128<p>An adequate solution must meet all of the following requirements:</p>
128<dl class="docutils"> 129<dl class="docutils">
129<dt>Preemptive</dt> 130<dt>Preemptive</dt>
130<dd>Users should be told of changes <em>before</em> they break a system, not after the 131<dd>Users should be told of changes <em>before</em> they break a system, not after the
131damage has already been done. Ideally, the system administrator would be 132damage has already been done. Ideally, the system administrator would be
176sources (for example, Forums, GWN, the main Gentoo website) without 177sources (for example, Forums, GWN, the main Gentoo website) without
177excessive difficulty. Similarly, easy interoperation with any future news 178excessive difficulty. Similarly, easy interoperation with any future news
178sources should not be precluded.</dd> 179sources should not be precluded.</dd>
179</dl> 180</dl>
180</div> 181</div>
181<div class="section" id="specification"> 182<div class="section">
182<h1><a class="toc-backref" href="#id23" name="specification">Specification</a></h1> 183<h1><a class="toc-backref" href="#id23" id="specification" name="specification">Specification</a></h1>
183<div class="section" id="overview"> 184<div class="section">
184<h2><a class="toc-backref" href="#id24" name="overview">Overview</a></h2> 185<h2><a class="toc-backref" href="#id24" id="overview" name="overview">Overview</a></h2>
185<p>News items are published and delivered to users as follows:</p> 186<p>News items are published and delivered to users as follows:</p>
186<ol class="arabic simple"> 187<ol class="arabic simple">
187<li>A news item is written. The format to be used is described below.</li> 188<li>A news item is written. The format to be used is described below.</li>
188<li>The news item is reviewed, following the process described in 189<li>The news item is reviewed, following the process described in
189<a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li> 190<a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li>
190<li>The news item is committed to a CVS (or Subversion <a class="footnote-reference" href="#glep-36" id="id4" name="id4">[10]</a>) repository. 191<li>The news item is committed to a CVS (or Subversion <a class="footnote-reference" href="#glep-36" id="id4" name="id4">[9]</a>) repository.
191From here, it is merged with the rsync tree. This is described in <a class="reference" href="#news-item-distribution">News Item 192From here, it is merged with the rsync tree. This is described in <a class="reference" href="#news-item-distribution">News Item
192Distribution</a>.</li> 193Distribution</a>.</li>
193<li>Users fetch the news item when they sync. This ensures that the news items in 194<li>Users fetch the news item when they sync. This ensures that the news items in
194question are pushed to the user before the user accidentally makes an 195question are pushed to the user before the user accidentally makes an
195unwanted change. No changes to the existing rsync process are required by 196unwanted change. No changes to the existing rsync process are required by
199informing the user that there are unread news items.</li> 200informing the user that there are unread news items.</li>
200<li>The news item is handled by the user's choice of news item reader. See <a class="reference" href="#news-item-clients">News 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
201Item Clients</a>.</li> 202Item Clients</a>.</li>
202</ol> 203</ol>
203</div> 204</div>
204<div class="section" id="news-item-identities"> 205<div class="section">
206<h2><a class="toc-backref" href="#id25" id="required-portage-enhancements" name="required-portage-enhancements">Required Portage Enhancements</a></h2>
207<p>The following extensions to Portage are required:</p>
208<ul class="simple">
209<li>Every repository (including overlays) will require a unique identifier. It is
210assumed 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)
212<tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</li>
213<li>Portage must provide a way for external programs to obtain a list of all
214repository identifiers for a given system. It is assumed that this will be in
215the 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>
216<li>Portage must provide a way for external programs to obtain the base path for
217a 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>
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
220given 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
222or not the profile used for a given repository ID matches a certain base path
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>
224</ul>
225<p>These extensions are assumed during the following specification.</p>
226</div>
227<div class="section">
205<h2><a class="toc-backref" href="#id25" name="news-item-identities">News Item Identities</a></h2> 228<h2><a class="toc-backref" href="#id26" id="news-item-identities" name="news-item-identities">News Item Identities</a></h2>
206<p>Each news item will have a unique identifier. This identifier will be in the 229<p>Each news item will have a unique identifier. This identifier will be in the
207form <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>), 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>),
208<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 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
209(<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 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
210news 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>, 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>,
211<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) and <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen).</p> 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>
212</div> 235</div>
213<div class="section" id="news-item-directories"> 236<div class="section">
214<h2><a class="toc-backref" href="#id26" name="news-item-directories">News Item Directories</a></h2> 237<h2><a class="toc-backref" href="#id27" id="news-item-directories" name="news-item-directories">News Item Directories</a></h2>
215<p>Each news item will be represented by a directory whose name is the same as the 238<p>Each news item will be represented by a directory whose name is the same as the
216news item's identifier.</p> 239news item's identifier.</p>
217<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 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
218contains the text of the news item, in English, in the format described below.</p> 241contains the text of the news item, in English, in the format described below.</p>
219<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> 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>
220(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 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
221provided. However, only the English version of a news item is authoritative. 244provided. However, only the English version of a news item is authoritative.
222This anglocentricity is justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[9]</a>.</p> 245This anglocentricity is justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p>
223</div> 246</div>
224<div class="section" id="news-item-files"> 247<div class="section">
225<h2><a class="toc-backref" href="#id27" name="news-item-files">News Item Files</a></h2> 248<h2><a class="toc-backref" href="#id28" id="news-item-files" name="news-item-files">News Item Files</a></h2>
226<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 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
227compatibility with and for the same reasons as existing Gentoo documentation 250compatibility with and for the same reasons as existing Gentoo documentation
228<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">[8]</a>.</p> 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>
229<p>News items should be signed with a detached GPG signature:</p> 252<p>News items must be signed with a detached GPG signature.:</p>
230<pre class="literal-block"> 253<pre class="literal-block">
231gpg --armour --detach-sign ????-??-??-*.??.txt 254gpg --armour --detach-sign ????-??-??-*.??.txt
232</pre> 255</pre>
256<p>This GLEP does not specify the type or strength of signature to be used, nor
257does it discuss how, if at all, a centralised keychain will be provided. These
258issues should be handled as part of the signing policy discussions.</p>
233<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> 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>
234followed by the main body of the message as plain text. This GLEP defines 260followed by the main body of the message as plain text. This GLEP defines
235various optional and mandatory headers. Future GLEPs may propose new headers — 261various optional and mandatory headers. Future GLEPs may propose new headers —
236tools handling these news items must ignore any unrecognised header.</p> 262tools handling these news items must ignore any unrecognised header.</p>
237<div class="section" id="news-item-headers"> 263<div class="section">
238<h3><a class="toc-backref" href="#id28" name="news-item-headers">News Item Headers</a></h3> 264<h3><a class="toc-backref" href="#id29" id="news-item-headers" name="news-item-headers">News Item Headers</a></h3>
239<p>The following headers describe the purpose and format of the news item:</p> 265<p>The following headers describe the purpose and format of the news item:</p>
240<dl class="docutils"> 266<dl class="docutils">
241<dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt> 267<dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt>
242<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd> 268<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd>
243<dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt> 269<dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt>
247<dd>For translated news items, the translator's name and email address. Multiple 273<dd>For translated news items, the translator's name and email address. Multiple
248translator headers may be specified if appropriate.</dd> 274translator headers may be specified if appropriate.</dd>
249<dt><tt class="docutils literal"><span class="pre">Content-Type:</span></tt></dt> 275<dt><tt class="docutils literal"><span class="pre">Content-Type:</span></tt></dt>
250<dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd> 276<dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd>
251<dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt> 277<dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt>
252<dd>Date of posting, in <tt class="docutils literal"><span class="pre">dd-mmm-yyyy</span></tt> format (e.g. 14-Aug-2001) for 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
253compatibility with GLEP 1 <a class="footnote-reference" href="#glep-1" id="id11" name="id11">[6]</a>. UTC time in <tt class="docutils literal"><span class="pre">hh-mm-ss</span> <span class="pre">+0000</span></tt> format 279compatibility with GLEP 45 <a class="footnote-reference" href="#glep-45" id="id11" name="id11">[10]</a>. Mandatory.</dd>
254may also be included. Mandatory.</dd>
255<dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt> 280<dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt>
256<dd>Initially 1. Incremented every time a non-trivial change is made. Changes 281<dd>Initially 1. Should be incremented every time a change is made to the news
257which require a re-read of the news item should instead use a new news item 282item. 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
258file. Mandatory.</dd> 284item. Mandatory.</dd>
259<dt><tt class="docutils literal"><span class="pre">News-Item-Format:</span></tt></dt> 285<dt><tt class="docutils literal"><span class="pre">News-Item-Format:</span></tt></dt>
260<dd>Must be <tt class="docutils literal"><span class="pre">1.0</span></tt>. Future revisions to the format may increment the minor 286<dd>Must be <tt class="docutils literal"><span class="pre">1.0</span></tt>. Future revisions to the format may increment the minor
261number for backwards-compatible changes, or the major number for major 287number for backwards-compatible changes, or the major number for major
262changes.</dd> 288changes.</dd>
263</dl> 289</dl>
264<p>The following headers are used for filtering:</p> 290<p>The following headers are used for filtering:</p>
265<dl class="docutils"> 291<dl class="docutils">
266<dt><tt class="docutils literal"><span class="pre">Display-If-Installed:</span></tt></dt> 292<dt><tt class="docutils literal"><span class="pre">Display-If-Installed:</span></tt></dt>
267<dd>A dependency atom or simple package name (for example, 293<dd>A dependency atom (for example, <tt class="docutils literal"><span class="pre">&lt;dev-lang/php-5_alpha</span></tt> or
268<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 294<tt class="docutils literal"><span class="pre">net-www/apache</span></tt>). If the user has the package specified installed from
269package specified installed, the news item should be displayed.</dd> 295the repository from which the news item was obtained, the news item should
296be displayed.</dd>
270<dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt> 297<dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt>
271<dd>A keyword <a class="footnote-reference" href="#glep-22" id="id12" name="id12">[7]</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 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
272user is on the keyword in question, the news item should be displayed.</dd> 299user is on the keyword in question, the news item should be displayed.</dd>
273<dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt> 300<dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt>
274<dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. Standard 301<dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. If the
275shell GLOB wildcards may be used. If the user is using the exact profile in 302user is using the exact profile in question, or a subprofile of this
276question, the news item should be displayed. This header may be used to 303profile, the news item should be displayed. This header may be used to
277replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the future.</dd> 304replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the future.</dd>
278</dl> 305</dl>
279<div class="note"> 306<div class="note">
280<p class="first admonition-title">Note</p> 307<p class="first admonition-title">Note</p>
281<p class="last">When performing package moves, developers must also update any 308<p class="last">When performing package moves, developers must also update any
298simple to specify — it is believed that these kinds of condition are far more 325simple to specify — it is believed that these kinds of condition are far more
299likely to occur than &quot;display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or 326likely to occur than &quot;display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or
300for 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 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
301people 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> 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>
302</div> 329</div>
303<div class="section" id="news-item-body"> 330<div class="section">
304<h3><a class="toc-backref" href="#id29" name="news-item-body">News Item Body</a></h3> 331<h3><a class="toc-backref" href="#id30" id="news-item-body" name="news-item-body">News Item Body</a></h3>
305<p>The header section must be followed by a blank line, then the main body of the 332<p>The header section must be followed by a blank line, then the main body of the
306text.</p> 333text.</p>
307<p>The text body should be wrapped at 72 characters. No fancy formatting or tab 334<p>The text body should be wrapped at 72 characters. No fancy formatting or tab
308characters should be used — the news item may be being displayed directly to a 335characters should be used — the news item may be being displayed directly to a
309terminal. Paragraphs should be separated by a blank line.</p> 336terminal. Paragraphs should be separated by a blank line.</p>
310<p>Hyperlinks may be used to refer to further information (for example, an upgrade 337<p>Hyperlinks may be used to refer to further information (for example, an upgrade
311guide). However, the main body of the news item should be descriptive and not 338guide). However, the main body of the news item should be descriptive and not
312simply a &quot;read this link&quot; text. It is assumed that the user will have access to 339simply a &quot;read this link&quot; text. It is assumed that the user will have access to
313a web browser <em>somewhere</em>, but not necessarily on the box which is being 340a web browser <em>somewhere</em>, but not necessarily on the box which is being
314administrated — this will be the case on may servers and routers, for example.</p> 341administrated — this will be the case on many servers and routers, for example.</p>
315</div> 342</div>
316<div class="section" id="example-news-item"> 343<div class="section">
317<h3><a class="toc-backref" href="#id30" name="example-news-item">Example News Item</a></h3> 344<h3><a class="toc-backref" href="#id31" id="example-news-item" name="example-news-item">Example News Item</a></h3>
318<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 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
319<tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p> 346<tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p>
320</div> 347</div>
321</div> 348</div>
322<div class="section" id="news-item-quality-control"> 349<div class="section">
323<h2><a class="toc-backref" href="#id31" name="news-item-quality-control">News Item Quality Control</a></h2> 350<h2><a class="toc-backref" href="#id32" id="news-item-quality-control" name="news-item-quality-control">News Item Quality Control</a></h2>
324<p>There have been complaints regarding the comprehensibility of some upgrade 351<p>There have been complaints regarding the comprehensibility of some upgrade
325notices and news items in the past. This is understandable — not every Gentoo 352notices and news items in the past. This is understandable — not every Gentoo
326developer speaks English as a first language. However, for the sake of clarity, 353developer speaks English as a first language. However, for the sake of clarity,
327professionalism and avoiding making us look like prats, it is important that any 354professionalism and avoiding making us look like prats, it is important that any
328language problems be corrected before inflicting a news item upon end users.</p> 355language problems be corrected before inflicting a news item upon end users.</p>
329<p>Thus, at least 72 hours before a proposed news item is committed, it must be 356<p>Thus, at least 72 hours before a proposed news item is committed, it must be
330posted 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> 357posted 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>
331(exceptions may be made in exceptional circumstances). Any complaints — for 358(exceptions may be made in exceptional circumstances). Any complaints — for
332example regarding wording, clarity or accuracy — <strong>must</strong> be addressed before 359example regarding wording, clarity or accuracy — <strong>must</strong> be addressed before
333the news item goes live.</p> 360the news item goes live.</p>
334<div class="note">
335<p class="first admonition-title">Note</p>
336<p class="last">A previous draft of this GLEP allowed news items to be sent to
337<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
338may arise where this will be necessary (for example, a security update which
339must break backwards compatibility and which cannot be revealed to the public
340before a given date).</p>
341</div>
342<p>News items must only be for <strong>important</strong> changes that may cause serious upgrade 361<p>News items must only be for <strong>important</strong> changes that may cause serious upgrade
343or compatibility problems. Ordinary upgrade messages and non-critical news items 362or compatibility problems. Ordinary upgrade messages and non-critical news items
344should remain in <tt class="docutils literal"><span class="pre">einfo</span></tt> notices. The importance of the message to its 363should remain in <tt class="docutils literal"><span class="pre">einfo</span></tt> notices. The importance of the message to its
345intended audience should be justified with the proposal.</p> 364intended audience should be justified with the proposal.</p>
346<div class="important"> 365<div class="important">
349news items which are aimed at users of an uncommon package or architecture. 368news items which are aimed at users of an uncommon package or architecture.
350Thus, the justification should be in the form &quot;this message is important to 369Thus, the justification should be in the form &quot;this message is important to
351YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p> 370YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p>
352</div> 371</div>
353</div> 372</div>
354<div class="section" id="news-item-distribution"> 373<div class="section">
355<h2><a class="toc-backref" href="#id32" name="news-item-distribution">News Item Distribution</a></h2> 374<h2><a class="toc-backref" href="#id33" id="news-item-distribution" name="news-item-distribution">News Item Distribution</a></h2>
356<div class="section" id="server-side"> 375<div class="section">
357<h3><a class="toc-backref" href="#id33" name="server-side">Server Side</a></h3> 376<h3><a class="toc-backref" href="#id34" id="server-side" name="server-side">Server Side</a></h3>
358<p>News items are to be made available via the standard rsync tree. This removes 377<p>News items are to be made available via the standard rsync tree. This removes
359any need for polling of a remote source.</p> 378any need for polling of a remote source.</p>
360<p>A new repository will be created for news items. The type (CVS or Subversion), 379<p>A new repository will be created for news items. The type (CVS or Subversion),
361location and access controls on this repository are beyond the scope of this 380location and access controls on this repository are beyond the scope of this
362GLEP.</p> 381GLEP.</p>
369<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 388<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
370the current year and <tt class="docutils literal"><span class="pre">mm</span></tt> is the current month number (01 for January through 389the current year and <tt class="docutils literal"><span class="pre">mm</span></tt> is the current month number (01 for January through
37112 for December). This separation will help keep news items more manageable.</p> 39012 for December). This separation will help keep news items more manageable.</p>
372<p>The contents of this repository will automatically be merged with the main rsync 391<p>The contents of this repository will automatically be merged with the main rsync
373tree, placing the items in a <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory. The method used for 392tree, placing the items in a <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory. The method used for
374merging these items is beyond the scope of this GLEP — a similar setup is 393merging these items and the frequency at which it will occur is beyond the scope
375already used for merging GLSAs into the rsync tree.</p> 394of this GLEP; a similar setup is already used for merging GLSAs into the rsync
395tree.</p>
376<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> 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
397news item directories will all be immediately under the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt>
398directory.</p>
377</div> 399</div>
378<div class="section" id="client-side"> 400<div class="section">
379<h3><a class="toc-backref" href="#id34" name="client-side">Client Side</a></h3> 401<h3><a class="toc-backref" href="#id35" id="client-side" name="client-side">Client Side</a></h3>
380<p>Whenever relevant unread news items are found, the package manager will create a 402<p>Whenever relevant unread news items are found, the package manager will create a
381file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-magic-chicken.unread</span></tt> (if it does not 403file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-${repoid}.unread</span></tt> (if it does not
382already exist) and append the news item identifier (eg 404already exist) and append the news item identifier (eg
383<tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p> 405<tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p>
384<div class="note"> 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
385<p class="first admonition-title">Note</p> 407with the group write (and, for directories, execute) bits set. News files should
386<p class="last">Future changes to Portage involving support for multiple repositories 408be world readable.</p>
387may introduce repository names. In this case, the <tt class="docutils literal"><span class="pre">magic-chicken</span></tt> part of the
388filename should be replaced by a string representation of the repository
389name. Thus, news item clients should use a wildcard rather than hardcoding
390the <tt class="docutils literal"><span class="pre">magic-chicken</span></tt> string.</p>
391</div>
392<p>Notification that new relevant news items will be displayed via the 409<p>Notification that new relevant news items will be displayed via the
393<tt class="docutils literal"><span class="pre">emerge</span></tt> tool in a similar way to the existing &quot;configuration files need 410<tt class="docutils literal"><span class="pre">emerge</span></tt> tool in a similar way to the existing &quot;configuration files need
394updating&quot; messages:</p> 411updating&quot; messages:</p>
395<pre class="literal-block"> 412<pre class="literal-block">
396* Important: there are 5 unread news items. 413* Important: there are 5 unread news items.
399<p>Checks for new news messages should be displayed:</p> 416<p>Checks for new news messages should be displayed:</p>
400<ul class="simple"> 417<ul class="simple">
401<li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">sync</span></tt></li> 418<li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">sync</span></tt></li>
402<li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">--pretend</span></tt></li> 419<li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">--pretend</span></tt></li>
403<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> 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>
404<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>
405</ul> 421</ul>
422<p>The package manager does not need to know how to launch the user's choice of
423news client. This is consistent with the way configuration file updates are
424handled.</p>
406<p>The package manager may use a timestamp check file to avoid having to process 425<p>The package manager may use a timestamp check file to avoid having to process
407news items unnecessarily.</p> 426news items unnecessarily.</p>
408<p>The package manager must keep track of news items that have already been added 427<p>The package manager must keep track of news items that have already been added
409to the unread list to avoid repeatedly marking a deleted news item. This could 428to the unread list to avoid repeatedly marking a deleted news item. This could
410be handled via a <tt class="docutils literal"><span class="pre">news-magic-chicken.skip</span></tt> file, but implementation is not 429be handled via a <tt class="docutils literal"><span class="pre">news-${repoid}.skip</span></tt> file containing the IDs of news items
411specified by this GLEP.</p> 430that have already been added to a <tt class="docutils literal"><span class="pre">news-${repoid}.unread</span></tt> file, but this
431method is not required by this GLEP.</p>
412<p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to 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
413filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p> 433filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p>
414</div> 434</div>
415</div> 435</div>
416<div class="section" id="news-item-clients"> 436<div class="section">
417<h2><a class="toc-backref" href="#id35" name="news-item-clients">News Item Clients</a></h2> 437<h2><a class="toc-backref" href="#id36" id="news-item-clients" name="news-item-clients">News Item Clients</a></h2>
418<p>Once a news item is marked for reading, third party tools (or traditional core 438<p>Once a news item is marked for reading, third party tools (or traditional core
419Unix tools) can be used to display and view the news files.</p> 439Unix tools) can be used to display and view the news files.</p>
420<p>When a news item is read, its name should be removed from the 440<p>When a news item is read, its name should be removed from the
421<tt class="docutils literal"><span class="pre">news-magic-chicken.unread</span></tt> file. If a news client acts as an interactive 441<tt class="docutils literal"><span class="pre">news-repoid.unread</span></tt> file. If a news client acts as an interactive reader
422reader rather than a gateway, it should then add the name to a 442rather than a gateway, it should then add the name to a <tt class="docutils literal"><span class="pre">news-repoid.read</span></tt>
423<tt class="docutils literal"><span class="pre">news-magic-chicken.read</span></tt> file in the same directory with the same file 443file in the same directory with the same file format.</p>
424format (again, <tt class="docutils literal"><span class="pre">magic-chicken</span></tt> should be a wildcard rather than hardcoded).</p>
425<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 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
426tool; other display tools (for example, a news to email forwarder, which would 445tool; other display tools (for example, a news to email forwarder, which would
427be ideal for users who sync on a <tt class="docutils literal"><span class="pre">cron</span></tt>) are left as options for those who 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
428desire them.</p> 447desire them.</p>
429</div> 448</div>
430<div class="section" id="news-item-removal"> 449<div class="section">
431<h2><a class="toc-backref" href="#id36" name="news-item-removal">News Item Removal</a></h2> 450<h2><a class="toc-backref" href="#id37" id="news-item-removal" name="news-item-removal">News Item Removal</a></h2>
432<p>News items can be removed (by removing the news file from the main tree) when 451<p>News items can be removed (by removing the news file from the main tree) when
433they are no longer relevant, if they are made obsolete by a future news item or 452they are no longer relevant, if they are made obsolete by a future news item or
434after a long period of time. This is the same as the method used for <tt class="docutils literal"><span class="pre">updates</span></tt> 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>
435entries.</p> 454entries.</p>
436</div> 455</div>
437</div> 456</div>
438<div class="section" id="integration-with-existing-systems"> 457<div class="section">
439<h1><a class="toc-backref" href="#id37" name="integration-with-existing-systems">Integration with Existing Systems</a></h1> 458<h1><a class="toc-backref" href="#id38" id="integration-with-existing-systems" name="integration-with-existing-systems">Integration with Existing Systems</a></h1>
440<p>It would be simple to convert these news items into the format used for news 459<p>It would be simple to convert these news items into the format used for news
441items on the Gentoo website or posts for the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list.</p> 460items on the Gentoo website or posts for the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list.</p>
442<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 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
443forums. A similar tool can be used for these news items.</p> 462forums. A similar tool can be used for these news items.</p>
444</div> 463</div>
445<div class="section" id="backwards-compatibility"> 464<div class="section">
446<h1><a class="toc-backref" href="#id38" name="backwards-compatibility">Backwards Compatibility</a></h1> 465<h1><a class="toc-backref" href="#id39" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
447<p>Backwards compatibility is not a concern here. Existing tools will simply ignore 466<p>Backwards compatibility is not a concern here. Existing tools will simply ignore
448the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p> 467the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p>
449</div> 468</div>
450<div class="section" id="reference-implementation"> 469<div class="section">
451<h1><a class="toc-backref" href="#id39" name="reference-implementation">Reference Implementation</a></h1> 470<h1><a class="toc-backref" href="#id40" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1>
452<div class="section" id="portage-code"> 471<div class="section">
453<h2><a class="toc-backref" href="#id40" name="portage-code">Portage Code</a></h2> 472<h2><a class="toc-backref" href="#id41" id="portage-code" name="portage-code">Portage Code</a></h2>
454<p>TODO</p> 473<p>TODO</p>
455</div> 474</div>
456<div class="section" id="simple-eselect-news-client"> 475<div class="section">
457<h2><a class="toc-backref" href="#id41" name="simple-eselect-news-client">Simple <tt class="docutils literal docutils literal"><span class="pre">eselect</span></tt> News Client</a></h2> 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>
458<p>TODO Removed until the exact format details are figured out.</p> 477<p>TODO Removed until the exact format details are figured out.</p>
459</div> 478</div>
460<div class="section" id="simple-news-to-mail-forwarder"> 479<div class="section">
461<h2><a class="toc-backref" href="#id42" name="simple-news-to-mail-forwarder">Simple News to Mail Forwarder</a></h2> 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>
462<p>TODO Removed until the exact format details are figured out.</p> 481<p>TODO Removed until the exact format details are figured out.</p>
463</div> 482</div>
464</div> 483</div>
465<div class="section" id="credits"> 484<div class="section">
466<h1><a class="toc-backref" href="#id43" name="credits">Credits</a></h1> 485<h1><a class="toc-backref" href="#id44" id="credits" name="credits">Credits</a></h1>
467<p>The idea behind notifying users of news updates via Portage comes from Stuart 486<p>The idea behind notifying users of news updates via Portage comes from Stuart
468Herbert <a class="footnote-reference" href="#stuart-blog" id="id17" name="id17">[15]</a>.</p> 487Herbert <a class="footnote-reference" href="#stuart-blog" id="id17" name="id17">[15]</a>.</p>
469<p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, 488<p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear,
470Brian Harring, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec Warner for 489Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec
471input. Some of the ideas presented here are theirs, others go completely 490Warner for input. Some of the ideas presented here are theirs, others go
472against their suggestions.</p> 491completely against their suggestions.</p>
473</div> 492</div>
474<div class="section" id="example-files"> 493<div class="section">
475<h1><a class="toc-backref" href="#id44" name="example-files">Example Files</a></h1> 494<h1><a class="toc-backref" href="#id45" id="example-files" name="example-files">Example Files</a></h1>
476<p>TODO Removed until the exact format details are figured out.</p> 495<p>TODO Removed until the exact format details are figured out.</p>
477</div> 496</div>
478<div class="section" id="references"> 497<div class="section">
479<h1><a class="toc-backref" href="#id45" name="references">References</a></h1> 498<h1><a class="toc-backref" href="#id46" id="references" name="references">References</a></h1>
480<table class="docutils footnote" frame="void" id="bug-11359" rules="none"> 499<table class="docutils footnote" frame="void" id="bug-11359" rules="none">
481<colgroup><col class="label" /><col /></colgroup> 500<colgroup><col class="label" /><col /></colgroup>
482<tbody valign="top"> 501<tbody valign="top">
483<tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359 502<tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359
484&quot;[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging&quot;, 503&quot;[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging&quot;,
512<tbody valign="top"> 531<tbody valign="top">
513<tr><td class="label"><a name="forums-apache2">[5]</a></td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id3">2</a>)</em> Forums thread &quot;Gentoo Apache2 Config Change Idiocy&quot;, 532<tr><td class="label"><a name="forums-apache2">[5]</a></td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id3">2</a>)</em> Forums thread &quot;Gentoo Apache2 Config Change Idiocy&quot;,
514<a class="reference" href="http://forums.gentoo.org/viewtopic-t-384368.html">http://forums.gentoo.org/viewtopic-t-384368.html</a></td></tr> 533<a class="reference" href="http://forums.gentoo.org/viewtopic-t-384368.html">http://forums.gentoo.org/viewtopic-t-384368.html</a></td></tr>
515</tbody> 534</tbody>
516</table> 535</table>
517<table class="docutils footnote" frame="void" id="glep-1" rules="none">
518<colgroup><col class="label" /><col /></colgroup>
519<tbody valign="top">
520<tr><td class="label"><a class="fn-backref" href="#id11" name="glep-1">[6]</a></td><td>GLEP 1: &quot;GLEP Purpose and Guidelines&quot;, Grant Goodyear,
521<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0001.html">http://www.gentoo.org/proj/en/glep/glep-0001.html</a></td></tr>
522</tbody>
523</table>
524<table class="docutils footnote" frame="void" id="glep-22" rules="none"> 536<table class="docutils footnote" frame="void" id="glep-22" rules="none">
525<colgroup><col class="label" /><col /></colgroup> 537<colgroup><col class="label" /><col /></colgroup>
526<tbody valign="top"> 538<tbody valign="top">
527<tr><td class="label"><a class="fn-backref" href="#id12" name="glep-22">[7]</a></td><td>GLEP 22: &quot;New &quot;keyword&quot; system to incorporate various 539<tr><td class="label"><a class="fn-backref" href="#id12" name="glep-22">[6]</a></td><td>GLEP 22: &quot;New &quot;keyword&quot; system to incorporate various
528userlands/kernels/archs&quot;, Grant Goodyear, 540userlands/kernels/archs&quot;, Grant Goodyear,
529<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0022.html">http://www.gentoo.org/proj/en/glep/glep-0022.html</a></td></tr> 541<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0022.html">http://www.gentoo.org/proj/en/glep/glep-0022.html</a></td></tr>
530</tbody> 542</tbody>
531</table> 543</table>
532<table class="docutils footnote" frame="void" id="glep-31" rules="none"> 544<table class="docutils footnote" frame="void" id="glep-31" rules="none">
533<colgroup><col class="label" /><col /></colgroup> 545<colgroup><col class="label" /><col /></colgroup>
534<tbody valign="top"> 546<tbody valign="top">
535<tr><td class="label"><a class="fn-backref" href="#id9" name="glep-31">[8]</a></td><td>GLEP 31: &quot;Character Sets for Portage Tree Items&quot;, Ciaran 547<tr><td class="label"><a class="fn-backref" href="#id9" name="glep-31">[7]</a></td><td>GLEP 31: &quot;Character Sets for Portage Tree Items&quot;, Ciaran
536McCreesh, 548McCreesh,
537<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0031.html">http://www.gentoo.org/proj/en/glep/glep-0031.html</a></td></tr> 549<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0031.html">http://www.gentoo.org/proj/en/glep/glep-0031.html</a></td></tr>
538</tbody> 550</tbody>
539</table> 551</table>
540<table class="docutils footnote" frame="void" id="glep-34" rules="none"> 552<table class="docutils footnote" frame="void" id="glep-34" rules="none">
541<colgroup><col class="label" /><col /></colgroup> 553<colgroup><col class="label" /><col /></colgroup>
542<tbody valign="top"> 554<tbody valign="top">
543<tr><td class="label"><a class="fn-backref" href="#id6" name="glep-34">[9]</a></td><td>GLEP 34: &quot;Per-Category metadata.xml Files&quot;, Ciaran McCreesh, 555<tr><td class="label"><a class="fn-backref" href="#id6" name="glep-34">[8]</a></td><td>GLEP 34: &quot;Per-Category metadata.xml Files&quot;, Ciaran McCreesh,
544<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0034.html">http://www.gentoo.org/proj/en/glep/glep-0034.html</a></td></tr> 556<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0034.html">http://www.gentoo.org/proj/en/glep/glep-0034.html</a></td></tr>
545</tbody> 557</tbody>
546</table> 558</table>
547<table class="docutils footnote" frame="void" id="glep-36" rules="none"> 559<table class="docutils footnote" frame="void" id="glep-36" rules="none">
548<colgroup><col class="label" /><col /></colgroup> 560<colgroup><col class="label" /><col /></colgroup>
549<tbody valign="top"> 561<tbody valign="top">
550<tr><td class="label"><a class="fn-backref" href="#id4" name="glep-36">[10]</a></td><td>GLEP 36: &quot;Subversion/CVS for Gentoo Hosted Projects&quot;, Aaron 562<tr><td class="label"><a class="fn-backref" href="#id4" name="glep-36">[9]</a></td><td>GLEP 36: &quot;Subversion/CVS for Gentoo Hosted Projects&quot;, Aaron
551Walker, 563Walker,
552<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0036.html">http://www.gentoo.org/proj/en/glep/glep-0036.html</a></td></tr> 564<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0036.html">http://www.gentoo.org/proj/en/glep/glep-0036.html</a></td></tr>
565</tbody>
566</table>
567<table class="docutils footnote" frame="void" id="glep-45" rules="none">
568<colgroup><col class="label" /><col /></colgroup>
569<tbody valign="top">
570<tr><td class="label"><a class="fn-backref" href="#id11" name="glep-45">[10]</a></td><td>GLEP 45: &quot;GLEP date format&quot;, Henrik Brix Andersen,
571<a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0045.html">http://www.gentoo.org/proj/en/glep/glep-0045.html</a></td></tr>
553</tbody> 572</tbody>
554</table> 573</table>
555<table class="docutils footnote" frame="void" id="iso-639" rules="none"> 574<table class="docutils footnote" frame="void" id="iso-639" rules="none">
556<colgroup><col class="label" /><col /></colgroup> 575<colgroup><col class="label" /><col /></colgroup>
557<tbody valign="top"> 576<tbody valign="top">
591<tbody valign="top"> 610<tbody valign="top">
592<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> 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>
593</tbody> 612</tbody>
594</table> 613</table>
595</div> 614</div>
596<div class="section" id="copyright"> 615<div class="section">
597<h1><a class="toc-backref" href="#id46" name="copyright">Copyright</a></h1> 616<h1><a class="toc-backref" href="#id47" id="copyright" name="copyright">Copyright</a></h1>
598<p>This document has been placed in the public domain.</p> 617<p>This document has been placed in the public domain.</p>
599<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : --> 618<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
600</div> 619</div>
601 620
602</div> 621</div>
603<div class="footer"> 622<div class="footer">
604<hr class="footer" /> 623<hr class="footer" />
605<a class="reference" href="glep-0042.txt">View document source</a>. 624<a class="reference" href="glep-0042.txt">View document source</a>.
606Generated on: 2005-12-13 03:21 UTC. 625Generated on: 2006-02-13 16:26 UTC.
607Generated 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. 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.
608 627
609</div> 628</div>
610</body> 629</body>
611</html> 630</html>

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.8

  ViewVC Help
Powered by ViewVC 1.1.20