/[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.9 Revision 1.12
… …
13 <style type="text/css"> 13 <style type="text/css">
14 14
15/* 15/*
16:Author: David Goodger 16:Author: David Goodger
17:Contact: goodger@users.sourceforge.net 17:Contact: goodger@users.sourceforge.net
18:date: $Date: 2006/03/02 00:19:39 $ 18:date: $Date: 2006/06/12 22:03:32 $
19:version: $Revision: 1.9 $ 19:version: $Revision: 1.12 $
20:copyright: This stylesheet has been placed in the public domain. 20:copyright: This stylesheet has been placed in the public domain.
21 21
22Default cascading style sheet for the PEP HTML output of Docutils. 22Default cascading style sheet for the PEP HTML output of Docutils.
23*/ 23*/
24 24
… …
273<tbody valign="top"> 273<tbody valign="top">
274<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td> 274<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td>
275</tr> 275</tr>
276<tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td> 276<tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td>
277</tr> 277</tr>
278<tr class="field"><th class="field-name">Version:</th><td class="field-body">$Revision: 1.9 $</td> 278<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.10</td>
279</tr> 279</tr>
280<tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh &lt;ciaranm&#32;&#97;t&#32;gentoo.org&gt;</td> 280<tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh &lt;ciaranm&#32;&#97;t&#32;gentoo.org&gt;</td>
281</tr> 281</tr>
282<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0042.txt?cvsroot=gentoo">$Date: 2006/03/02 00:19:39 $</a></td> 282<tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0042.txt?cvsroot=gentoo">2006/06/12 22:03:07</a></td>
283</tr> 283</tr>
284<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> 284<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
285</tr> 285</tr>
286<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> 286<tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
287</tr> 287</tr>
288<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td> 288<tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td>
289</tr> 289</tr>
290<tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td> 290<tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td>
291</tr> 291</tr>
292<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005, 18-Dec-2005, 5-Jan-2006, 2-Mar-2005</td> 292<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005, 18-Dec-2005, 5-Jan-2006, 2-Mar-2006, 6-Mar-2006, 12-Jun-2006</td>
293</tr> 293</tr>
294</tbody> 294</tbody>
295</table> 295</table>
296<hr /> 296<hr />
297<div class="contents topic"> 297<div class="contents topic">
298<p class="topic-title first"><a id="contents" name="contents">Contents</a></p> 298<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
299<ul class="simple"> 299<ul class="simple">
300<li><a class="reference" href="#abstract" id="id20" name="id20">Abstract</a></li> 300<li><a class="reference" href="#abstract" id="id22" name="id22">Abstract</a></li>
301<li><a class="reference" href="#motivation" id="id21" name="id21">Motivation</a></li> 301<li><a class="reference" href="#motivation" id="id23" name="id23">Motivation</a></li>
302<li><a class="reference" href="#requirements" id="id22" name="id22">Requirements</a></li> 302<li><a class="reference" href="#requirements" id="id24" name="id24">Requirements</a></li>
303<li><a class="reference" href="#specification" id="id23" name="id23">Specification</a><ul> 303<li><a class="reference" href="#specification" id="id25" name="id25">Specification</a><ul>
304<li><a class="reference" href="#overview" id="id24" name="id24">Overview</a></li> 304<li><a class="reference" href="#overview" id="id26" name="id26">Overview</a></li>
305<li><a class="reference" href="#required-portage-enhancements" id="id25" name="id25">Required Portage Enhancements</a></li> 305<li><a class="reference" href="#required-portage-enhancements" id="id27" name="id27">Required Portage Enhancements</a></li>
306<li><a class="reference" href="#news-item-identities" id="id26" name="id26">News Item Identities</a></li> 306<li><a class="reference" href="#news-item-identities" id="id28" name="id28">News Item Identities</a></li>
307<li><a class="reference" href="#news-item-directories" id="id27" name="id27">News Item Directories</a></li> 307<li><a class="reference" href="#news-item-directories" id="id29" name="id29">News Item Directories</a></li>
308<li><a class="reference" href="#news-item-files" id="id28" name="id28">News Item Files</a><ul> 308<li><a class="reference" href="#news-item-files" id="id30" name="id30">News Item Files</a><ul>
309<li><a class="reference" href="#news-item-headers" id="id29" name="id29">News Item Headers</a></li> 309<li><a class="reference" href="#news-item-headers" id="id31" name="id31">News Item Headers</a></li>
310<li><a class="reference" href="#news-item-body" id="id30" name="id30">News Item Body</a></li> 310<li><a class="reference" href="#news-item-body" id="id32" name="id32">News Item Body</a></li>
311<li><a class="reference" href="#example-news-item" id="id31" name="id31">Example News Item</a></li> 311<li><a class="reference" href="#example-news-item" id="id33" name="id33">Example News Item</a></li>
312</ul> 312</ul>
313</li> 313</li>
314<li><a class="reference" href="#news-item-quality-control" id="id32" name="id32">News Item Quality Control</a></li> 314<li><a class="reference" href="#news-item-quality-control" id="id34" name="id34">News Item Quality Control</a></li>
315<li><a class="reference" href="#news-item-distribution" id="id33" name="id33">News Item Distribution</a><ul> 315<li><a class="reference" href="#news-item-distribution" id="id35" name="id35">News Item Distribution</a><ul>
316<li><a class="reference" href="#server-side" id="id34" name="id34">Server Side</a></li> 316<li><a class="reference" href="#server-side" id="id36" name="id36">Server Side</a></li>
317<li><a class="reference" href="#client-side" id="id35" name="id35">Client Side</a></li> 317<li><a class="reference" href="#client-side" id="id37" name="id37">Client Side</a></li>
318</ul> 318</ul>
319</li> 319</li>
320<li><a class="reference" href="#news-item-clients" id="id36" name="id36">News Item Clients</a></li> 320<li><a class="reference" href="#news-item-clients" id="id38" name="id38">News Item Clients</a></li>
321<li><a class="reference" href="#news-item-removal" id="id37" name="id37">News Item Removal</a></li> 321<li><a class="reference" href="#news-item-removal" id="id39" name="id39">News Item Removal</a></li>
322</ul> 322</ul>
323</li> 323</li>
324<li><a class="reference" href="#integration-with-existing-systems" id="id38" name="id38">Integration with Existing Systems</a></li> 324<li><a class="reference" href="#integration-with-existing-systems" id="id40" name="id40">Integration with Existing Systems</a></li>
325<li><a class="reference" href="#backwards-compatibility" id="id39" name="id39">Backwards Compatibility</a></li> 325<li><a class="reference" href="#backwards-compatibility" id="id41" name="id41">Backwards Compatibility</a></li>
326<li><a class="reference" href="#reference-implementation" id="id40" name="id40">Reference Implementation</a></li> 326<li><a class="reference" href="#reference-implementation" id="id42" name="id42">Reference Implementation</a></li>
327<li><a class="reference" href="#credits" id="id41" name="id41">Credits</a></li> 327<li><a class="reference" href="#credits" id="id43" name="id43">Credits</a></li>
328<li><a class="reference" href="#example-files" id="id42" name="id42">Example Files</a></li> 328<li><a class="reference" href="#example-files" id="id44" name="id44">Example Files</a></li>
329<li><a class="reference" href="#references" id="id43" name="id43">References</a></li> 329<li><a class="reference" href="#references" id="id45" name="id45">References</a></li>
330<li><a class="reference" href="#copyright" id="id44" name="id44">Copyright</a></li> 330<li><a class="reference" href="#copyright" id="id46" name="id46">Copyright</a></li>
331</ul> 331</ul>
332</div> 332</div>
333<div class="section"> 333<div class="section">
334<h1><a class="toc-backref" href="#id20" id="abstract" name="abstract">Abstract</a></h1> 334<h1><a class="toc-backref" href="#id22" id="abstract" name="abstract">Abstract</a></h1>
335<p>This GLEP proposes a new way of informing users about important updates and news 335<p>This GLEP proposes a new way of informing users about important updates and news
336related to the tree.</p> 336related to the tree.</p>
337</div> 337</div>
338<div class="section"> 338<div class="section">
339<h1><a class="toc-backref" href="#id21" id="motivation" name="motivation">Motivation</a></h1> 339<h1><a class="toc-backref" href="#id23" id="motivation" name="motivation">Motivation</a></h1>
340<p>Although most package updates are clean and require little user action, 340<p>Although most package updates are clean and require little user action,
341occasionally an upgrade requires user intervention. Recent examples of the 341occasionally an upgrade requires user intervention. Recent examples of the
342latter include the <tt class="docutils literal"><span class="pre">gcc-3.4</span></tt> stabilisation on <tt class="docutils literal"><span class="pre">x86</span></tt> and the <tt class="docutils literal"><span class="pre">mysql-4.1</span></tt> 342latter include the <tt class="docutils literal"><span class="pre">gcc-3.4</span></tt> stabilisation on <tt class="docutils literal"><span class="pre">x86</span></tt> and the <tt class="docutils literal"><span class="pre">mysql-4.1</span></tt>
343database format changes.</p> 343database format changes.</p>
344<p>There are currently several ways of delivering important news items to our 344<p>There are currently several ways of delivering important news items to our
… …
360which are displayed post-install. That is a separate issue which is handled 360which are displayed post-install. That is a separate issue which is handled
361by <tt class="docutils literal"><span class="pre">elog</span></tt> <a class="footnote-reference" href="#bug-11359" id="id1" name="id1">[1]</a>.</p> 361by <tt class="docutils literal"><span class="pre">elog</span></tt> <a class="footnote-reference" href="#bug-11359" id="id1" name="id1">[1]</a>.</p>
362</div> 362</div>
363</div> 363</div>
364<div class="section"> 364<div class="section">
365<h1><a class="toc-backref" href="#id22" id="requirements" name="requirements">Requirements</a></h1> 365<h1><a class="toc-backref" href="#id24" id="requirements" name="requirements">Requirements</a></h1>
366<p>An adequate solution must meet all of the following requirements:</p> 366<p>An adequate solution must meet all of the following requirements:</p>
367<dl class="docutils"> 367<dl class="docutils">
368<dt>Preemptive</dt> 368<dt>Preemptive</dt>
369<dd>Users should be told of changes <em>before</em> they break a system, not after the 369<dd>Users should be told of changes <em>before</em> they break a system, not after the
370damage has already been done. Ideally, the system administrator would be 370damage has already been done. Ideally, the system administrator would be
… …
416excessive difficulty. Similarly, easy interoperation with any future news 416excessive difficulty. Similarly, easy interoperation with any future news
417sources should not be precluded.</dd> 417sources should not be precluded.</dd>
418</dl> 418</dl>
419</div> 419</div>
420<div class="section"> 420<div class="section">
421<h1><a class="toc-backref" href="#id23" id="specification" name="specification">Specification</a></h1> 421<h1><a class="toc-backref" href="#id25" id="specification" name="specification">Specification</a></h1>
422<div class="section"> 422<div class="section">
423<h2><a class="toc-backref" href="#id24" id="overview" name="overview">Overview</a></h2> 423<h2><a class="toc-backref" href="#id26" id="overview" name="overview">Overview</a></h2>
424<p>News items are published and delivered to users as follows:</p> 424<p>News items are published and delivered to users as follows:</p>
425<ol class="arabic simple"> 425<ol class="arabic simple">
426<li>A news item is written. The format to be used is described below.</li> 426<li>A news item is written. The format to be used is described below.</li>
427<li>The news item is reviewed, following the process described in 427<li>The news item is reviewed, following the process described in
428<a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li> 428<a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li>
… …
439<li>The news item is handled by the user's choice of news item reader. See <a class="reference" href="#news-item-clients">News 439<li>The news item is handled by the user's choice of news item reader. See <a class="reference" href="#news-item-clients">News
440Item Clients</a>.</li> 440Item Clients</a>.</li>
441</ol> 441</ol>
442</div> 442</div>
443<div class="section"> 443<div class="section">
444<h2><a class="toc-backref" href="#id25" id="required-portage-enhancements" name="required-portage-enhancements">Required Portage Enhancements</a></h2> 444<h2><a class="toc-backref" href="#id27" id="required-portage-enhancements" name="required-portage-enhancements">Required Portage Enhancements</a></h2>
445<p>The following extensions to Portage are required:</p> 445<p>The following extensions to Portage are required:</p>
446<ul class="simple"> 446<ul class="simple">
447<li>Every repository (including overlays) will require a unique identifier. It is 447<li>Every repository (including overlays) will require a unique identifier. It is
448assumed that an identifier will be a string consisting of characters from 448assumed that an identifier will be a string consisting of characters from
449<tt class="docutils literal"><span class="pre">a</span></tt> to <tt class="docutils literal"><span class="pre">z</span></tt>, <tt class="docutils literal"><span class="pre">A</span></tt> to <tt class="docutils literal"><span class="pre">Z</span></tt>, <tt class="docutils literal"><span class="pre">0</span></tt> to <tt class="docutils literal"><span class="pre">9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen) 449<tt class="docutils literal"><span class="pre">a</span></tt> to <tt class="docutils literal"><span class="pre">z</span></tt>, <tt class="docutils literal"><span class="pre">A</span></tt> to <tt class="docutils literal"><span class="pre">Z</span></tt>, <tt class="docutils literal"><span class="pre">0</span></tt> to <tt class="docutils literal"><span class="pre">9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen)
… …
455a repository with a given ID. It is assumed that this will be in the form of 455a repository with a given ID. It is assumed that this will be in the form of
456a <tt class="docutils literal"><span class="pre">portageq</span></tt> command (e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">get_repo_root</span> <span class="pre">gentoo-x86</span></tt>).</li> 456a <tt class="docutils literal"><span class="pre">portageq</span></tt> command (e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">get_repo_root</span> <span class="pre">gentoo-x86</span></tt>).</li>
457<li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">has_version</span></tt> to support restrictions to a 457<li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">has_version</span></tt> to support restrictions to a
458given repository ID.</li> 458given repository ID.</li>
459<li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span></tt> to implement a command which returns whether 459<li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span></tt> to implement a command which returns whether
460or not the profile used for a given repository ID matches a certain base path 460or not the profile used for a given repository ID is exactly the given profile
461(e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">profile_used</span> <span class="pre">default-linux/sparc/sparc64/2004.3</span> <span class="pre">gentoo-x86</span></tt>).</li> 461(e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">profile_used</span> <span class="pre">default-linux/sparc/sparc64/2004.3</span>
462<span class="pre">gentoo-x86</span></tt>).</li>
462</ul> 463</ul>
463<p>These extensions are assumed during the following specification.</p> 464<p>These extensions are assumed during the following specification.</p>
464</div> 465</div>
465<div class="section"> 466<div class="section">
466<h2><a class="toc-backref" href="#id26" id="news-item-identities" name="news-item-identities">News Item Identities</a></h2> 467<h2><a class="toc-backref" href="#id28" id="news-item-identities" name="news-item-identities">News Item Identities</a></h2>
467<p>Each news item will have a unique identifier. This identifier will be in the 468<p>Each news item will have a unique identifier. This identifier will be in the
468form <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name</span></tt>, where <tt class="docutils literal"><span class="pre">yyyy</span></tt> is the year (e.g. <tt class="docutils literal"><span class="pre">2005</span></tt>), 469form <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name</span></tt>, where <tt class="docutils literal"><span class="pre">yyyy</span></tt> is the year (e.g. <tt class="docutils literal"><span class="pre">2005</span></tt>),
469<tt class="docutils literal"><span class="pre">mm</span></tt> is the month (<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">12</span></tt>) and dd is the day of the month 470<tt class="docutils literal"><span class="pre">mm</span></tt> is the month (<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">12</span></tt>) and dd is the day of the month
470(<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">31</span></tt>). The <tt class="docutils literal"><span class="pre">short-name</span></tt> is a very short name describing the 471(<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">31</span></tt>). The <tt class="docutils literal"><span class="pre">short-name</span></tt> is a very short name describing the
471news item (e.g. <tt class="docutils literal"><span class="pre">yoursql-updates</span></tt>), consisting only of the characters <tt class="docutils literal"><span class="pre">a-z</span></tt>, 472news item (e.g. <tt class="docutils literal"><span class="pre">yoursql-updates</span></tt>), consisting only of the characters <tt class="docutils literal"><span class="pre">a-z</span></tt>,
472<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> 473<tt class="docutils literal"><span class="pre">0-9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen) and <tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</p>
473</div> 474</div>
474<div class="section"> 475<div class="section">
475<h2><a class="toc-backref" href="#id27" id="news-item-directories" name="news-item-directories">News Item Directories</a></h2> 476<h2><a class="toc-backref" href="#id29" id="news-item-directories" name="news-item-directories">News Item Directories</a></h2>
476<p>Each news item will be represented by a directory whose name is the same as the 477<p>Each news item will be represented by a directory whose name is the same as the
477news item's identifier.</p> 478news item's identifier.</p>
478<p>The directory will contain a file named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.en.txt</span></tt>, which 479<p>The directory will contain a file named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.en.txt</span></tt>, which
479contains the text of the news item, in English, in the format described below.</p> 480contains the text of the news item, in English, in the format described below.</p>
480<p>If a news item is translated, other files named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.xx.txt</span></tt> 481<p>If a news item is translated, other files named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.xx.txt</span></tt>
… …
482remains the same as the original news item) will also be provided. However, only 483remains the same as the original news item) will also be provided. However, only
483the English version of a news item is authoritative. This anglocentricity is 484the English version of a news item is authoritative. This anglocentricity is
484justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p> 485justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p>
485</div> 486</div>
486<div class="section"> 487<div class="section">
487<h2><a class="toc-backref" href="#id28" id="news-item-files" name="news-item-files">News Item Files</a></h2> 488<h2><a class="toc-backref" href="#id30" id="news-item-files" name="news-item-files">News Item Files</a></h2>
488<p>A news item file is a text file, encoded using UTF-8 <a class="footnote-reference" href="#rfc-3629" id="id7" name="id7">[14]</a> for 489<p>A news item file is a text file, encoded using UTF-8 <a class="footnote-reference" href="#rfc-3629" id="id7" name="id7">[14]</a> for
489compatibility with and for the same reasons as existing Gentoo documentation 490compatibility with and for the same reasons as existing Gentoo documentation
490<a class="footnote-reference" href="#docs-policy" id="id8" name="id8">[2]</a> and the tree <a class="footnote-reference" href="#glep-31" id="id9" name="id9">[7]</a>.</p> 491<a class="footnote-reference" href="#docs-policy" id="id8" name="id8">[2]</a> and the tree <a class="footnote-reference" href="#glep-31" id="id9" name="id9">[7]</a>.</p>
491<p>News items must be signed with a detached GPG signature.:</p> 492<p>News items must be signed with a detached GPG signature.:</p>
492<pre class="literal-block"> 493<pre class="literal-block">
… …
498<p>A news item file's content will consist of an <a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> style header <a class="footnote-reference" href="#rfc-822" id="id10" name="id10">[13]</a> 499<p>A news item file's content will consist of an <a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> style header <a class="footnote-reference" href="#rfc-822" id="id10" name="id10">[13]</a>
499followed by the main body of the message as plain text. This GLEP defines 500followed by the main body of the message as plain text. This GLEP defines
500various optional and mandatory headers. Future GLEPs may propose new headers — 501various optional and mandatory headers. Future GLEPs may propose new headers —
501tools handling these news items must ignore any unrecognised header.</p> 502tools handling these news items must ignore any unrecognised header.</p>
502<div class="section"> 503<div class="section">
503<h3><a class="toc-backref" href="#id29" id="news-item-headers" name="news-item-headers">News Item Headers</a></h3> 504<h3><a class="toc-backref" href="#id31" id="news-item-headers" name="news-item-headers">News Item Headers</a></h3>
504<p>The following headers describe the purpose and format of the news item:</p> 505<p>The following headers describe the purpose and format of the news item:</p>
505<dl class="docutils"> 506<dl class="docutils">
506<dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt> 507<dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt>
507<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd> 508<dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd>
508<dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt> 509<dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt>
… …
537<dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt> 538<dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt>
538<dd>A keyword <a class="footnote-reference" href="#glep-22" id="id12" name="id12">[6]</a> name, for example <tt class="docutils literal"><span class="pre">mips</span></tt> or <tt class="docutils literal"><span class="pre">x86-fbsd</span></tt>. If the 539<dd>A keyword <a class="footnote-reference" href="#glep-22" id="id12" name="id12">[6]</a> name, for example <tt class="docutils literal"><span class="pre">mips</span></tt> or <tt class="docutils literal"><span class="pre">x86-fbsd</span></tt>. If the
539user is on the keyword in question, the news item should be displayed.</dd> 540user is on the keyword in question, the news item should be displayed.</dd>
540<dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt> 541<dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt>
541<dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. If the 542<dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. If the
542user is using the exact profile in question, or a subprofile of this 543user is using the exact profile in question, the news item should be
543profile, the news item should be displayed. This header may be used to
544replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the future.</dd> 544displayed. This header may be used to replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the
545future.</dd>
545</dl> 546</dl>
546<div class="note"> 547<div class="note">
547<p class="first admonition-title">Note</p> 548<p class="first admonition-title">Note</p>
548<p class="last">When performing package moves, developers must also update any 549<p class="last">When performing package moves, developers must also update any
549relevant <tt class="docutils literal"><span class="pre">Display-If-Installed</span></tt> headers in news files.</p> 550relevant <tt class="docutils literal"><span class="pre">Display-If-Installed</span></tt> headers in news files.</p>
… …
566likely to occur than &quot;display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or 567likely to occur than &quot;display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or
567for people on <tt class="docutils literal"><span class="pre">sparc</span></tt> or <tt class="docutils literal"><span class="pre">x86-obsd</span></tt>&quot; or &quot;display these news items for 568for people on <tt class="docutils literal"><span class="pre">sparc</span></tt> or <tt class="docutils literal"><span class="pre">x86-obsd</span></tt>&quot; or &quot;display these news items for
568people who use <tt class="docutils literal"><span class="pre">YourSQL</span></tt> and who are on both <tt class="docutils literal"><span class="pre">sparc</span></tt> and <tt class="docutils literal"><span class="pre">x86-obsd</span></tt>&quot;.</p> 569people who use <tt class="docutils literal"><span class="pre">YourSQL</span></tt> and who are on both <tt class="docutils literal"><span class="pre">sparc</span></tt> and <tt class="docutils literal"><span class="pre">x86-obsd</span></tt>&quot;.</p>
569</div> 570</div>
570<div class="section"> 571<div class="section">
571<h3><a class="toc-backref" href="#id30" id="news-item-body" name="news-item-body">News Item Body</a></h3> 572<h3><a class="toc-backref" href="#id32" id="news-item-body" name="news-item-body">News Item Body</a></h3>
572<p>The header section must be followed by a blank line, then the main body of the 573<p>The header section must be followed by a blank line, then the main body of the
573text.</p> 574text.</p>
574<p>The text body should be wrapped at 72 characters. No fancy formatting or tab 575<p>The text body should be wrapped at 72 characters. No fancy formatting or tab
575characters should be used — the news item may be being displayed directly to a 576characters should be used — the news item may be being displayed directly to a
576terminal. Paragraphs should be separated by a blank line.</p> 577terminal. Paragraphs should be separated by a blank line.</p>
… …
579simply a &quot;read this link&quot; text. It is assumed that the user will have access to 580simply a &quot;read this link&quot; text. It is assumed that the user will have access to
580a web browser <em>somewhere</em>, but not necessarily on the box which is being 581a web browser <em>somewhere</em>, but not necessarily on the box which is being
581administrated — this will be the case on many servers and routers, for example.</p> 582administrated — this will be the case on many servers and routers, for example.</p>
582</div> 583</div>
583<div class="section"> 584<div class="section">
584<h3><a class="toc-backref" href="#id31" id="example-news-item" name="example-news-item">Example News Item</a></h3> 585<h3><a class="toc-backref" href="#id33" id="example-news-item" name="example-news-item">Example News Item</a></h3>
585<p><a class="reference" href="glep-0042-extras/example-news-item.txt">This hypothetical news item</a> <a class="footnote-reference" href="#id18" id="id19" name="id19">[16]</a> could be used for an upgrade to the 586<p><a class="reference" href="glep-0042-extras/example-news-item.txt">This hypothetical news item</a> <a class="footnote-reference" href="#id20" id="id21" name="id21">[18]</a> could be used for an upgrade to the
586<tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p> 587<tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p>
587</div> 588</div>
588</div> 589</div>
589<div class="section"> 590<div class="section">
590<h2><a class="toc-backref" href="#id32" id="news-item-quality-control" name="news-item-quality-control">News Item Quality Control</a></h2> 591<h2><a class="toc-backref" href="#id34" id="news-item-quality-control" name="news-item-quality-control">News Item Quality Control</a></h2>
591<p>There have been complaints regarding the comprehensibility of some upgrade 592<p>There have been complaints regarding the comprehensibility of some upgrade
592notices and news items in the past. This is understandable — not every Gentoo 593notices and news items in the past. This is understandable — not every Gentoo
593developer speaks English as a first language. However, for the sake of clarity, 594developer speaks English as a first language. However, for the sake of clarity,
594professionalism and avoiding making us look like prats, it is important that any 595professionalism and avoiding making us look like prats, it is important that any
595language problems be corrected before inflicting a news item upon end users.</p> 596language problems be corrected before inflicting a news item upon end users.</p>
… …
609Thus, the justification should be in the form &quot;this message is important to 610Thus, the justification should be in the form &quot;this message is important to
610YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p> 611YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p>
611</div> 612</div>
612</div> 613</div>
613<div class="section"> 614<div class="section">
614<h2><a class="toc-backref" href="#id33" id="news-item-distribution" name="news-item-distribution">News Item Distribution</a></h2> 615<h2><a class="toc-backref" href="#id35" id="news-item-distribution" name="news-item-distribution">News Item Distribution</a></h2>
615<div class="section"> 616<div class="section">
616<h3><a class="toc-backref" href="#id34" id="server-side" name="server-side">Server Side</a></h3> 617<h3><a class="toc-backref" href="#id36" id="server-side" name="server-side">Server Side</a></h3>
617<p>News items are to be made available via the standard rsync tree. This removes 618<p>News items are to be made available via the standard rsync tree. This removes
618any need for polling of a remote source.</p> 619any need for polling of a remote source.</p>
619<p>A new repository will be created for news items. The type (CVS or Subversion), 620<p>A new repository will be created for news items. The type (CVS or Subversion),
620location and access controls on this repository are beyond the scope of this 621location and access controls on this repository are beyond the scope of this
621GLEP.</p> 622GLEP.</p>
… …
636<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 637<p>The main rsync tree will <strong>not</strong> use the <tt class="docutils literal"><span class="pre">yyyy/mm/</span></tt> subdirectory layout. The
637news item directories will all be immediately under the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> 638news item directories will all be immediately under the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt>
638directory.</p> 639directory.</p>
639</div> 640</div>
640<div class="section"> 641<div class="section">
641<h3><a class="toc-backref" href="#id35" id="client-side" name="client-side">Client Side</a></h3> 642<h3><a class="toc-backref" href="#id37" id="client-side" name="client-side">Client Side</a></h3>
642<p>Whenever relevant unread news items are found, the package manager will create a 643<p>Whenever relevant unread news items are found, the package manager will create a
643file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-${repoid}.unread</span></tt> (if it does not 644file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-${repoid}.unread</span></tt> (if it does not
644already exist) and append the news item identifier (eg 645already exist) and append the news item identifier (eg
645<tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p> 646<tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p>
646<p>All news item related files should be root owned and in the <tt class="docutils literal"><span class="pre">portage</span></tt> group 647<p>All news item related files should be root owned and in the <tt class="docutils literal"><span class="pre">portage</span></tt> group
… …
672<p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to 673<p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to
673filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p> 674filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p>
674</div> 675</div>
675</div> 676</div>
676<div class="section"> 677<div class="section">
677<h2><a class="toc-backref" href="#id36" id="news-item-clients" name="news-item-clients">News Item Clients</a></h2> 678<h2><a class="toc-backref" href="#id38" id="news-item-clients" name="news-item-clients">News Item Clients</a></h2>
678<p>Once a news item is marked for reading, third party tools (or traditional core 679<p>Once a news item is marked for reading, third party tools (or traditional core
679Unix tools) can be used to display and view the news files.</p> 680Unix tools) can be used to display and view the news files.</p>
680<p>When a news item is read, its name should be removed from the 681<p>When a news item is read, its name should be removed from the
681<tt class="docutils literal"><span class="pre">news-${repoid}.unread</span></tt> file. If a news client acts as an interactive reader 682<tt class="docutils literal"><span class="pre">news-${repoid}.unread</span></tt> file. If a news client acts as an interactive reader
682rather than a gateway, it should then add the name to a <tt class="docutils literal"><span class="pre">news-${repoid}.read</span></tt> 683rather than a gateway, it should then add the name to a <tt class="docutils literal"><span class="pre">news-${repoid}.read</span></tt>
… …
685tool; other display tools (for example, a news to email forwarder, which would 686tool; other display tools (for example, a news to email forwarder, which would
686be ideal for users who sync on a <tt class="docutils literal"><span class="pre">cron</span></tt>) are left as options for those who 687be ideal for users who sync on a <tt class="docutils literal"><span class="pre">cron</span></tt>) are left as options for those who
687desire them.</p> 688desire them.</p>
688</div> 689</div>
689<div class="section"> 690<div class="section">
690<h2><a class="toc-backref" href="#id37" id="news-item-removal" name="news-item-removal">News Item Removal</a></h2> 691<h2><a class="toc-backref" href="#id39" id="news-item-removal" name="news-item-removal">News Item Removal</a></h2>
691<p>News items can be removed (by removing the news file from the main tree) when 692<p>News items can be removed (by removing the news file from the main tree) when
692they are no longer relevant, if they are made obsolete by a future news item or 693they are no longer relevant, if they are made obsolete by a future news item or
693after a long period of time. This is the same as the method used for <tt class="docutils literal"><span class="pre">updates</span></tt> 694after a long period of time. This is the same as the method used for <tt class="docutils literal"><span class="pre">updates</span></tt>
694entries.</p> 695entries.</p>
695</div> 696</div>
696</div> 697</div>
697<div class="section"> 698<div class="section">
698<h1><a class="toc-backref" href="#id38" id="integration-with-existing-systems" name="integration-with-existing-systems">Integration with Existing Systems</a></h1> 699<h1><a class="toc-backref" href="#id40" id="integration-with-existing-systems" name="integration-with-existing-systems">Integration with Existing Systems</a></h1>
699<p>It would be simple to convert these news items into the format used for news 700<p>It would be simple to convert these news items into the format used for news
700items on the Gentoo website or posts for the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list.</p> 701items on the Gentoo website or posts for the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list.</p>
701<p>There is an existing automated tool <a class="footnote-reference" href="#forums-glsa" id="id16" name="id16">[4]</a> for posting GLSAs to the 702<p>There is an existing automated tool <a class="footnote-reference" href="#forums-glsa" id="id16" name="id16">[4]</a> for posting GLSAs to the
702forums. A similar tool can be used for these news items.</p> 703forums. A similar tool can be used for these news items.</p>
703</div> 704</div>
704<div class="section"> 705<div class="section">
705<h1><a class="toc-backref" href="#id39" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1> 706<h1><a class="toc-backref" href="#id41" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
706<p>Backwards compatibility is not a concern here. Existing tools will simply ignore 707<p>Backwards compatibility is not a concern here. Existing tools will simply ignore
707the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p> 708the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p>
708</div> 709</div>
709<div class="section"> 710<div class="section">
710<h1><a class="toc-backref" href="#id40" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1> 711<h1><a class="toc-backref" href="#id42" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1>
711<p>TODO</p> 712<p>A reference implementation of the required package manager support can be found
713in Paludis <a class="footnote-reference" href="#paludis" id="id17" name="id17">[15]</a>, along with a reference newsreader implemented as an
714eselect module <a class="footnote-reference" href="#eselect-news" id="id18" name="id18">[16]</a>.</p>
712</div> 715</div>
713<div class="section"> 716<div class="section">
714<h1><a class="toc-backref" href="#id41" id="credits" name="credits">Credits</a></h1> 717<h1><a class="toc-backref" href="#id43" id="credits" name="credits">Credits</a></h1>
715<p>The idea behind notifying users of news updates via Portage comes from Stuart 718<p>The idea behind notifying users of news updates via Portage comes from Stuart
716Herbert <a class="footnote-reference" href="#stuart-blog" id="id17" name="id17">[15]</a>.</p> 719Herbert <a class="footnote-reference" href="#stuart-blog" id="id19" name="id19">[17]</a>.</p>
717<p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, 720<p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear,
718Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec 721Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec
719Warner for input. Some of the ideas presented here are theirs, others go 722Warner for input. Some of the ideas presented here are theirs, others go
720completely against their suggestions.</p> 723completely against their suggestions.</p>
721</div> 724</div>
722<div class="section"> 725<div class="section">
723<h1><a class="toc-backref" href="#id42" id="example-files" name="example-files">Example Files</a></h1> 726<h1><a class="toc-backref" href="#id44" id="example-files" name="example-files">Example Files</a></h1>
724<dl class="docutils"> 727<dl class="docutils">
725<dt><a class="reference" href="glep-0042-extras/example-news-item.txt">example-news-item.txt</a></dt> 728<dt><a class="reference" href="glep-0042-extras/example-news-item.txt">example-news-item.txt</a></dt>
726<dd>An example news item.</dd> 729<dd>An example news item.</dd>
727</dl> 730</dl>
728</div> 731</div>
729<div class="section"> 732<div class="section">
730<h1><a class="toc-backref" href="#id43" id="references" name="references">References</a></h1> 733<h1><a class="toc-backref" href="#id45" id="references" name="references">References</a></h1>
731<table class="docutils footnote" frame="void" id="bug-11359" rules="none"> 734<table class="docutils footnote" frame="void" id="bug-11359" rules="none">
732<colgroup><col class="label" /><col /></colgroup> 735<colgroup><col class="label" /><col /></colgroup>
733<tbody valign="top"> 736<tbody valign="top">
734<tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359 737<tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359
735&quot;[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging&quot;, 738&quot;[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging&quot;,
… …
828<tbody valign="top"> 831<tbody valign="top">
829<tr><td class="label"><a class="fn-backref" href="#id7" name="rfc-3629">[14]</a></td><td><a class="reference" href="http://www.faqs.org/rfcs/rfc3629.html">RFC 3629</a>: &quot;UTF-8, a transformation format of ISO 10646&quot; 832<tr><td class="label"><a class="fn-backref" href="#id7" name="rfc-3629">[14]</a></td><td><a class="reference" href="http://www.faqs.org/rfcs/rfc3629.html">RFC 3629</a>: &quot;UTF-8, a transformation format of ISO 10646&quot;
830<a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr> 833<a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr>
831</tbody> 834</tbody>
832</table> 835</table>
836<table class="docutils footnote" frame="void" id="paludis" rules="none">
837<colgroup><col class="label" /><col /></colgroup>
838<tbody valign="top">
839<tr><td class="label"><a class="fn-backref" href="#id17" name="paludis">[15]</a></td><td>Paludis homepage, <a class="reference" href="http://paludis.berlios.de">http://paludis.berlios.de</a></td></tr>
840</tbody>
841</table>
842<table class="docutils footnote" frame="void" id="eselect-news" rules="none">
843<colgroup><col class="label" /><col /></colgroup>
844<tbody valign="top">
845<tr><td class="label"><a class="fn-backref" href="#id18" name="eselect-news">[16]</a></td><td>news.eselect, <a class="reference" href="http://svn.berlios.de/svnroot/repos/paludis/trunk/eselect/news.eselect">http://svn.berlios.de/svnroot/repos/paludis/trunk/eselect/news.eselect</a></td></tr>
846</tbody>
847</table>
833<table class="docutils footnote" frame="void" id="stuart-blog" rules="none"> 848<table class="docutils footnote" frame="void" id="stuart-blog" rules="none">
834<colgroup><col class="label" /><col /></colgroup> 849<colgroup><col class="label" /><col /></colgroup>
835<tbody valign="top"> 850<tbody valign="top">
836<tr><td class="label"><a class="fn-backref" href="#id17" name="stuart-blog">[15]</a></td><td>&quot;Favouring an automatic news mechanism&quot;, Stuart Herbert, 851<tr><td class="label"><a class="fn-backref" href="#id19" name="stuart-blog">[17]</a></td><td>&quot;Favouring an automatic news mechanism&quot;, Stuart Herbert,
837<a class="reference" href="http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism">http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism</a></td></tr> 852<a class="reference" href="http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism">http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism</a></td></tr>
838</tbody> 853</tbody>
839</table> 854</table>
840<table class="docutils footnote" frame="void" id="id18" rules="none"> 855<table class="docutils footnote" frame="void" id="id20" rules="none">
841<colgroup><col class="label" /><col /></colgroup> 856<colgroup><col class="label" /><col /></colgroup>
842<tbody valign="top"> 857<tbody valign="top">
843<tr><td class="label"><a class="fn-backref" href="#id19" name="id18">[16]</a></td><td><a class="reference" href="glep-0042-extras/example-news-item.txt">glep-0042-extras/example-news-item.txt</a></td></tr> 858<tr><td class="label"><a class="fn-backref" href="#id21" name="id20">[18]</a></td><td><a class="reference" href="glep-0042-extras/example-news-item.txt">glep-0042-extras/example-news-item.txt</a></td></tr>
844</tbody> 859</tbody>
845</table> 860</table>
846</div> 861</div>
847<div class="section"> 862<div class="section">
848<h1><a class="toc-backref" href="#id44" id="copyright" name="copyright">Copyright</a></h1> 863<h1><a class="toc-backref" href="#id46" id="copyright" name="copyright">Copyright</a></h1>
849<p>This document has been placed in the public domain.</p> 864<p>This document has been placed in the public domain.</p>
850<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : --> 865<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
851</div> 866</div>
852 867
853</div> 868</div>
854<div class="footer"> 869<div class="footer">
855<hr class="footer" /> 870<hr class="footer" />
856<a class="reference" href="glep-0042.txt">View document source</a>. 871<a class="reference" href="glep-0042.txt">View document source</a>.
857Generated on: 2006-03-02 00:18 UTC. 872Generated on: 2006-06-12 22:11 UTC.
858Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. 873Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
859 874
860</div> 875</div>
861</body> 876</body>
862</html> 877</html>
Legend:
Removed from v.1.9  
changed lines
  Added in v.1.12
  ViewVC Help
Powered by ViewVC 1.1.13