/[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.7 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.7 $</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: 2006/01/05 15:10:45 $</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, 18-Dec-2005, 5-Jan-2006</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>
90<li><a class="reference" href="#example-files" id="id45" name="id45">Example Files</a></li> 90<li><a class="reference" href="#example-files" id="id45" name="id45">Example Files</a></li>
91<li><a class="reference" href="#references" id="id46" name="id46">References</a></li> 91<li><a class="reference" href="#references" id="id46" name="id46">References</a></li>
92<li><a class="reference" href="#copyright" id="id47" name="id47">Copyright</a></li> 92<li><a class="reference" href="#copyright" id="id47" name="id47">Copyright</a></li>
93</ul> 93</ul>
94</div> 94</div>
95<div class="section" id="abstract"> 95<div class="section">
96<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>
97<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
98regarding tree-related items.</p> 98regarding tree-related items.</p>
99</div> 99</div>
100<div class="section" id="motivation"> 100<div class="section">
101<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>
102<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,
103occasionally an upgrade requires user intervention during the upgrade process. 103occasionally an upgrade requires user intervention during the upgrade process.
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> 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>
105and 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>
106<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
121<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
122which 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
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> 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>
124</div> 124</div>
125</div> 125</div>
126<div class="section" id="requirements"> 126<div class="section">
127<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>
128<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>
129<dl class="docutils"> 129<dl class="docutils">
130<dt>Preemptive</dt> 130<dt>Preemptive</dt>
131<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
132damage has already been done. Ideally, the system administrator would be 132damage has already been done. Ideally, the system administrator would be
177sources (for example, Forums, GWN, the main Gentoo website) without 177sources (for example, Forums, GWN, the main Gentoo website) without
178excessive difficulty. Similarly, easy interoperation with any future news 178excessive difficulty. Similarly, easy interoperation with any future news
179sources should not be precluded.</dd> 179sources should not be precluded.</dd>
180</dl> 180</dl>
181</div> 181</div>
182<div class="section" id="specification"> 182<div class="section">
183<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>
184<div class="section" id="overview"> 184<div class="section">
185<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>
186<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>
187<ol class="arabic simple"> 187<ol class="arabic simple">
188<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>
189<li>The news item is reviewed, following the process described in 189<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> 190<a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li>
200informing the user that there are unread news items.</li> 200informing 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 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
202Item Clients</a>.</li> 202Item Clients</a>.</li>
203</ol> 203</ol>
204</div> 204</div>
205<div class="section" id="required-portage-enhancements"> 205<div class="section">
206<h2><a class="toc-backref" href="#id25" name="required-portage-enhancements">Required Portage Enhancements</a></h2> 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> 207<p>The following extensions to Portage are required:</p>
208<ul class="simple"> 208<ul class="simple">
209<li>Every repository (including overlays) will require a unique identifier. It is 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 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) 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)
222or not the profile used for a given repository ID matches a certain base path 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> 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> 224</ul>
225<p>These extensions are assumed during the following specification.</p> 225<p>These extensions are assumed during the following specification.</p>
226</div> 226</div>
227<div class="section" id="news-item-identities"> 227<div class="section">
228<h2><a class="toc-backref" href="#id26" 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>
229<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
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>), 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>),
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 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
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 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
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>, 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>,
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> 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>
235</div> 235</div>
236<div class="section" id="news-item-directories"> 236<div class="section">
237<h2><a class="toc-backref" href="#id27" 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>
238<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
239news item's identifier.</p> 239news item's identifier.</p>
240<p>The directory will contain a file named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.en.txt</span></tt>, which 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
241contains 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>
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> 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>
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 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
244provided. However, only the English version of a news item is authoritative. 244provided. However, only the English version of a news item is authoritative.
245This anglocentricity is justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p> 245This anglocentricity is justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p>
246</div> 246</div>
247<div class="section" id="news-item-files"> 247<div class="section">
248<h2><a class="toc-backref" href="#id28" 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>
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 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
250compatibility with and for the same reasons as existing Gentoo documentation 250compatibility with and for the same reasons as existing Gentoo documentation
251<a class="footnote-reference" href="#docs-policy" id="id8" name="id8">[2]</a> and the tree <a class="footnote-reference" href="#glep-31" id="id9" name="id9">[7]</a>.</p> 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>
252<p>News items must be signed with a detached GPG signature.:</p> 252<p>News items must be signed with a detached GPG signature.:</p>
253<pre class="literal-block"> 253<pre class="literal-block">
258issues should be handled as part of the signing policy discussions.</p> 258issues should be handled as part of the signing policy discussions.</p>
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> 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>
260followed 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
261various optional and mandatory headers. Future GLEPs may propose new headers — 261various optional and mandatory headers. Future GLEPs may propose new headers —
262tools handling these news items must ignore any unrecognised header.</p> 262tools handling these news items must ignore any unrecognised header.</p>
263<div class="section" id="news-item-headers"> 263<div class="section">
264<h3><a class="toc-backref" href="#id29" 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>
265<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>
266<dl class="docutils"> 266<dl class="docutils">
267<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>
268<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd> 268<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd>
269<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>
325simple 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
326likely 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
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 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
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> 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>
329</div> 329</div>
330<div class="section" id="news-item-body"> 330<div class="section">
331<h3><a class="toc-backref" href="#id30" 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>
332<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
333text.</p> 333text.</p>
334<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
335characters 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
336terminal. Paragraphs should be separated by a blank line.</p> 336terminal. Paragraphs should be separated by a blank line.</p>
338guide). 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
339simply 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
340a 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
341administrated — this will be the case on many servers and routers, for example.</p> 341administrated — this will be the case on many servers and routers, for example.</p>
342</div> 342</div>
343<div class="section" id="example-news-item"> 343<div class="section">
344<h3><a class="toc-backref" href="#id31" 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>
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 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
346<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>
347</div> 347</div>
348</div> 348</div>
349<div class="section" id="news-item-quality-control"> 349<div class="section">
350<h2><a class="toc-backref" href="#id32" 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>
351<p>There have been complaints regarding the comprehensibility of some upgrade 351<p>There have been complaints regarding the comprehensibility of some upgrade
352notices 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
353developer 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,
354professionalism 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
355language 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>
368news 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.
369Thus, 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
370YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p> 370YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p>
371</div> 371</div>
372</div> 372</div>
373<div class="section" id="news-item-distribution"> 373<div class="section">
374<h2><a class="toc-backref" href="#id33" 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>
375<div class="section" id="server-side"> 375<div class="section">
376<h3><a class="toc-backref" href="#id34" 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>
377<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
378any need for polling of a remote source.</p> 378any need for polling of a remote source.</p>
379<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),
380location 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
381GLEP.</p> 381GLEP.</p>
395tree.</p> 395tree.</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 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> 397news item directories will all be immediately under the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt>
398directory.</p> 398directory.</p>
399</div> 399</div>
400<div class="section" id="client-side"> 400<div class="section">
401<h3><a class="toc-backref" href="#id35" 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>
402<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
403file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-${repoid}.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
404already exist) and append the news item identifier (eg 404already exist) and append the news item identifier (eg
405<tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p> 405<tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p>
406<p>All news item related files should be root owned and in the <tt class="docutils literal"><span class="pre">portage</span></tt> group 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
431method is not required by this GLEP.</p> 431method is not required by this GLEP.</p>
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 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
433filter 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>
434</div> 434</div>
435</div> 435</div>
436<div class="section" id="news-item-clients"> 436<div class="section">
437<h2><a class="toc-backref" href="#id36" 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>
438<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
439Unix 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>
440<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
441<tt class="docutils literal"><span class="pre">news-repoid.unread</span></tt> file. If a news client acts as an interactive reader 441<tt class="docutils literal"><span class="pre">news-repoid.unread</span></tt> file. If a news client acts as an interactive reader
442rather than a gateway, it should then add the name to a <tt class="docutils literal"><span class="pre">news-repoid.read</span></tt> 442rather than a gateway, it should then add the name to a <tt class="docutils literal"><span class="pre">news-repoid.read</span></tt>
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 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
445tool; 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
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 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
447desire them.</p> 447desire them.</p>
448</div> 448</div>
449<div class="section" id="news-item-removal"> 449<div class="section">
450<h2><a class="toc-backref" href="#id37" 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>
451<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
452they 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
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> 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>
454entries.</p> 454entries.</p>
455</div> 455</div>
456</div> 456</div>
457<div class="section" id="integration-with-existing-systems"> 457<div class="section">
458<h1><a class="toc-backref" href="#id38" 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>
459<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
460items 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>
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 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
462forums. A similar tool can be used for these news items.</p> 462forums. A similar tool can be used for these news items.</p>
463</div> 463</div>
464<div class="section" id="backwards-compatibility"> 464<div class="section">
465<h1><a class="toc-backref" href="#id39" 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>
466<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
467the <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>
468</div> 468</div>
469<div class="section" id="reference-implementation"> 469<div class="section">
470<h1><a class="toc-backref" href="#id40" 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>
471<div class="section" id="portage-code"> 471<div class="section">
472<h2><a class="toc-backref" href="#id41" 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>
473<p>TODO</p> 473<p>TODO</p>
474</div> 474</div>
475<div class="section" id="simple-eselect-news-client"> 475<div class="section">
476<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> 476<h2><a class="toc-backref" href="#id42" id="simple-eselect-news-client" name="simple-eselect-news-client">Simple <tt class="docutils literal"><span class="pre">eselect</span></tt> News Client</a></h2>
477<p>TODO Removed until the exact format details are figured out.</p> 477<p>TODO Removed until the exact format details are figured out.</p>
478</div> 478</div>
479<div class="section" id="simple-news-to-mail-forwarder"> 479<div class="section">
480<h2><a class="toc-backref" href="#id43" 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>
481<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>
482</div> 482</div>
483</div> 483</div>
484<div class="section" id="credits"> 484<div class="section">
485<h1><a class="toc-backref" href="#id44" name="credits">Credits</a></h1> 485<h1><a class="toc-backref" href="#id44" id="credits" name="credits">Credits</a></h1>
486<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
487Herbert <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>
488<p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, 488<p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear,
489Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec 489Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec
490Warner for input. Some of the ideas presented here are theirs, others go 490Warner for input. Some of the ideas presented here are theirs, others go
491completely against their suggestions.</p> 491completely against their suggestions.</p>
492</div> 492</div>
493<div class="section" id="example-files"> 493<div class="section">
494<h1><a class="toc-backref" href="#id45" 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>
495<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>
496</div> 496</div>
497<div class="section" id="references"> 497<div class="section">
498<h1><a class="toc-backref" href="#id46" name="references">References</a></h1> 498<h1><a class="toc-backref" href="#id46" id="references" name="references">References</a></h1>
499<table class="docutils footnote" frame="void" id="bug-11359" rules="none"> 499<table class="docutils footnote" frame="void" id="bug-11359" rules="none">
500<colgroup><col class="label" /><col /></colgroup> 500<colgroup><col class="label" /><col /></colgroup>
501<tbody valign="top"> 501<tbody valign="top">
502<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
503&quot;[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging&quot;, 503&quot;[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging&quot;,
610<tbody valign="top"> 610<tbody valign="top">
611<tr><td class="label"><a class="fn-backref" href="#id19" name="id18">[16]</a></td><td><a class="reference" href="glep-0042-extras/example-news-item.txt">glep-0042-extras/example-news-item.txt</a></td></tr> 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>
612</tbody> 612</tbody>
613</table> 613</table>
614</div> 614</div>
615<div class="section" id="copyright"> 615<div class="section">
616<h1><a class="toc-backref" href="#id47" name="copyright">Copyright</a></h1> 616<h1><a class="toc-backref" href="#id47" id="copyright" name="copyright">Copyright</a></h1>
617<p>This document has been placed in the public domain.</p> 617<p>This document has been placed in the public domain.</p>
618<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : --> 618<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
619</div> 619</div>
620 620
621</div> 621</div>
622<div class="footer"> 622<div class="footer">
623<hr class="footer" /> 623<hr class="footer" />
624<a class="reference" href="glep-0042.txt">View document source</a>. 624<a class="reference" href="glep-0042.txt">View document source</a>.
625Generated on: 2006-01-05 15:09 UTC. 625Generated on: 2006-02-13 16:26 UTC.
626Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. 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.
627 627
628</div> 628</div>
629</body> 629</body>
630</html> 630</html>

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

  ViewVC Help
Powered by ViewVC 1.1.20