| 1 | <?xml version="1.0" encoding="utf-8" ?> |
1 | <?xml version="1.0" encoding="utf-8" ?> |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| 4 | <!-- |
4 | |
| 5 | This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new |
|
|
| 6 | PEP, see http://www.python.org/peps/pep-0001.html for instructions and links |
|
|
| 7 | to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! |
|
|
| 8 | --> |
|
|
| 9 | <head> |
5 | <head> |
| 10 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
6 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| 11 | <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> |
7 | <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> |
| 12 | <title>GLEP 42 -- Critical News Reporting</title> |
8 | <title>GLEP 42 -- Critical News Reporting</title> |
| 13 | <link rel="stylesheet" href="tools/glep.css" type="text/css" /> |
9 | <link rel="stylesheet" href="tools/glep.css" type="text/css" /> |
| … | |
… | |
| 19 | <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> |
15 | <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> |
| 20 | <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
16 | <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
| 21 | border="0" width="150" height="35" /></a></td> |
17 | border="0" width="150" height="35" /></a></td> |
| 22 | <td class="textlinks" align="left"> |
18 | <td class="textlinks" align="left"> |
| 23 | [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
19 | [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
| 24 | [<b><a href="http://www.gentoo.org/peps">GLEP Index</a></b>] |
20 | [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] |
| 25 | [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0042.txt">GLEP Source</a></b>] |
21 | [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0042.txt">GLEP Source</a></b>] |
| 26 | </td></tr></table> |
22 | </td></tr></table> |
| 27 | <table class="rfc2822 docutils field-list" frame="void" rules="none"> |
23 | <table class="rfc2822 docutils field-list" frame="void" rules="none"> |
| 28 | <col class="field-name" /> |
24 | <col class="field-name" /> |
| 29 | <col class="field-body" /> |
25 | <col class="field-body" /> |
| 30 | <tbody valign="top"> |
26 | <tbody valign="top"> |
| 31 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td> |
27 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td> |
| 32 | </tr> |
28 | </tr> |
| 33 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td> |
29 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td> |
| 34 | </tr> |
30 | </tr> |
| 35 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.7</td> |
31 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.13</td> |
| 36 | </tr> |
32 | </tr> |
| 37 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh <ciaranm at gentoo.org></td> |
33 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh <ciaranm at gentoo.org>, |
|
|
34 | Stephen Bennett <spb at gentoo.org>, |
|
|
35 | Zach Medico <zmedico at gentoo.org></td> |
| 38 | </tr> |
36 | </tr> |
| 39 | <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0042.txt?cvsroot=gentoo">2006/01/05 15:10:45</a></td> |
37 | <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0042.txt?cvsroot=gentoo">2007/05/05 22:24:25</a></td> |
| 40 | </tr> |
38 | </tr> |
| 41 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> |
39 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Final</td> |
| 42 | </tr> |
40 | </tr> |
| 43 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
41 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
| 44 | </tr> |
42 | </tr> |
| 45 | <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td> |
43 | <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td> |
| 46 | </tr> |
44 | </tr> |
| 47 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td> |
45 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td> |
| 48 | </tr> |
46 | </tr> |
| 49 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005, 18-Dec-2005, 5-Jan-2006</td> |
47 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005, 18-Dec-2005, 5-Jan-2006, 2-Mar-2006, 6-Mar-2006, 12-Jun-2006, 5-Sep-2006</td> |
| 50 | </tr> |
48 | </tr> |
| 51 | </tbody> |
49 | </tbody> |
| 52 | </table> |
50 | </table> |
| 53 | <hr /> |
51 | <hr /> |
| 54 | <div class="contents topic"> |
52 | <div class="contents topic"> |
| 55 | <p class="topic-title first"><a id="contents" name="contents">Contents</a></p> |
53 | <p class="topic-title first"><a id="contents" name="contents">Contents</a></p> |
| 56 | <ul class="simple"> |
54 | <ul class="simple"> |
| 57 | <li><a class="reference" href="#abstract" id="id20" name="id20">Abstract</a></li> |
55 | <li><a class="reference" href="#abstract" id="id22" name="id22">Abstract</a></li> |
| 58 | <li><a class="reference" href="#motivation" id="id21" name="id21">Motivation</a></li> |
56 | <li><a class="reference" href="#motivation" id="id23" name="id23">Motivation</a></li> |
| 59 | <li><a class="reference" href="#requirements" id="id22" name="id22">Requirements</a></li> |
57 | <li><a class="reference" href="#requirements" id="id24" name="id24">Requirements</a></li> |
| 60 | <li><a class="reference" href="#specification" id="id23" name="id23">Specification</a><ul> |
58 | <li><a class="reference" href="#specification" id="id25" name="id25">Specification</a><ul> |
| 61 | <li><a class="reference" href="#overview" id="id24" name="id24">Overview</a></li> |
59 | <li><a class="reference" href="#overview" id="id26" name="id26">Overview</a></li> |
| 62 | <li><a class="reference" href="#required-portage-enhancements" id="id25" name="id25">Required Portage Enhancements</a></li> |
60 | <li><a class="reference" href="#required-portage-enhancements" id="id27" name="id27">Required Portage Enhancements</a></li> |
| 63 | <li><a class="reference" href="#news-item-identities" id="id26" name="id26">News Item Identities</a></li> |
61 | <li><a class="reference" href="#news-item-identities" id="id28" name="id28">News Item Identities</a></li> |
| 64 | <li><a class="reference" href="#news-item-directories" id="id27" name="id27">News Item Directories</a></li> |
62 | <li><a class="reference" href="#news-item-directories" id="id29" name="id29">News Item Directories</a></li> |
| 65 | <li><a class="reference" href="#news-item-files" id="id28" name="id28">News Item Files</a><ul> |
63 | <li><a class="reference" href="#news-item-files" id="id30" name="id30">News Item Files</a><ul> |
| 66 | <li><a class="reference" href="#news-item-headers" id="id29" name="id29">News Item Headers</a></li> |
64 | <li><a class="reference" href="#news-item-headers" id="id31" name="id31">News Item Headers</a></li> |
| 67 | <li><a class="reference" href="#news-item-body" id="id30" name="id30">News Item Body</a></li> |
65 | <li><a class="reference" href="#news-item-body" id="id32" name="id32">News Item Body</a></li> |
| 68 | <li><a class="reference" href="#example-news-item" id="id31" name="id31">Example News Item</a></li> |
66 | <li><a class="reference" href="#example-news-item" id="id33" name="id33">Example News Item</a></li> |
| 69 | </ul> |
67 | </ul> |
| 70 | </li> |
68 | </li> |
| 71 | <li><a class="reference" href="#news-item-quality-control" id="id32" name="id32">News Item Quality Control</a></li> |
69 | <li><a class="reference" href="#news-item-quality-control" id="id34" name="id34">News Item Quality Control</a></li> |
| 72 | <li><a class="reference" href="#news-item-distribution" id="id33" name="id33">News Item Distribution</a><ul> |
70 | <li><a class="reference" href="#news-item-distribution" id="id35" name="id35">News Item Distribution</a><ul> |
| 73 | <li><a class="reference" href="#server-side" id="id34" name="id34">Server Side</a></li> |
71 | <li><a class="reference" href="#server-side" id="id36" name="id36">Server Side</a></li> |
| 74 | <li><a class="reference" href="#client-side" id="id35" name="id35">Client Side</a></li> |
72 | <li><a class="reference" href="#client-side" id="id37" name="id37">Client Side</a></li> |
| 75 | </ul> |
73 | </ul> |
| 76 | </li> |
74 | </li> |
| 77 | <li><a class="reference" href="#news-item-clients" id="id36" name="id36">News Item Clients</a></li> |
75 | <li><a class="reference" href="#news-item-clients" id="id38" name="id38">News Item Clients</a></li> |
| 78 | <li><a class="reference" href="#news-item-removal" id="id37" name="id37">News Item Removal</a></li> |
76 | <li><a class="reference" href="#news-item-removal" id="id39" name="id39">News Item Removal</a></li> |
| 79 | </ul> |
77 | </ul> |
| 80 | </li> |
78 | </li> |
| 81 | <li><a class="reference" href="#integration-with-existing-systems" id="id38" name="id38">Integration with Existing Systems</a></li> |
79 | <li><a class="reference" href="#integration-with-existing-systems" id="id40" name="id40">Integration with Existing Systems</a></li> |
| 82 | <li><a class="reference" href="#backwards-compatibility" id="id39" name="id39">Backwards Compatibility</a></li> |
80 | <li><a class="reference" href="#backwards-compatibility" id="id41" name="id41">Backwards Compatibility</a></li> |
| 83 | <li><a class="reference" href="#reference-implementation" id="id40" name="id40">Reference Implementation</a><ul> |
81 | <li><a class="reference" href="#reference-implementation" id="id42" name="id42">Reference Implementation</a></li> |
| 84 | <li><a class="reference" href="#portage-code" id="id41" name="id41">Portage Code</a></li> |
|
|
| 85 | <li><a class="reference" href="#simple-eselect-news-client" id="id42" name="id42">Simple <tt class="docutils literal"><span class="pre">eselect</span></tt> News Client</a></li> |
|
|
| 86 | <li><a class="reference" href="#simple-news-to-mail-forwarder" id="id43" name="id43">Simple News to Mail Forwarder</a></li> |
|
|
| 87 | </ul> |
|
|
| 88 | </li> |
|
|
| 89 | <li><a class="reference" href="#credits" id="id44" name="id44">Credits</a></li> |
82 | <li><a class="reference" href="#credits" id="id43" name="id43">Credits</a></li> |
| 90 | <li><a class="reference" href="#example-files" id="id45" name="id45">Example Files</a></li> |
83 | <li><a class="reference" href="#example-files" id="id44" name="id44">Example Files</a></li> |
| 91 | <li><a class="reference" href="#references" id="id46" name="id46">References</a></li> |
84 | <li><a class="reference" href="#references" id="id45" name="id45">References</a></li> |
| 92 | <li><a class="reference" href="#copyright" id="id47" name="id47">Copyright</a></li> |
85 | <li><a class="reference" href="#copyright" id="id46" name="id46">Copyright</a></li> |
| 93 | </ul> |
86 | </ul> |
| 94 | </div> |
87 | </div> |
| 95 | <div class="section"> |
88 | <div class="section"> |
| 96 | <h1><a class="toc-backref" href="#id20" id="abstract" name="abstract">Abstract</a></h1> |
89 | <h1><a class="toc-backref" href="#id22" id="abstract" name="abstract">Abstract</a></h1> |
| 97 | <p>This GLEP proposes a new way of informing users about important updates and news |
90 | <p>This GLEP proposes a new way of informing users about important updates and news |
| 98 | regarding tree-related items.</p> |
91 | related to the tree.</p> |
| 99 | </div> |
92 | </div> |
| 100 | <div class="section"> |
93 | <div class="section"> |
| 101 | <h1><a class="toc-backref" href="#id21" id="motivation" name="motivation">Motivation</a></h1> |
94 | <h1><a class="toc-backref" href="#id23" id="motivation" name="motivation">Motivation</a></h1> |
| 102 | <p>Although most package updates are clean and require little user action, |
95 | <p>Although most package updates are clean and require little user action, |
| 103 | occasionally an upgrade requires user intervention during the upgrade process. |
96 | occasionally an upgrade requires user intervention. Recent examples of the |
| 104 | Recent 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> |
97 | 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> and the <tt class="docutils literal"><span class="pre">mysql-4.1</span></tt> |
| 105 | and the <tt class="docutils literal"><span class="pre">mysql-4.1</span></tt> database format changes.</p> |
98 | database format changes.</p> |
| 106 | <p>There are currently several ways of delivering important news items to our |
99 | <p>There are currently several ways of delivering important news items to our |
| 107 | users, none of them particularly effective:</p> |
100 | users, none of them particularly effective:</p> |
| 108 | <ul class="simple"> |
101 | <ul class="simple"> |
| 109 | <li>Gentoo Weekly News</li> |
102 | <li>Gentoo Weekly News</li> |
| 110 | <li>The <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt>, <tt class="docutils literal"><span class="pre">gentoo-user</span></tt> and <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt> mailing lists</li> |
103 | <li>The <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt>, <tt class="docutils literal"><span class="pre">gentoo-user</span></tt> and <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt> mailing lists</li> |
| … | |
… | |
| 112 | <li>The main Gentoo website</li> |
105 | <li>The main Gentoo website</li> |
| 113 | <li>RSS feeds of Gentoo news</li> |
106 | <li>RSS feeds of Gentoo news</li> |
| 114 | <li><tt class="docutils literal"><span class="pre">einfo</span></tt> and <tt class="docutils literal"><span class="pre">ewarn</span></tt> messages in <tt class="docutils literal"><span class="pre">pkg_setup</span></tt> or <tt class="docutils literal"><span class="pre">pkg_postinst</span></tt></li> |
107 | <li><tt class="docutils literal"><span class="pre">einfo</span></tt> and <tt class="docutils literal"><span class="pre">ewarn</span></tt> messages in <tt class="docutils literal"><span class="pre">pkg_setup</span></tt> or <tt class="docutils literal"><span class="pre">pkg_postinst</span></tt></li> |
| 115 | </ul> |
108 | </ul> |
| 116 | <p>A more reliable way of getting news of critical updates out to users is required |
109 | <p>A more reliable way of getting news of critical updates out to users is required |
| 117 | to avoid repeats of the various recent upgrade debacles. This GLEP proposes a |
110 | to avoid repeats of various prior upgrade debacles. This GLEP proposes a |
| 118 | solution based around pushing news items out to the user via the <tt class="docutils literal"><span class="pre">rsync</span></tt> tree.</p> |
111 | solution based around pushing news items out to the user via the <tt class="docutils literal"><span class="pre">rsync</span></tt> tree.</p> |
| 119 | <div class="important"> |
112 | <div class="important"> |
| 120 | <p class="first admonition-title">Important</p> |
113 | <p class="first admonition-title">Important</p> |
| 121 | <p class="last">This GLEP does not seek to replace or modify <tt class="docutils literal"><span class="pre">einfo</span></tt> messages |
114 | <p class="last">This GLEP does not seek to replace or modify <tt class="docutils literal"><span class="pre">einfo</span></tt> messages |
| 122 | which are displayed post-install. That is a separate issue which is handled |
115 | which are displayed post-install. That is a separate issue which is handled |
| 123 | by <tt class="docutils literal"><span class="pre">elog</span></tt> <a class="footnote-reference" href="#bug-11359" id="id1" name="id1">[1]</a>.</p> |
116 | by <tt class="docutils literal"><span class="pre">elog</span></tt> <a class="footnote-reference" href="#bug-11359" id="id1" name="id1">[1]</a>.</p> |
| 124 | </div> |
117 | </div> |
| 125 | </div> |
118 | </div> |
| 126 | <div class="section"> |
119 | <div class="section"> |
| 127 | <h1><a class="toc-backref" href="#id22" id="requirements" name="requirements">Requirements</a></h1> |
120 | <h1><a class="toc-backref" href="#id24" id="requirements" name="requirements">Requirements</a></h1> |
| 128 | <p>An adequate solution must meet all of the following requirements:</p> |
121 | <p>An adequate solution must meet all of the following requirements:</p> |
| 129 | <dl class="docutils"> |
122 | <dl class="docutils"> |
| 130 | <dt>Preemptive</dt> |
123 | <dt>Preemptive</dt> |
| 131 | <dd>Users should be told of changes <em>before</em> they break a system, not after the |
124 | <dd>Users should be told of changes <em>before</em> they break a system, not after the |
| 132 | damage has already been done. Ideally, the system administrator would be |
125 | damage has already been done. Ideally, the system administrator would be |
| 133 | given ample warning to plan difficult upgrades and changes, rather than only |
126 | given ample warning to plan difficult upgrades and changes, rather than only |
| 134 | being told just before action is necessary.</dd> |
127 | being told just before action is necessary.</dd> |
| 135 | <dt>No user subscription required</dt> |
128 | <dt>No user subscription required</dt> |
| 136 | <dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id2" name="id2">[5]</a> that many users do not |
129 | <dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id2" name="id2">[5]</a> that many users do not |
| 137 | read the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list or <tt class="docutils literal"><span class="pre">RSS</span></tt> feeds. A solution which |
130 | read the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list or <tt class="docutils literal"><span class="pre">RSS</span></tt> feeds. A solution that |
| 138 | requires subscription has no advantage over current methods.</dd> |
131 | requires subscription has no advantage over current methods.</dd> |
| 139 | <dt>No user monitoring required</dt> |
132 | <dt>No user monitoring required</dt> |
| 140 | <dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id3" name="id3">[5]</a> that many users do not |
133 | <dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id3" name="id3">[5]</a> that many users do not |
| 141 | read news items posted to the Gentoo website, or do not read news items |
134 | read news items posted to the Gentoo website, or do not read news items |
| 142 | until it is too late. A solution that relies upon active monitoring of a |
135 | until it is too late. A solution that relies upon active monitoring of a |
| … | |
… | |
| 178 | excessive difficulty. Similarly, easy interoperation with any future news |
171 | excessive difficulty. Similarly, easy interoperation with any future news |
| 179 | sources should not be precluded.</dd> |
172 | sources should not be precluded.</dd> |
| 180 | </dl> |
173 | </dl> |
| 181 | </div> |
174 | </div> |
| 182 | <div class="section"> |
175 | <div class="section"> |
| 183 | <h1><a class="toc-backref" href="#id23" id="specification" name="specification">Specification</a></h1> |
176 | <h1><a class="toc-backref" href="#id25" id="specification" name="specification">Specification</a></h1> |
| 184 | <div class="section"> |
177 | <div class="section"> |
| 185 | <h2><a class="toc-backref" href="#id24" id="overview" name="overview">Overview</a></h2> |
178 | <h2><a class="toc-backref" href="#id26" id="overview" name="overview">Overview</a></h2> |
| 186 | <p>News items are published and delivered to users as follows:</p> |
179 | <p>News items are published and delivered to users as follows:</p> |
| 187 | <ol class="arabic simple"> |
180 | <ol class="arabic simple"> |
| 188 | <li>A news item is written. The format to be used is described below.</li> |
181 | <li>A news item is written. The format to be used is described below.</li> |
| 189 | <li>The news item is reviewed, following the process described in |
182 | <li>The news item is reviewed, following the process described in |
| 190 | <a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li> |
183 | <a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li> |
| … | |
… | |
| 201 | <li>The news item is handled by the user's choice of news item reader. See <a class="reference" href="#news-item-clients">News |
194 | <li>The news item is handled by the user's choice of news item reader. See <a class="reference" href="#news-item-clients">News |
| 202 | Item Clients</a>.</li> |
195 | Item Clients</a>.</li> |
| 203 | </ol> |
196 | </ol> |
| 204 | </div> |
197 | </div> |
| 205 | <div class="section"> |
198 | <div class="section"> |
| 206 | <h2><a class="toc-backref" href="#id25" id="required-portage-enhancements" name="required-portage-enhancements">Required Portage Enhancements</a></h2> |
199 | <h2><a class="toc-backref" href="#id27" id="required-portage-enhancements" name="required-portage-enhancements">Required Portage Enhancements</a></h2> |
| 207 | <p>The following extensions to Portage are required:</p> |
200 | <p>The following extensions to Portage are required:</p> |
| 208 | <ul class="simple"> |
201 | <ul class="simple"> |
| 209 | <li>Every repository (including overlays) will require a unique identifier. It is |
202 | <li>Every repository (including overlays) will require a unique identifier. It is |
| 210 | assumed that an identifier will be a string consisting of characters from |
203 | assumed 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) |
204 | <tt class="docutils literal"><span class="pre">a</span></tt> to <tt class="docutils literal"><span class="pre">z</span></tt>, <tt class="docutils literal"><span class="pre">A</span></tt> to <tt class="docutils literal"><span class="pre">Z</span></tt>, <tt class="docutils literal"><span class="pre">0</span></tt> to <tt class="docutils literal"><span class="pre">9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen) |
| … | |
… | |
| 217 | a repository with a given ID. It is assumed that this will be in the form of |
210 | a repository with a given ID. It is assumed that this will be in the form of |
| 218 | a <tt class="docutils literal"><span class="pre">portageq</span></tt> command (e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">get_repo_root</span> <span class="pre">gentoo-x86</span></tt>).</li> |
211 | a <tt class="docutils literal"><span class="pre">portageq</span></tt> command (e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">get_repo_root</span> <span class="pre">gentoo-x86</span></tt>).</li> |
| 219 | <li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">has_version</span></tt> to support restrictions to a |
212 | <li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">has_version</span></tt> to support restrictions to a |
| 220 | given repository ID.</li> |
213 | given repository ID.</li> |
| 221 | <li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span></tt> to implement a command which returns whether |
214 | <li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span></tt> to implement a command which returns whether |
| 222 | or not the profile used for a given repository ID matches a certain base path |
215 | or not the profile used for a given repository ID is exactly the given profile |
| 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> |
216 | (e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">profile_used</span> <span class="pre">default-linux/sparc/sparc64/2004.3</span> |
|
|
217 | <span class="pre">gentoo-x86</span></tt>).</li> |
| 224 | </ul> |
218 | </ul> |
| 225 | <p>These extensions are assumed during the following specification.</p> |
219 | <p>These extensions are assumed during the following specification.</p> |
| 226 | </div> |
220 | </div> |
| 227 | <div class="section"> |
221 | <div class="section"> |
| 228 | <h2><a class="toc-backref" href="#id26" id="news-item-identities" name="news-item-identities">News Item Identities</a></h2> |
222 | <h2><a class="toc-backref" href="#id28" id="news-item-identities" name="news-item-identities">News Item Identities</a></h2> |
| 229 | <p>Each news item will have a unique identifier. This identifier will be in the |
223 | <p>Each news item will have a unique identifier. This identifier will be in the |
| 230 | form <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>), |
224 | form <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 |
225 | <tt class="docutils literal"><span class="pre">mm</span></tt> is the month (<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">12</span></tt>) and dd is the day of the month |
| 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 |
226 | (<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">31</span></tt>). The <tt class="docutils literal"><span class="pre">short-name</span></tt> is a very short name describing the |
| 233 | news 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>, |
227 | news 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> |
228 | <tt class="docutils literal"><span class="pre">0-9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen) and <tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</p> |
| 235 | </div> |
229 | </div> |
| 236 | <div class="section"> |
230 | <div class="section"> |
| 237 | <h2><a class="toc-backref" href="#id27" id="news-item-directories" name="news-item-directories">News Item Directories</a></h2> |
231 | <h2><a class="toc-backref" href="#id29" id="news-item-directories" name="news-item-directories">News Item Directories</a></h2> |
| 238 | <p>Each news item will be represented by a directory whose name is the same as the |
232 | <p>Each news item will be represented by a directory whose name is the same as the |
| 239 | news item's identifier.</p> |
233 | news 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 |
234 | <p>The directory will contain a file named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.en.txt</span></tt>, which |
| 241 | contains the text of the news item, in English, in the format described below.</p> |
235 | contains 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> |
236 | <p>If a news item is translated, other files named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.xx.txt</span></tt> |
| 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 |
237 | (where <tt class="docutils literal"><span class="pre">xx</span></tt> is the ISO 639 <a class="footnote-reference" href="#iso-639" id="id5" name="id5">[11]</a> two letter country code, and the date |
| 244 | provided. However, only the English version of a news item is authoritative. |
238 | remains the same as the original news item) will also be provided. However, only |
|
|
239 | the English version of a news item is authoritative. This anglocentricity is |
| 245 | This anglocentricity is justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p> |
240 | justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p> |
| 246 | </div> |
241 | </div> |
| 247 | <div class="section"> |
242 | <div class="section"> |
| 248 | <h2><a class="toc-backref" href="#id28" id="news-item-files" name="news-item-files">News Item Files</a></h2> |
243 | <h2><a class="toc-backref" href="#id30" id="news-item-files" name="news-item-files">News Item Files</a></h2> |
| 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 |
244 | <p>A news item file is a text file, encoded using UTF-8 <a class="footnote-reference" href="#rfc-3629" id="id7" name="id7">[14]</a> for |
| 250 | compatibility with and for the same reasons as existing Gentoo documentation |
245 | compatibility 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> |
246 | <a class="footnote-reference" href="#docs-policy" id="id8" name="id8">[2]</a> and the tree <a class="footnote-reference" href="#glep-31" id="id9" name="id9">[7]</a>.</p> |
| 252 | <p>News items must be signed with a detached GPG signature.:</p> |
247 | <p>News items must be signed with a detached GPG signature.:</p> |
| 253 | <pre class="literal-block"> |
248 | <pre class="literal-block"> |
| … | |
… | |
| 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> |
254 | <p>A news item file's content will consist of an <a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> style header <a class="footnote-reference" href="#rfc-822" id="id10" name="id10">[13]</a> |
| 260 | followed by the main body of the message as plain text. This GLEP defines |
255 | followed by the main body of the message as plain text. This GLEP defines |
| 261 | various optional and mandatory headers. Future GLEPs may propose new headers — |
256 | various optional and mandatory headers. Future GLEPs may propose new headers — |
| 262 | tools handling these news items must ignore any unrecognised header.</p> |
257 | tools handling these news items must ignore any unrecognised header.</p> |
| 263 | <div class="section"> |
258 | <div class="section"> |
| 264 | <h3><a class="toc-backref" href="#id29" id="news-item-headers" name="news-item-headers">News Item Headers</a></h3> |
259 | <h3><a class="toc-backref" href="#id31" id="news-item-headers" name="news-item-headers">News Item Headers</a></h3> |
| 265 | <p>The following headers describe the purpose and format of the news item:</p> |
260 | <p>The following headers describe the purpose and format of the news item:</p> |
| 266 | <dl class="docutils"> |
261 | <dl class="docutils"> |
| 267 | <dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt> |
262 | <dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt> |
| 268 | <dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd> |
263 | <dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd> |
| 269 | <dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt> |
264 | <dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt> |
| … | |
… | |
| 274 | translator headers may be specified if appropriate.</dd> |
269 | translator headers may be specified if appropriate.</dd> |
| 275 | <dt><tt class="docutils literal"><span class="pre">Content-Type:</span></tt></dt> |
270 | <dt><tt class="docutils literal"><span class="pre">Content-Type:</span></tt></dt> |
| 276 | <dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd> |
271 | <dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd> |
| 277 | <dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt> |
272 | <dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt> |
| 278 | <dd>Date of posting, in <tt class="docutils literal"><span class="pre">yyyy-mm-dd</span></tt> format (e.g. 2005-12-18) for |
273 | <dd>Date of posting, in <tt class="docutils literal"><span class="pre">yyyy-mm-dd</span></tt> format (e.g. 2005-12-18) for |
| 279 | compatibility with GLEP 45 <a class="footnote-reference" href="#glep-45" id="id11" name="id11">[10]</a>. Mandatory.</dd> |
274 | compatibility with GLEP 45 <a class="footnote-reference" href="#glep-45" id="id11" name="id11">[10]</a>. Translations should use the date |
|
|
275 | of the original news item. Mandatory.</dd> |
| 280 | <dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt> |
276 | <dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt> |
| 281 | <dd>Initially 1. Should be incremented every time a change is made to the news |
277 | <dd>Initially 1. Should be incremented every time a change is made to the news |
| 282 | item. Changes that require a re-read of the news item (i.e., most changes |
278 | item. Changes that require a re-read of the news item (i.e., most changes |
| 283 | that are not spelling or formatting related) should instead use a new news |
279 | that are not spelling or formatting related) should instead use a new news |
| 284 | item. Mandatory.</dd> |
280 | item. Mandatory.</dd> |
| … | |
… | |
| 297 | <dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt> |
293 | <dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt> |
| 298 | <dd>A keyword <a class="footnote-reference" href="#glep-22" id="id12" name="id12">[6]</a> name, for example <tt class="docutils literal"><span class="pre">mips</span></tt> or <tt class="docutils literal"><span class="pre">x86-fbsd</span></tt>. If the |
294 | <dd>A keyword <a class="footnote-reference" href="#glep-22" id="id12" name="id12">[6]</a> name, for example <tt class="docutils literal"><span class="pre">mips</span></tt> or <tt class="docutils literal"><span class="pre">x86-fbsd</span></tt>. If the |
| 299 | user is on the keyword in question, the news item should be displayed.</dd> |
295 | user is on the keyword in question, the news item should be displayed.</dd> |
| 300 | <dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt> |
296 | <dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt> |
| 301 | <dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. If the |
297 | <dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. If the |
| 302 | user is using the exact profile in question, or a subprofile of this |
298 | user is using the exact profile in question, the news item should be |
| 303 | profile, the news item should be displayed. This header may be used to |
|
|
| 304 | replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the future.</dd> |
299 | displayed. This header may be used to replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the |
|
|
300 | future.</dd> |
| 305 | </dl> |
301 | </dl> |
| 306 | <div class="note"> |
302 | <div class="note"> |
| 307 | <p class="first admonition-title">Note</p> |
303 | <p class="first admonition-title">Note</p> |
| 308 | <p class="last">When performing package moves, developers must also update any |
304 | <p class="last">When performing package moves, developers must also update any |
| 309 | relevant <tt class="docutils literal"><span class="pre">Display-If-Installed</span></tt> headers in news files.</p> |
305 | relevant <tt class="docutils literal"><span class="pre">Display-If-Installed</span></tt> headers in news files.</p> |
| … | |
… | |
| 326 | likely to occur than "display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or |
322 | likely to occur than "display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or |
| 327 | for people on <tt class="docutils literal"><span class="pre">sparc</span></tt> or <tt class="docutils literal"><span class="pre">x86-obsd</span></tt>" or "display these news items for |
323 | for people on <tt class="docutils literal"><span class="pre">sparc</span></tt> or <tt class="docutils literal"><span class="pre">x86-obsd</span></tt>" or "display these news items for |
| 328 | people 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>".</p> |
324 | people 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>".</p> |
| 329 | </div> |
325 | </div> |
| 330 | <div class="section"> |
326 | <div class="section"> |
| 331 | <h3><a class="toc-backref" href="#id30" id="news-item-body" name="news-item-body">News Item Body</a></h3> |
327 | <h3><a class="toc-backref" href="#id32" id="news-item-body" name="news-item-body">News Item Body</a></h3> |
| 332 | <p>The header section must be followed by a blank line, then the main body of the |
328 | <p>The header section must be followed by a blank line, then the main body of the |
| 333 | text.</p> |
329 | text.</p> |
| 334 | <p>The text body should be wrapped at 72 characters. No fancy formatting or tab |
330 | <p>The text body should be wrapped at 72 characters. No fancy formatting or tab |
| 335 | characters should be used — the news item may be being displayed directly to a |
331 | characters should be used — the news item may be being displayed directly to a |
| 336 | terminal. Paragraphs should be separated by a blank line.</p> |
332 | terminal. Paragraphs should be separated by a blank line.</p> |
| … | |
… | |
| 339 | simply a "read this link" text. It is assumed that the user will have access to |
335 | simply a "read this link" text. It is assumed that the user will have access to |
| 340 | a web browser <em>somewhere</em>, but not necessarily on the box which is being |
336 | a web browser <em>somewhere</em>, but not necessarily on the box which is being |
| 341 | administrated — this will be the case on many servers and routers, for example.</p> |
337 | administrated — this will be the case on many servers and routers, for example.</p> |
| 342 | </div> |
338 | </div> |
| 343 | <div class="section"> |
339 | <div class="section"> |
| 344 | <h3><a class="toc-backref" href="#id31" id="example-news-item" name="example-news-item">Example News Item</a></h3> |
340 | <h3><a class="toc-backref" href="#id33" id="example-news-item" name="example-news-item">Example News Item</a></h3> |
| 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 |
341 | <p><a class="reference" href="glep-0042-extras/example-news-item.txt">This hypothetical news item</a> <a class="footnote-reference" href="#id20" id="id21" name="id21">[18]</a> could be used for an upgrade to the |
| 346 | <tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p> |
342 | <tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p> |
| 347 | </div> |
343 | </div> |
| 348 | </div> |
344 | </div> |
| 349 | <div class="section"> |
345 | <div class="section"> |
| 350 | <h2><a class="toc-backref" href="#id32" id="news-item-quality-control" name="news-item-quality-control">News Item Quality Control</a></h2> |
346 | <h2><a class="toc-backref" href="#id34" id="news-item-quality-control" name="news-item-quality-control">News Item Quality Control</a></h2> |
| 351 | <p>There have been complaints regarding the comprehensibility of some upgrade |
347 | <p>There have been complaints regarding the comprehensibility of some upgrade |
| 352 | notices and news items in the past. This is understandable — not every Gentoo |
348 | notices and news items in the past. This is understandable — not every Gentoo |
| 353 | developer speaks English as a first language. However, for the sake of clarity, |
349 | developer speaks English as a first language. However, for the sake of clarity, |
| 354 | professionalism and avoiding making us look like prats, it is important that any |
350 | professionalism and avoiding making us look like prats, it is important that any |
| 355 | language problems be corrected before inflicting a news item upon end users.</p> |
351 | language problems be corrected before inflicting a news item upon end users.</p> |
| … | |
… | |
| 369 | Thus, the justification should be in the form "this message is important to |
365 | Thus, the justification should be in the form "this message is important to |
| 370 | YourSQL users because ...", not "YourSQL is important because ...".</p> |
366 | YourSQL users because ...", not "YourSQL is important because ...".</p> |
| 371 | </div> |
367 | </div> |
| 372 | </div> |
368 | </div> |
| 373 | <div class="section"> |
369 | <div class="section"> |
| 374 | <h2><a class="toc-backref" href="#id33" id="news-item-distribution" name="news-item-distribution">News Item Distribution</a></h2> |
370 | <h2><a class="toc-backref" href="#id35" id="news-item-distribution" name="news-item-distribution">News Item Distribution</a></h2> |
| 375 | <div class="section"> |
371 | <div class="section"> |
| 376 | <h3><a class="toc-backref" href="#id34" id="server-side" name="server-side">Server Side</a></h3> |
372 | <h3><a class="toc-backref" href="#id36" id="server-side" name="server-side">Server Side</a></h3> |
| 377 | <p>News items are to be made available via the standard rsync tree. This removes |
373 | <p>News items are to be made available via the standard rsync tree. This removes |
| 378 | any need for polling of a remote source.</p> |
374 | any need for polling of a remote source.</p> |
| 379 | <p>A new repository will be created for news items. The type (CVS or Subversion), |
375 | <p>A new repository will be created for news items. The type (CVS or Subversion), |
| 380 | location and access controls on this repository are beyond the scope of this |
376 | location and access controls on this repository are beyond the scope of this |
| 381 | GLEP.</p> |
377 | GLEP.</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 |
392 | <p>The main rsync tree will <strong>not</strong> use the <tt class="docutils literal"><span class="pre">yyyy/mm/</span></tt> subdirectory layout. The |
| 397 | news item directories will all be immediately under the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> |
393 | news item directories will all be immediately under the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> |
| 398 | directory.</p> |
394 | directory.</p> |
| 399 | </div> |
395 | </div> |
| 400 | <div class="section"> |
396 | <div class="section"> |
| 401 | <h3><a class="toc-backref" href="#id35" id="client-side" name="client-side">Client Side</a></h3> |
397 | <h3><a class="toc-backref" href="#id37" id="client-side" name="client-side">Client Side</a></h3> |
| 402 | <p>Whenever relevant unread news items are found, the package manager will create a |
398 | <p>Whenever relevant unread news items are found, the package manager will create a |
| 403 | file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-${repoid}.unread</span></tt> (if it does not |
399 | file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-${repoid}.unread</span></tt> (if it does not |
| 404 | already exist) and append the news item identifier (eg |
400 | already 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> |
401 | <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 |
402 | <p>All news item related files should be root owned and in the <tt class="docutils literal"><span class="pre">portage</span></tt> group |
| … | |
… | |
| 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 |
428 | <p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to |
| 433 | filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p> |
429 | filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p> |
| 434 | </div> |
430 | </div> |
| 435 | </div> |
431 | </div> |
| 436 | <div class="section"> |
432 | <div class="section"> |
| 437 | <h2><a class="toc-backref" href="#id36" id="news-item-clients" name="news-item-clients">News Item Clients</a></h2> |
433 | <h2><a class="toc-backref" href="#id38" id="news-item-clients" name="news-item-clients">News Item Clients</a></h2> |
| 438 | <p>Once a news item is marked for reading, third party tools (or traditional core |
434 | <p>Once a news item is marked for reading, third party tools (or traditional core |
| 439 | Unix tools) can be used to display and view the news files.</p> |
435 | Unix 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 |
436 | <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 |
437 | <tt class="docutils literal"><span class="pre">news-${repoid}.unread</span></tt> file. If a news client acts as an interactive reader |
| 442 | rather than a gateway, it should then add the name to a <tt class="docutils literal"><span class="pre">news-repoid.read</span></tt> |
438 | rather than a gateway, it should then add the name to a <tt class="docutils literal"><span class="pre">news-${repoid}.read</span></tt> |
| 443 | file in the same directory with the same file format.</p> |
439 | file in the same directory with the same file format.</p> |
| 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 |
440 | <p>An <tt class="docutils literal"><span class="pre">eselect</span></tt> <a class="footnote-reference" href="#eselect" id="id15" name="id15">[3]</a> module shall be created as the 'suggested' display |
| 445 | tool; other display tools (for example, a news to email forwarder, which would |
441 | tool; other display tools (for example, a news to email forwarder, which would |
| 446 | be ideal for users who sync on a <tt class="docutils literal"><span class="pre">cron</span></tt>) are left as options for those who |
442 | be ideal for users who sync on a <tt class="docutils literal"><span class="pre">cron</span></tt>) are left as options for those who |
| 447 | desire them.</p> |
443 | desire them.</p> |
| 448 | </div> |
444 | </div> |
| 449 | <div class="section"> |
445 | <div class="section"> |
| 450 | <h2><a class="toc-backref" href="#id37" id="news-item-removal" name="news-item-removal">News Item Removal</a></h2> |
446 | <h2><a class="toc-backref" href="#id39" id="news-item-removal" name="news-item-removal">News Item Removal</a></h2> |
| 451 | <p>News items can be removed (by removing the news file from the main tree) when |
447 | <p>News items can be removed (by removing the news file from the main tree) when |
| 452 | they are no longer relevant, if they are made obsolete by a future news item or |
448 | they are no longer relevant, if they are made obsolete by a future news item or |
| 453 | after a long period of time. This is the same as the method used for <tt class="docutils literal"><span class="pre">updates</span></tt> |
449 | after a long period of time. This is the same as the method used for <tt class="docutils literal"><span class="pre">updates</span></tt> |
| 454 | entries.</p> |
450 | entries.</p> |
| 455 | </div> |
451 | </div> |
| 456 | </div> |
452 | </div> |
| 457 | <div class="section"> |
453 | <div class="section"> |
| 458 | <h1><a class="toc-backref" href="#id38" id="integration-with-existing-systems" name="integration-with-existing-systems">Integration with Existing Systems</a></h1> |
454 | <h1><a class="toc-backref" href="#id40" id="integration-with-existing-systems" name="integration-with-existing-systems">Integration with Existing Systems</a></h1> |
| 459 | <p>It would be simple to convert these news items into the format used for news |
455 | <p>It would be simple to convert these news items into the format used for news |
| 460 | items on the Gentoo website or posts for the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list.</p> |
456 | items 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 |
457 | <p>There is an existing automated tool <a class="footnote-reference" href="#forums-glsa" id="id16" name="id16">[4]</a> for posting GLSAs to the |
| 462 | forums. A similar tool can be used for these news items.</p> |
458 | forums. A similar tool can be used for these news items.</p> |
| 463 | </div> |
459 | </div> |
| 464 | <div class="section"> |
460 | <div class="section"> |
| 465 | <h1><a class="toc-backref" href="#id39" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1> |
461 | <h1><a class="toc-backref" href="#id41" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1> |
| 466 | <p>Backwards compatibility is not a concern here. Existing tools will simply ignore |
462 | <p>Backwards compatibility is not a concern here. Existing tools will simply ignore |
| 467 | the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p> |
463 | the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p> |
| 468 | </div> |
464 | </div> |
| 469 | <div class="section"> |
465 | <div class="section"> |
| 470 | <h1><a class="toc-backref" href="#id40" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1> |
466 | <h1><a class="toc-backref" href="#id42" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1> |
| 471 | <div class="section"> |
467 | <p>A reference implementation of the required package manager support can be found |
| 472 | <h2><a class="toc-backref" href="#id41" id="portage-code" name="portage-code">Portage Code</a></h2> |
468 | in Paludis <a class="footnote-reference" href="#paludis" id="id17" name="id17">[15]</a>, along with a reference newsreader implemented as an |
| 473 | <p>TODO</p> |
469 | eselect module <a class="footnote-reference" href="#eselect-news" id="id18" name="id18">[16]</a>.</p> |
| 474 | </div> |
470 | </div> |
| 475 | <div class="section"> |
471 | <div class="section"> |
| 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> |
|
|
| 478 | </div> |
|
|
| 479 | <div class="section"> |
|
|
| 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> |
|
|
| 482 | </div> |
|
|
| 483 | </div> |
|
|
| 484 | <div class="section"> |
|
|
| 485 | <h1><a class="toc-backref" href="#id44" id="credits" name="credits">Credits</a></h1> |
472 | <h1><a class="toc-backref" href="#id43" id="credits" name="credits">Credits</a></h1> |
| 486 | <p>The idea behind notifying users of news updates via Portage comes from Stuart |
473 | <p>The idea behind notifying users of news updates via Portage comes from Stuart |
| 487 | Herbert <a class="footnote-reference" href="#stuart-blog" id="id17" name="id17">[15]</a>.</p> |
474 | Herbert <a class="footnote-reference" href="#stuart-blog" id="id19" name="id19">[17]</a>.</p> |
| 488 | <p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, |
475 | <p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, |
| 489 | Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec |
476 | Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec |
| 490 | Warner for input. Some of the ideas presented here are theirs, others go |
477 | Warner for input. Some of the ideas presented here are theirs, others go |
| 491 | completely against their suggestions.</p> |
478 | completely against their suggestions.</p> |
| 492 | </div> |
479 | </div> |
| 493 | <div class="section"> |
480 | <div class="section"> |
| 494 | <h1><a class="toc-backref" href="#id45" id="example-files" name="example-files">Example Files</a></h1> |
481 | <h1><a class="toc-backref" href="#id44" id="example-files" name="example-files">Example Files</a></h1> |
| 495 | <p>TODO Removed until the exact format details are figured out.</p> |
482 | <dl class="docutils"> |
|
|
483 | <dt><a class="reference" href="glep-0042-extras/example-news-item.txt">example-news-item.txt</a></dt> |
|
|
484 | <dd>An example news item.</dd> |
|
|
485 | </dl> |
| 496 | </div> |
486 | </div> |
| 497 | <div class="section"> |
487 | <div class="section"> |
| 498 | <h1><a class="toc-backref" href="#id46" id="references" name="references">References</a></h1> |
488 | <h1><a class="toc-backref" href="#id45" id="references" name="references">References</a></h1> |
| 499 | <table class="docutils footnote" frame="void" id="bug-11359" rules="none"> |
489 | <table class="docutils footnote" frame="void" id="bug-11359" rules="none"> |
| 500 | <colgroup><col class="label" /><col /></colgroup> |
490 | <colgroup><col class="label" /><col /></colgroup> |
| 501 | <tbody valign="top"> |
491 | <tbody valign="top"> |
| 502 | <tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359 |
492 | <tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359 |
| 503 | "[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging", |
493 | "[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging", |
| … | |
… | |
| 596 | <tbody valign="top"> |
586 | <tbody valign="top"> |
| 597 | <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>: "UTF-8, a transformation format of ISO 10646" |
587 | <tr><td class="label"><a class="fn-backref" href="#id7" name="rfc-3629">[14]</a></td><td><a class="reference" href="http://www.faqs.org/rfcs/rfc3629.html">RFC 3629</a>: "UTF-8, a transformation format of ISO 10646" |
| 598 | <a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr> |
588 | <a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr> |
| 599 | </tbody> |
589 | </tbody> |
| 600 | </table> |
590 | </table> |
|
|
591 | <table class="docutils footnote" frame="void" id="paludis" rules="none"> |
|
|
592 | <colgroup><col class="label" /><col /></colgroup> |
|
|
593 | <tbody valign="top"> |
|
|
594 | <tr><td class="label"><a class="fn-backref" href="#id17" name="paludis">[15]</a></td><td>Paludis homepage, <a class="reference" href="http://paludis.berlios.de">http://paludis.berlios.de</a></td></tr> |
|
|
595 | </tbody> |
|
|
596 | </table> |
|
|
597 | <table class="docutils footnote" frame="void" id="eselect-news" rules="none"> |
|
|
598 | <colgroup><col class="label" /><col /></colgroup> |
|
|
599 | <tbody valign="top"> |
|
|
600 | <tr><td class="label"><a class="fn-backref" href="#id18" name="eselect-news">[16]</a></td><td>news.eselect, <a class="reference" href="http://svn.berlios.de/svnroot/repos/paludis/trunk/eselect/news.eselect">http://svn.berlios.de/svnroot/repos/paludis/trunk/eselect/news.eselect</a></td></tr> |
|
|
601 | </tbody> |
|
|
602 | </table> |
| 601 | <table class="docutils footnote" frame="void" id="stuart-blog" rules="none"> |
603 | <table class="docutils footnote" frame="void" id="stuart-blog" rules="none"> |
| 602 | <colgroup><col class="label" /><col /></colgroup> |
604 | <colgroup><col class="label" /><col /></colgroup> |
| 603 | <tbody valign="top"> |
605 | <tbody valign="top"> |
| 604 | <tr><td class="label"><a class="fn-backref" href="#id17" name="stuart-blog">[15]</a></td><td>"Favouring an automatic news mechanism", Stuart Herbert, |
606 | <tr><td class="label"><a class="fn-backref" href="#id19" name="stuart-blog">[17]</a></td><td>"Favouring an automatic news mechanism", Stuart Herbert, |
| 605 | <a class="reference" href="http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism">http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism</a></td></tr> |
607 | <a class="reference" href="http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism">http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism</a></td></tr> |
| 606 | </tbody> |
608 | </tbody> |
| 607 | </table> |
609 | </table> |
| 608 | <table class="docutils footnote" frame="void" id="id18" rules="none"> |
610 | <table class="docutils footnote" frame="void" id="id20" rules="none"> |
| 609 | <colgroup><col class="label" /><col /></colgroup> |
611 | <colgroup><col class="label" /><col /></colgroup> |
| 610 | <tbody valign="top"> |
612 | <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> |
613 | <tr><td class="label"><a class="fn-backref" href="#id21" name="id20">[18]</a></td><td><a class="reference" href="glep-0042-extras/example-news-item.txt">glep-0042-extras/example-news-item.txt</a></td></tr> |
| 612 | </tbody> |
614 | </tbody> |
| 613 | </table> |
615 | </table> |
| 614 | </div> |
616 | </div> |
| 615 | <div class="section"> |
617 | <div class="section"> |
| 616 | <h1><a class="toc-backref" href="#id47" id="copyright" name="copyright">Copyright</a></h1> |
618 | <h1><a class="toc-backref" href="#id46" id="copyright" name="copyright">Copyright</a></h1> |
| 617 | <p>This document has been placed in the public domain.</p> |
619 | <p>This document has been placed in the public domain.</p> |
| 618 | <!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : --> |
620 | <!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : --> |
| 619 | </div> |
621 | </div> |
| 620 | |
622 | |
| 621 | </div> |
623 | </div> |
| 622 | <div class="footer"> |
624 | <div class="footer"> |
| 623 | <hr class="footer" /> |
625 | <hr class="footer" /> |
| 624 | <a class="reference" href="glep-0042.txt">View document source</a>. |
626 | <a class="reference" href="glep-0042.txt">View document source</a>. |
| 625 | Generated on: 2006-02-13 16:26 UTC. |
627 | Generated on: 2007-10-13 13:39 UTC. |
| 626 | Generated 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. |
628 | Generated 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 | |
629 | |
| 628 | </div> |
630 | </div> |
| 629 | </body> |
631 | </body> |
| 630 | </html> |
632 | </html> |