/[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.18
1<?xml version="1.0" encoding="utf-8" ?> 1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<!-- 4
5This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
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!
8-->
9<head> 5<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.9: http://docutils.sourceforge.net/" /> 7 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 42 -- Critical News Reporting</title> 8 <title>GLEP 42 -- Critical News Reporting</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" /> 9 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14</head> 10</head>
15<body bgcolor="white"> 11<body bgcolor="white">
16<table class="navigation" cellpadding="0" cellspacing="0" 12<table class="navigation" cellpadding="0" cellspacing="0"
20<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" 16<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td> 17 border="0" width="150" height="35" /></a></td>
22<td class="textlinks" align="left"> 18<td class="textlinks" align="left">
23[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] 19[<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>] 20[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
25[<b><a href="./glep-0042.txt">GLEP Source</a></b>] 21[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0042.txt">GLEP Source</a></b>]
26</td></tr></table> 22</td></tr></table>
27<table class="rfc2822 docutils field-list" frame="void" rules="none"> 23<table class="rfc2822 docutils field-list" frame="void" rules="none">
28<col class="field-name" /> 24<col class="field-name" />
29<col class="field-body" /> 25<col class="field-body" />
30<tbody valign="top"> 26<tbody valign="top">
31<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td> 27<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td>
32</tr> 28</tr>
33<tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td> 29<tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td>
34</tr> 30</tr>
35<tr class="field"><th class="field-name">Version:</th><td class="field-body">$Revision: 1.6 $</td> 31<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.13</td>
36</tr> 32</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> 33<tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh &lt;ciaranm&#32;&#97;t&#32;gentoo.org&gt;,
34Stephen Bennett &lt;spb&#32;&#97;t&#32;gentoo.org&gt;,
35Zach Medico &lt;zmedico&#32;&#97;t&#32;gentoo.org&gt;</td>
38</tr> 36</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> 37<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">2007/05/05 22:24:25</a></td>
40</tr> 38</tr>
41<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 39<tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td>
42</tr> 40</tr>
43<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 41<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
44</tr> 42</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> 43<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> 44</tr>
47<tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td> 45<tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td>
48</tr> 46</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> 47<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005, 18-Dec-2005, 5-Jan-2006, 2-Mar-2006, 6-Mar-2006, 12-Jun-2006, 5-Sep-2006</td>
50</tr> 48</tr>
51</tbody> 49</tbody>
52</table> 50</table>
53<hr /> 51<hr />
54<div class="contents topic" id="contents"> 52<div class="contents topic">
55<p class="topic-title first"><a name="contents">Contents</a></p> 53<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
56<ul class="simple"> 54<ul class="simple">
57<li><a class="reference" href="#abstract" id="id20" name="id20">Abstract</a></li> 55<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> 56<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> 57<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> 58<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> 59<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> 60<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> 61<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> 62<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> 63<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> 64<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> 65<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> 66<li><a class="reference" href="#example-news-item" id="id33" name="id33">Example News Item</a></li>
69</ul> 67</ul>
70</li> 68</li>
71<li><a class="reference" href="#news-item-quality-control" id="id32" name="id32">News Item Quality Control</a></li> 69<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> 70<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> 71<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> 72<li><a class="reference" href="#client-side" id="id37" name="id37">Client Side</a></li>
75</ul> 73</ul>
76</li> 74</li>
77<li><a class="reference" href="#news-item-clients" id="id36" name="id36">News Item Clients</a></li> 75<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> 76<li><a class="reference" href="#news-item-removal" id="id39" name="id39">News Item Removal</a></li>
79</ul> 77</ul>
80</li> 78</li>
81<li><a class="reference" href="#integration-with-existing-systems" id="id38" name="id38">Integration with Existing Systems</a></li> 79<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> 80<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> 81<li><a class="reference" href="#reference-implementation" id="id42" name="id42">Reference Implementation</a></li>
84<li><a class="reference" href="#portage-code" id="id41" name="id41">Portage Code</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>
86<li><a class="reference" href="#simple-news-to-mail-forwarder" id="id43" name="id43">Simple News to Mail Forwarder</a></li>
87</ul>
88</li>
89<li><a class="reference" href="#credits" id="id44" name="id44">Credits</a></li> 82<li><a class="reference" href="#credits" id="id43" name="id43">Credits</a></li>
90<li><a class="reference" href="#example-files" id="id45" name="id45">Example Files</a></li> 83<li><a class="reference" href="#example-files" id="id44" name="id44">Example Files</a></li>
91<li><a class="reference" href="#references" id="id46" name="id46">References</a></li> 84<li><a class="reference" href="#references" id="id45" name="id45">References</a></li>
92<li><a class="reference" href="#copyright" id="id47" name="id47">Copyright</a></li> 85<li><a class="reference" href="#copyright" id="id46" name="id46">Copyright</a></li>
93</ul> 86</ul>
94</div> 87</div>
95<div class="section" id="abstract"> 88<div class="section">
96<h1><a class="toc-backref" href="#id20" name="abstract">Abstract</a></h1> 89<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 90<p>This GLEP proposes a new way of informing users about important updates and news
98regarding tree-related items.</p> 91related to the tree.</p>
99</div> 92</div>
100<div class="section" id="motivation"> 93<div class="section">
101<h1><a class="toc-backref" href="#id21" name="motivation">Motivation</a></h1> 94<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, 95<p>Although most package updates are clean and require little user action,
103occasionally an upgrade requires user intervention during the upgrade process. 96occasionally 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> 97latter 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> 98database format changes.</p>
106<p>There are currently several ways of delivering important news items to our 99<p>There are currently several ways of delivering important news items to our
107users, none of them particularly effective:</p> 100users, none of them particularly effective:</p>
108<ul class="simple"> 101<ul class="simple">
109<li>Gentoo Weekly News</li> 102<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> 103<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> 105<li>The main Gentoo website</li>
113<li>RSS feeds of Gentoo news</li> 106<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> 107<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> 108</ul>
116<p>A more reliable way of getting news of critical updates out to users is required 109<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 110to 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> 111solution 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"> 112<div class="important">
120<p class="first admonition-title">Important</p> 113<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 114<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 115which 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> 116by <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> 117</div>
125</div> 118</div>
126<div class="section" id="requirements"> 119<div class="section">
127<h1><a class="toc-backref" href="#id22" name="requirements">Requirements</a></h1> 120<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> 121<p>An adequate solution must meet all of the following requirements:</p>
129<dl class="docutils"> 122<dl class="docutils">
130<dt>Preemptive</dt> 123<dt>Preemptive</dt>
131<dd>Users should be told of changes <em>before</em> they break a system, not after the 124<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 125damage has already been done. Ideally, the system administrator would be
133given ample warning to plan difficult upgrades and changes, rather than only 126given ample warning to plan difficult upgrades and changes, rather than only
134being told just before action is necessary.</dd> 127being told just before action is necessary.</dd>
135<dt>No user subscription required</dt> 128<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 129<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 130read 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> 131requires subscription has no advantage over current methods.</dd>
139<dt>No user monitoring required</dt> 132<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 133<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 134read 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 135until it is too late. A solution that relies upon active monitoring of a
177sources (for example, Forums, GWN, the main Gentoo website) without 170sources (for example, Forums, GWN, the main Gentoo website) without
178excessive difficulty. Similarly, easy interoperation with any future news 171excessive difficulty. Similarly, easy interoperation with any future news
179sources should not be precluded.</dd> 172sources should not be precluded.</dd>
180</dl> 173</dl>
181</div> 174</div>
182<div class="section" id="specification"> 175<div class="section">
183<h1><a class="toc-backref" href="#id23" name="specification">Specification</a></h1> 176<h1><a class="toc-backref" href="#id25" id="specification" name="specification">Specification</a></h1>
184<div class="section" id="overview"> 177<div class="section">
185<h2><a class="toc-backref" href="#id24" name="overview">Overview</a></h2> 178<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> 179<p>News items are published and delivered to users as follows:</p>
187<ol class="arabic simple"> 180<ol class="arabic simple">
188<li>A news item is written. The format to be used is described below.</li> 181<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 182<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> 183<a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li>
200informing the user that there are unread news items.</li> 193informing 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 194<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> 195Item Clients</a>.</li>
203</ol> 196</ol>
204</div> 197</div>
205<div class="section" id="required-portage-enhancements"> 198<div class="section">
206<h2><a class="toc-backref" href="#id25" name="required-portage-enhancements">Required Portage Enhancements</a></h2> 199<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> 200<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"> 201<ul class="simple">
211<li>Every repository (including overlays) will require a unique identifier. It is 202<li>Every repository (including overlays) will require a unique identifier. It is
212assumed that an identifier will be a string consisting of characters from 203assumed 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), 204<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> 205<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 206<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 207repository 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> 208the 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 209<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 210a 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> 211a <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 212<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> 213given 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 214<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 215or 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> 216(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>
217<span class="pre">gentoo-x86</span></tt>).</li>
226</ul> 218</ul>
227<p>These extensions are assumed during the following specification.</p> 219<p>These extensions are assumed during the following specification.</p>
228</div> 220</div>
229<div class="section" id="news-item-identities"> 221<div class="section">
230<h2><a class="toc-backref" href="#id26" name="news-item-identities">News Item Identities</a></h2> 222<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 223<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>), 224form <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 225<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 226(<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>, 227news 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> 228<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> 229</div>
238<div class="section" id="news-item-directories"> 230<div class="section">
239<h2><a class="toc-backref" href="#id27" name="news-item-directories">News Item Directories</a></h2> 231<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 232<p>Each news item will be represented by a directory whose name is the same as the
241news item's identifier.</p> 233news 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 234<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> 235contains 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> 236<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 237(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. 238remains the same as the original news item) will also be provided. However, only
239the 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> 240justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p>
248</div> 241</div>
249<div class="section" id="news-item-files"> 242<div class="section">
250<h2><a class="toc-backref" href="#id28" name="news-item-files">News Item Files</a></h2> 243<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 244<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 245compatibility 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> 246<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> 247<p>News items must be signed with a detached GPG signature.:</p>
255<pre class="literal-block"> 248<pre class="literal-block">
256gpg --armour --detach-sign ????-??-??-*.??.txt 249gpg --armour --detach-sign ????-??-??-*.??.txt
257</pre> 250</pre>
251<p>This GLEP does not specify the type or strength of signature to be used, nor
252does it discuss how, if at all, a centralised keychain will be provided. These
253issues 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> 254<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 255followed by the main body of the message as plain text. This GLEP defines
260various optional and mandatory headers. Future GLEPs may propose new headers — 256various optional and mandatory headers. Future GLEPs may propose new headers —
261tools handling these news items must ignore any unrecognised header.</p> 257tools handling these news items must ignore any unrecognised header.</p>
262<div class="section" id="news-item-headers"> 258<div class="section">
263<h3><a class="toc-backref" href="#id29" name="news-item-headers">News Item Headers</a></h3> 259<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> 260<p>The following headers describe the purpose and format of the news item:</p>
265<dl class="docutils"> 261<dl class="docutils">
266<dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt> 262<dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt>
267<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd> 263<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd>
268<dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt> 264<dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt>
273translator headers may be specified if appropriate.</dd> 269translator headers may be specified if appropriate.</dd>
274<dt><tt class="docutils literal"><span class="pre">Content-Type:</span></tt></dt> 270<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> 271<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> 272<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 273<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> 274compatibility with GLEP 45 <a class="footnote-reference" href="#glep-45" id="id11" name="id11">[10]</a>. Translations should use the date
275of the original news item. Mandatory.</dd>
279<dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt> 276<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 277<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 278item. Changes that require a re-read of the news item (i.e., most changes
279that are not spelling or formatting related) should instead use a new news
282file. Mandatory.</dd> 280item. Mandatory.</dd>
283<dt><tt class="docutils literal"><span class="pre">News-Item-Format:</span></tt></dt> 281<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 282<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 283number for backwards-compatible changes, or the major number for major
286changes.</dd> 284changes.</dd>
287</dl> 285</dl>
288<p>The following headers are used for filtering:</p> 286<p>The following headers are used for filtering:</p>
289<dl class="docutils"> 287<dl class="docutils">
290<dt><tt class="docutils literal"><span class="pre">Display-If-Installed:</span></tt></dt> 288<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, 289<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 290<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 291the repository from which the news item was obtained, the news item should
294obtained, the news item should be displayed.</dd> 292be displayed.</dd>
295<dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt> 293<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 294<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> 295user 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> 296<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 297<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 298user 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> 299displayed. This header may be used to replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the
300future.</dd>
303</dl> 301</dl>
304<div class="note"> 302<div class="note">
305<p class="first admonition-title">Note</p> 303<p class="first admonition-title">Note</p>
306<p class="last">When performing package moves, developers must also update any 304<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> 305relevant <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 321simple 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 322likely 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 323for 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> 324people 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> 325</div>
328<div class="section" id="news-item-body"> 326<div class="section">
329<h3><a class="toc-backref" href="#id30" name="news-item-body">News Item Body</a></h3> 327<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 328<p>The header section must be followed by a blank line, then the main body of the
331text.</p> 329text.</p>
332<p>The text body should be wrapped at 72 characters. No fancy formatting or tab 330<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 331characters should be used — the news item may be being displayed directly to a
334terminal. Paragraphs should be separated by a blank line.</p> 332terminal. Paragraphs should be separated by a blank line.</p>
335<p>Hyperlinks may be used to refer to further information (for example, an upgrade 333<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 334guide). 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 335simply 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 336a 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> 337administrated — this will be the case on many servers and routers, for example.</p>
340</div> 338</div>
341<div class="section" id="example-news-item"> 339<div class="section">
342<h3><a class="toc-backref" href="#id31" name="example-news-item">Example News Item</a></h3> 340<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 341<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> 342<tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p>
345</div> 343</div>
346</div> 344</div>
347<div class="section" id="news-item-quality-control"> 345<div class="section">
348<h2><a class="toc-backref" href="#id32" name="news-item-quality-control">News Item Quality Control</a></h2> 346<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 347<p>There have been complaints regarding the comprehensibility of some upgrade
350notices and news items in the past. This is understandable — not every Gentoo 348notices 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, 349developer 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 350professionalism 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> 351language 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 352<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> 353posted 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 354(exceptions may be made in exceptional circumstances). Any complaints — for
357example regarding wording, clarity or accuracy — <strong>must</strong> be addressed before 355example regarding wording, clarity or accuracy — <strong>must</strong> be addressed before
358the news item goes live.</p> 356the 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 357<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 358or 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 359should 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> 360intended audience should be justified with the proposal.</p>
371<div class="important"> 361<div class="important">
374news items which are aimed at users of an uncommon package or architecture. 364news 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 365Thus, 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> 366YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p>
377</div> 367</div>
378</div> 368</div>
379<div class="section" id="news-item-distribution"> 369<div class="section">
380<h2><a class="toc-backref" href="#id33" name="news-item-distribution">News Item Distribution</a></h2> 370<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"> 371<div class="section">
382<h3><a class="toc-backref" href="#id34" name="server-side">Server Side</a></h3> 372<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 373<p>News items are to be made available via the standard rsync tree. This removes
384any need for polling of a remote source.</p> 374any need for polling of a remote source.</p>
385<p>A new repository will be created for news items. The type (CVS or Subversion), 375<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 376location and access controls on this repository are beyond the scope of this
387GLEP.</p> 377GLEP.</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 384<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 385the 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> 38612 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 387<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 388tree, 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 389merging these items and the frequency at which it will occur is beyond the scope
400already used for merging GLSAs into the rsync tree.</p> 390of this GLEP; a similar setup is already used for merging GLSAs into the rsync
391tree.</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> 392<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
393news item directories will all be immediately under the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt>
394directory.</p>
402</div> 395</div>
403<div class="section" id="client-side"> 396<div class="section">
404<h3><a class="toc-backref" href="#id35" name="client-side">Client Side</a></h3> 397<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 398<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 399file 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 400already 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> 401<tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p>
402<p>All news item related files should be root owned and in the <tt class="docutils literal"><span class="pre">portage</span></tt> group
403with the group write (and, for directories, execute) bits set. News files should
404be world readable.</p>
409<p>Notification that new relevant news items will be displayed via the 405<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 406<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> 407updating&quot; messages:</p>
412<pre class="literal-block"> 408<pre class="literal-block">
413* Important: there are 5 unread news items. 409* Important: there are 5 unread news items.
416<p>Checks for new news messages should be displayed:</p> 412<p>Checks for new news messages should be displayed:</p>
417<ul class="simple"> 413<ul class="simple">
418<li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">sync</span></tt></li> 414<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> 415<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> 416<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> 417</ul>
418<p>The package manager does not need to know how to launch the user's choice of
419news client. This is consistent with the way configuration file updates are
420handled.</p>
423<p>The package manager may use a timestamp check file to avoid having to process 421<p>The package manager may use a timestamp check file to avoid having to process
424news items unnecessarily.</p> 422news items unnecessarily.</p>
425<p>The package manager must keep track of news items that have already been added 423<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 424to 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 425be 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 426that 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> 427method 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 428<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> 429filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p>
432</div> 430</div>
433</div> 431</div>
434<div class="section" id="news-item-clients"> 432<div class="section">
435<h2><a class="toc-backref" href="#id36" name="news-item-clients">News Item Clients</a></h2> 433<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 434<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> 435Unix 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 436<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 437<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> 438rather 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> 439file 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 440<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 441tool; 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 442be 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> 443desire them.</p>
446</div> 444</div>
447<div class="section" id="news-item-removal"> 445<div class="section">
448<h2><a class="toc-backref" href="#id37" name="news-item-removal">News Item Removal</a></h2> 446<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 447<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 448they 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> 449after 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> 450entries.</p>
453</div> 451</div>
454</div> 452</div>
455<div class="section" id="integration-with-existing-systems"> 453<div class="section">
456<h1><a class="toc-backref" href="#id38" name="integration-with-existing-systems">Integration with Existing Systems</a></h1> 454<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 455<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> 456items 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 457<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> 458forums. A similar tool can be used for these news items.</p>
461</div> 459</div>
462<div class="section" id="backwards-compatibility"> 460<div class="section">
463<h1><a class="toc-backref" href="#id39" name="backwards-compatibility">Backwards Compatibility</a></h1> 461<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 462<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> 463the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p>
466</div> 464</div>
467<div class="section" id="reference-implementation"> 465<div class="section">
468<h1><a class="toc-backref" href="#id40" name="reference-implementation">Reference Implementation</a></h1> 466<h1><a class="toc-backref" href="#id42" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1>
469<div class="section" id="portage-code"> 467<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> 468in 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> 469eselect module <a class="footnote-reference" href="#eselect-news" id="id18" name="id18">[16]</a>.</p>
472</div> 470</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"> 471<div class="section">
483<h1><a class="toc-backref" href="#id44" name="credits">Credits</a></h1> 472<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 473<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> 474Herbert <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, 475<p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear,
487Brian Harring, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec Warner for 476Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec
488input. Some of the ideas presented here are theirs, others go completely 477Warner for input. Some of the ideas presented here are theirs, others go
489against their suggestions.</p> 478completely against their suggestions.</p>
490</div> 479</div>
491<div class="section" id="example-files"> 480<div class="section">
492<h1><a class="toc-backref" href="#id45" name="example-files">Example Files</a></h1> 481<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> 482<dl class="docutils">
483<dt><a class="reference" href="glep-0042-extras/example-news-item.txt">example-news-item.txt</a></dt>
484<dd>An example news item.</dd>
485</dl>
494</div> 486</div>
495<div class="section" id="references"> 487<div class="section">
496<h1><a class="toc-backref" href="#id46" name="references">References</a></h1> 488<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"> 489<table class="docutils footnote" frame="void" id="bug-11359" rules="none">
498<colgroup><col class="label" /><col /></colgroup> 490<colgroup><col class="label" /><col /></colgroup>
499<tbody valign="top"> 491<tbody valign="top">
500<tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359 492<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;, 493&quot;[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging&quot;,
594<tbody valign="top"> 586<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; 587<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> 588<a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr>
597</tbody> 589</tbody>
598</table> 590</table>
591<table class="docutils footnote" frame="void" id="paludis" rules="none">
592<colgroup><col class="label" /><col /></colgroup>
593<tbody valign="top">
594<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>
595</tbody>
596</table>
597<table class="docutils footnote" frame="void" id="eselect-news" rules="none">
598<colgroup><col class="label" /><col /></colgroup>
599<tbody valign="top">
600<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>
601</tbody>
602</table>
599<table class="docutils footnote" frame="void" id="stuart-blog" rules="none"> 603<table class="docutils footnote" frame="void" id="stuart-blog" rules="none">
600<colgroup><col class="label" /><col /></colgroup> 604<colgroup><col class="label" /><col /></colgroup>
601<tbody valign="top"> 605<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, 606<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> 607<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> 608</tbody>
605</table> 609</table>
606<table class="docutils footnote" frame="void" id="id18" rules="none"> 610<table class="docutils footnote" frame="void" id="id20" rules="none">
607<colgroup><col class="label" /><col /></colgroup> 611<colgroup><col class="label" /><col /></colgroup>
608<tbody valign="top"> 612<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> 613<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> 614</tbody>
611</table> 615</table>
612</div> 616</div>
613<div class="section" id="copyright"> 617<div class="section">
614<h1><a class="toc-backref" href="#id47" name="copyright">Copyright</a></h1> 618<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> 619<p>This document has been placed in the public domain.</p>
616<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : --> 620<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
617</div> 621</div>
618 622
619</div> 623</div>
620<div class="footer"> 624<div class="footer">
621<hr class="footer" /> 625<hr class="footer" />
622<a class="reference" href="glep-0042.txt">View document source</a>. 626<a class="reference" href="glep-0042.txt">View document source</a>.
623Generated on: 2005-12-18 04:15 UTC. 627Generated on: 2007-10-13 13:39 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. 628Generated 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 629
626</div> 630</div>
627</body> 631</body>
628</html> 632</html>

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

  ViewVC Help
Powered by ViewVC 1.1.20