Contents of /xml/htdocs/proj/en/glep/glep-0042.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.5 - (show annotations) (download) (as text)
Tue Dec 13 03:21:59 2005 UTC (13 years, 1 month ago) by ciaranm
Branch: MAIN
Changes since 1.4: +20 -14 lines
File MIME type: text/html
New glep 42 draft

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">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
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
8 -->
9 <head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.3.9: http://docutils.sourceforge.net/" />
12 <title>GLEP 42 -- Critical News Reporting</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14 </head>
15 <body bgcolor="white">
16 <table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0">
18 <tr><td class="navicon" width="150" height="35">
19 <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20 <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td>
22 <td class="textlinks" align="left">
23 [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
24 [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
25 [<b><a href="./glep-0042.txt">GLEP Source</a></b>]
26 </td></tr></table>
27 <table class="rfc2822 docutils field-list" frame="void" rules="none">
28 <col class="field-name" />
29 <col class="field-body" />
30 <tbody valign="top">
31 <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td>
32 </tr>
33 <tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td>
34 </tr>
35 <tr class="field"><th class="field-name">Version:</th><td class="field-body">$Revision: $</td>
36 </tr>
37 <tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh &lt;ciaranm&#32;&#97;t&#32;gentoo.org&gt;</td>
38 </tr>
39 <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0042.txt?cvsroot=gentoo">$Date: $</a></td>
40 </tr>
41 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
42 </tr>
43 <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td>
44 </tr>
45 <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="http://www.python.org/peps/glep-0012.html">text/x-rst</a></td>
46 </tr>
47 <tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td>
48 </tr>
49 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005</td>
50 </tr>
51 </tbody>
52 </table>
53 <hr />
54 <div class="contents topic" id="contents">
55 <p class="topic-title first"><a name="contents">Contents</a></p>
56 <ul class="simple">
57 <li><a class="reference" href="#abstract" id="id20" name="id20">Abstract</a></li>
58 <li><a class="reference" href="#motivation" id="id21" name="id21">Motivation</a></li>
59 <li><a class="reference" href="#requirements" id="id22" name="id22">Requirements</a></li>
60 <li><a class="reference" href="#specification" id="id23" name="id23">Specification</a><ul>
61 <li><a class="reference" href="#overview" id="id24" name="id24">Overview</a></li>
62 <li><a class="reference" href="#news-item-identities" id="id25" name="id25">News Item Identities</a></li>
63 <li><a class="reference" href="#news-item-directories" id="id26" name="id26">News Item Directories</a></li>
64 <li><a class="reference" href="#news-item-files" id="id27" name="id27">News Item Files</a><ul>
65 <li><a class="reference" href="#news-item-headers" id="id28" name="id28">News Item Headers</a></li>
66 <li><a class="reference" href="#news-item-body" id="id29" name="id29">News Item Body</a></li>
67 <li><a class="reference" href="#example-news-item" id="id30" name="id30">Example News Item</a></li>
68 </ul>
69 </li>
70 <li><a class="reference" href="#news-item-quality-control" id="id31" name="id31">News Item Quality Control</a></li>
71 <li><a class="reference" href="#news-item-distribution" id="id32" name="id32">News Item Distribution</a><ul>
72 <li><a class="reference" href="#server-side" id="id33" name="id33">Server Side</a></li>
73 <li><a class="reference" href="#client-side" id="id34" name="id34">Client Side</a></li>
74 </ul>
75 </li>
76 <li><a class="reference" href="#news-item-clients" id="id35" name="id35">News Item Clients</a></li>
77 <li><a class="reference" href="#news-item-removal" id="id36" name="id36">News Item Removal</a></li>
78 </ul>
79 </li>
80 <li><a class="reference" href="#integration-with-existing-systems" id="id37" name="id37">Integration with Existing Systems</a></li>
81 <li><a class="reference" href="#backwards-compatibility" id="id38" name="id38">Backwards Compatibility</a></li>
82 <li><a class="reference" href="#reference-implementation" id="id39" name="id39">Reference Implementation</a><ul>
83 <li><a class="reference" href="#portage-code" id="id40" name="id40">Portage Code</a></li>
84 <li><a class="reference" href="#simple-eselect-news-client" id="id41" name="id41">Simple <tt class="docutils literal"><span class="pre">eselect</span></tt> News Client</a></li>
85 <li><a class="reference" href="#simple-news-to-mail-forwarder" id="id42" name="id42">Simple News to Mail Forwarder</a></li>
86 </ul>
87 </li>
88 <li><a class="reference" href="#credits" id="id43" name="id43">Credits</a></li>
89 <li><a class="reference" href="#example-files" id="id44" name="id44">Example Files</a></li>
90 <li><a class="reference" href="#references" id="id45" name="id45">References</a></li>
91 <li><a class="reference" href="#copyright" id="id46" name="id46">Copyright</a></li>
92 </ul>
93 </div>
94 <div class="section" id="abstract">
95 <h1><a class="toc-backref" href="#id20" name="abstract">Abstract</a></h1>
96 <p>This GLEP proposes a new way of informing users about important updates and news
97 regarding tree-related items.</p>
98 </div>
99 <div class="section" id="motivation">
100 <h1><a class="toc-backref" href="#id21" name="motivation">Motivation</a></h1>
101 <p>Although most package updates are clean and require little user action,
102 occasionally an upgrade requires user intervention during the upgrade process.
103 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>
104 and the <tt class="docutils literal"><span class="pre">mysql-4.1</span></tt> database format changes.</p>
105 <p>There are currently several ways of delivering important news items to our
106 users, none of them particularly effective:</p>
107 <ul class="simple">
108 <li>Gentoo Weekly News</li>
109 <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>
110 <li>The Gentoo Forums</li>
111 <li>The main Gentoo website</li>
112 <li>RSS feeds of Gentoo news</li>
113 <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>
114 </ul>
115 <p>A more reliable way of getting news of critical updates out to users is required
116 to avoid repeats of the various recent upgrade debacles. This GLEP proposes a
117 solution based around pushing news items out to the user via the <tt class="docutils literal"><span class="pre">rsync</span></tt> tree.</p>
118 <div class="important">
119 <p class="first admonition-title">Important</p>
120 <p class="last">This GLEP does not seek to replace or modify <tt class="docutils literal"><span class="pre">einfo</span></tt> messages
121 which are displayed post-install. That is a separate issue which is handled
122 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>
123 </div>
124 </div>
125 <div class="section" id="requirements">
126 <h1><a class="toc-backref" href="#id22" name="requirements">Requirements</a></h1>
127 <p>An adequate solution must meet all of the following requirements:</p>
128 <dl class="docutils">
129 <dt>Preemptive</dt>
130 <dd>Users should be told of changes <em>before</em> they break a system, not after the
131 damage has already been done. Ideally, the system administrator would be
132 given ample warning to plan difficult upgrades and changes, rather than only
133 being told just before action is necessary.</dd>
134 <dt>No user subscription required</dt>
135 <dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id2" name="id2">[5]</a> that many users do not
136 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
137 requires subscription has no advantage over current methods.</dd>
138 <dt>No user monitoring required</dt>
139 <dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id3" name="id3">[5]</a> that many users do not
140 read news items posted to the Gentoo website, or do not read news items
141 until it is too late. A solution that relies upon active monitoring of a
142 particular source has no advantage over current methods.</dd>
143 <dt>Relevant</dt>
144 <dd>System administrators who do not use a particular package should not have to
145 read news items which affect purely that package. Some news items may be of
146 relevance to most or all users, but those that are not should not be forced
147 upon users unnecessarily.</dd>
148 <dt>Lightweight</dt>
149 <dd>It is not reasonable to expect all users to have an MTA, web browser, email
150 client, cron daemon or text processing suite available on their system.
151 Users must not be forced to install unreasonable extra software to be able
152 to read news items.</dd>
153 <dt>No privacy violations</dt>
154 <dd>Users of the solution should not be required to provide information about
155 their systems (for example, IP addresses or installed packages).</dd>
156 <dt>Multiple delivery method support</dt>
157 <dd>Some users may wish to view news items via email, some via a terminal and
158 some via a web browser. A solution should either support all of these
159 methods or (better still) make it simple to write clients for displaying
160 news items in different ways.</dd>
161 </dl>
162 <p>The following characteristics would be desirable:</p>
163 <dl class="docutils">
164 <dt>Internationalisable</dt>
165 <dd>Being able to provide messages in multiple languages may be beneficial.</dd>
166 <dt>Quality control</dt>
167 <dd>There should be some way to ensure that badly written or irrelevant messages
168 are not sent out, for example by inexperienced developers or those whose
169 English language skills are below par.</dd>
170 <dt>Simple for developers</dt>
171 <dd>Posting news items should be as simple as is reasonably possible.</dd>
172 <dt>Simple for users</dt>
173 <dd>Reading relevant news items should be as simple as is reasonably possible.</dd>
174 <dt>Compatibility with existing and future news sources</dt>
175 <dd>A news system would ideally be able to be integrated with existing news
176 sources (for example, Forums, GWN, the main Gentoo website) without
177 excessive difficulty. Similarly, easy interoperation with any future news
178 sources should not be precluded.</dd>
179 </dl>
180 </div>
181 <div class="section" id="specification">
182 <h1><a class="toc-backref" href="#id23" name="specification">Specification</a></h1>
183 <div class="section" id="overview">
184 <h2><a class="toc-backref" href="#id24" name="overview">Overview</a></h2>
185 <p>News items are published and delivered to users as follows:</p>
186 <ol class="arabic simple">
187 <li>A news item is written. The format to be used is described below.</li>
188 <li>The news item is reviewed, following the process described in
189 <a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li>
190 <li>The news item is committed to a CVS (or Subversion <a class="footnote-reference" href="#glep-36" id="id4" name="id4">[10]</a>) repository.
191 From here, it is merged with the rsync tree. This is described in <a class="reference" href="#news-item-distribution">News Item
192 Distribution</a>.</li>
193 <li>Users fetch the news item when they sync. This ensures that the news items in
194 question are pushed to the user before the user accidentally makes an
195 unwanted change. No changes to the existing rsync process are required by
196 this GLEP.</li>
197 <li>The package manager filters the news item and, if it is relevant, marks the
198 news item for reading. The package manager should also display a notice
199 informing the user that there are unread news items.</li>
200 <li>The news item is handled by the user's choice of news item reader. See <a class="reference" href="#news-item-clients">News
201 Item Clients</a>.</li>
202 </ol>
203 </div>
204 <div class="section" id="news-item-identities">
205 <h2><a class="toc-backref" href="#id25" name="news-item-identities">News Item Identities</a></h2>
206 <p>Each news item will have a unique identifier. This identifier will be in the
207 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>),
208 <tt class="docutils literal"><span class="pre">mm</span></tt> is the month (<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">12</span></tt>) and dd is the day of the month
209 (<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">31</span></tt>). The <tt class="docutils literal"><span class="pre">short-name</span></tt> is a very short name describing the
210 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>,
211 <tt class="docutils literal"><span class="pre">0-9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">:</span></tt> (colon) and <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen).</p>
212 </div>
213 <div class="section" id="news-item-directories">
214 <h2><a class="toc-backref" href="#id26" name="news-item-directories">News Item Directories</a></h2>
215 <p>Each news item will be represented by a directory whose name is the same as the
216 news item's identifier.</p>
217 <p>The directory will contain a file named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.en.txt</span></tt>, which
218 contains the text of the news item, in English, in the format described below.</p>
219 <p>If a news item is translated, other files named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.xx.txt</span></tt>
220 (where <tt class="docutils literal"><span class="pre">xx</span></tt> is the ISO 639 <a class="footnote-reference" href="#iso-639" id="id5" name="id5">[11]</a> two letter country code) will also be
221 provided. However, only the English version of a news item is authoritative.
222 This anglocentricity is justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[9]</a>.</p>
223 </div>
224 <div class="section" id="news-item-files">
225 <h2><a class="toc-backref" href="#id27" name="news-item-files">News Item Files</a></h2>
226 <p>A news item file is a text file, encoded using UTF-8 <a class="footnote-reference" href="#rfc-3629" id="id7" name="id7">[14]</a> for
227 compatibility with and for the same reasons as existing Gentoo documentation
228 <a class="footnote-reference" href="#docs-policy" id="id8" name="id8">[2]</a> and the tree <a class="footnote-reference" href="#glep-31" id="id9" name="id9">[8]</a>.</p>
229 <p>News items should be signed with a detached GPG signature:</p>
230 <pre class="literal-block">
231 gpg --armour --detach-sign ????-??-??-*.??.txt
232 </pre>
233 <p>A news item file's content will consist of an <a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> style header <a class="footnote-reference" href="#rfc-822" id="id10" name="id10">[13]</a>
234 followed by the main body of the message as plain text. This GLEP defines
235 various optional and mandatory headers. Future GLEPs may propose new headers —
236 tools handling these news items must ignore any unrecognised header.</p>
237 <div class="section" id="news-item-headers">
238 <h3><a class="toc-backref" href="#id28" name="news-item-headers">News Item Headers</a></h3>
239 <p>The following headers describe the purpose and format of the news item:</p>
240 <dl class="docutils">
241 <dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt>
242 <dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd>
243 <dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt>
244 <dd>Author's name and email address, in the form <tt class="docutils literal"><span class="pre">Real</span> <span class="pre">Name</span> <span class="pre">&lt;email&#64;address&gt;</span></tt>.
245 Mandatory; multiple author headers may be specified if appropriate.</dd>
246 <dt><tt class="docutils literal"><span class="pre">Translator:</span></tt></dt>
247 <dd>For translated news items, the translator's name and email address. Multiple
248 translator headers may be specified if appropriate.</dd>
249 <dt><tt class="docutils literal"><span class="pre">Content-Type:</span></tt></dt>
250 <dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd>
251 <dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt>
252 <dd>Date of posting, in <tt class="docutils literal"><span class="pre">dd-mmm-yyyy</span></tt> format (e.g. 14-Aug-2001) for
253 compatibility with GLEP 1 <a class="footnote-reference" href="#glep-1" id="id11" name="id11">[6]</a>. UTC time in <tt class="docutils literal"><span class="pre">hh-mm-ss</span> <span class="pre">+0000</span></tt> format
254 may also be included. Mandatory.</dd>
255 <dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt>
256 <dd>Initially 1. Incremented every time a non-trivial change is made. Changes
257 which require a re-read of the news item should instead use a new news item
258 file. Mandatory.</dd>
259 <dt><tt class="docutils literal"><span class="pre">News-Item-Format:</span></tt></dt>
260 <dd>Must be <tt class="docutils literal"><span class="pre">1.0</span></tt>. Future revisions to the format may increment the minor
261 number for backwards-compatible changes, or the major number for major
262 changes.</dd>
263 </dl>
264 <p>The following headers are used for filtering:</p>
265 <dl class="docutils">
266 <dt><tt class="docutils literal"><span class="pre">Display-If-Installed:</span></tt></dt>
267 <dd>A dependency atom or simple package name (for example,
268 <tt class="docutils literal"><span class="pre">&lt;dev-lang/php-5_alpha</span></tt> or <tt class="docutils literal"><span class="pre">net-www/apache</span></tt>). If the user has the
269 package specified installed, the news item should be displayed.</dd>
270 <dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt>
271 <dd>A keyword <a class="footnote-reference" href="#glep-22" id="id12" name="id12">[7]</a> name, for example <tt class="docutils literal"><span class="pre">mips</span></tt> or <tt class="docutils literal"><span class="pre">x86-fbsd</span></tt>. If the
272 user is on the keyword in question, the news item should be displayed.</dd>
273 <dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt>
274 <dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. Standard
275 shell GLOB wildcards may be used. If the user is using the exact profile in
276 question, the news item should be displayed. This header may be used to
277 replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the future.</dd>
278 </dl>
279 <div class="note">
280 <p class="first admonition-title">Note</p>
281 <p class="last">When performing package moves, developers must also update any
282 relevant <tt class="docutils literal"><span class="pre">Display-If-Installed</span></tt> headers in news files.</p>
283 </div>
284 <p>The algorithm used to determine whether a news item is 'relevant' is as
285 follows:</p>
286 <ul class="simple">
287 <li>For each <tt class="docutils literal"><span class="pre">Display-If-</span></tt> header type which occurs at least once:<ul>
288 <li>The news item is not relevant if none of the headers of this type are
289 successfully matched.</li>
290 </ul>
291 </li>
292 <li>Otherwise the news item is relevant.</li>
293 </ul>
294 <p>In particular, if no <tt class="docutils literal"><span class="pre">Display-If-</span></tt> header is specified, a news item will be
295 relevant for all users.</p>
296 <p>This algorithm was chosen because it makes conditions like &quot;display this news
297 item for <tt class="docutils literal"><span class="pre">YourSQL</span></tt> users who are on <tt class="docutils literal"><span class="pre">sparc</span></tt> or <tt class="docutils literal"><span class="pre">x86-obsd</span></tt> relatively
298 simple to specify — it is believed that these kinds of condition are far more
299 likely to occur than &quot;display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or
300 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>&quot; or &quot;display these news items for
301 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>&quot;.</p>
302 </div>
303 <div class="section" id="news-item-body">
304 <h3><a class="toc-backref" href="#id29" name="news-item-body">News Item Body</a></h3>
305 <p>The header section must be followed by a blank line, then the main body of the
306 text.</p>
307 <p>The text body should be wrapped at 72 characters. No fancy formatting or tab
308 characters should be used — the news item may be being displayed directly to a
309 terminal. Paragraphs should be separated by a blank line.</p>
310 <p>Hyperlinks may be used to refer to further information (for example, an upgrade
311 guide). However, the main body of the news item should be descriptive and not
312 simply a &quot;read this link&quot; text. It is assumed that the user will have access to
313 a web browser <em>somewhere</em>, but not necessarily on the box which is being
314 administrated — this will be the case on may servers and routers, for example.</p>
315 </div>
316 <div class="section" id="example-news-item">
317 <h3><a class="toc-backref" href="#id30" name="example-news-item">Example News Item</a></h3>
318 <p><a class="reference" href="glep-0042-extras/example-news-item.txt">This hypothetical news item</a> <a class="footnote-reference" href="#id18" id="id19" name="id19">[16]</a> could be used for an upgrade to the
319 <tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p>
320 </div>
321 </div>
322 <div class="section" id="news-item-quality-control">
323 <h2><a class="toc-backref" href="#id31" name="news-item-quality-control">News Item Quality Control</a></h2>
324 <p>There have been complaints regarding the comprehensibility of some upgrade
325 notices and news items in the past. This is understandable — not every Gentoo
326 developer speaks English as a first language. However, for the sake of clarity,
327 professionalism and avoiding making us look like prats, it is important that any
328 language problems be corrected before inflicting a news item upon end users.</p>
329 <p>Thus, at least 72 hours before a proposed news item is committed, it must be
330 posted to the <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt> mailing list and <tt class="docutils literal"><span class="pre">Cc:</span></tt>ed to <tt class="docutils literal"><span class="pre">pr&#64;gentoo.org</span></tt>
331 (exceptions may be made in exceptional circumstances). Any complaints — for
332 example regarding wording, clarity or accuracy — <strong>must</strong> be addressed before
333 the news item goes live.</p>
334 <div class="note">
335 <p class="first admonition-title">Note</p>
336 <p class="last">A previous draft of this GLEP allowed news items to be sent to
337 <tt class="docutils literal"><span class="pre">gentoo-core</span></tt> instead of <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt>. It is possible that a situation
338 may arise where this will be necessary (for example, a security update which
339 must break backwards compatibility and which cannot be revealed to the public
340 before a given date).</p>
341 </div>
342 <p>News items must only be for <strong>important</strong> changes that may cause serious upgrade
343 or compatibility problems. Ordinary upgrade messages and non-critical news items
344 should remain in <tt class="docutils literal"><span class="pre">einfo</span></tt> notices. The importance of the message to its
345 intended audience should be justified with the proposal.</p>
346 <div class="important">
347 <p class="first admonition-title">Important</p>
348 <p class="last">The filtering system means that it is appropriate to send out
349 news items which are aimed at users of an uncommon package or architecture.
350 Thus, the justification should be in the form &quot;this message is important to
351 YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p>
352 </div>
353 </div>
354 <div class="section" id="news-item-distribution">
355 <h2><a class="toc-backref" href="#id32" name="news-item-distribution">News Item Distribution</a></h2>
356 <div class="section" id="server-side">
357 <h3><a class="toc-backref" href="#id33" name="server-side">Server Side</a></h3>
358 <p>News items are to be made available via the standard rsync tree. This removes
359 any need for polling of a remote source.</p>
360 <p>A new repository will be created for news items. The type (CVS or Subversion),
361 location and access controls on this repository are beyond the scope of this
362 GLEP.</p>
363 <div class="note">
364 <p class="first admonition-title">Note</p>
365 <p class="last">A previous draft of this GLEP instead used the main <tt class="docutils literal"><span class="pre">gentoo-x86</span></tt>
366 tree. This was changed following advice from Infrastructure
367 <a class="footnote-reference" href="#ramereth-repo" id="id14" name="id14">[12]</a>. Both solutions have the same end result.</p>
368 </div>
369 <p>This repository will contain directories named <tt class="docutils literal"><span class="pre">yyyy/mm/</span></tt>, where <tt class="docutils literal"><span class="pre">yyyy</span></tt> is
370 the current year and <tt class="docutils literal"><span class="pre">mm</span></tt> is the current month number (01 for January through
371 12 for December). This separation will help keep news items more manageable.</p>
372 <p>The contents of this repository will automatically be merged with the main rsync
373 tree, placing the items in a <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory. The method used for
374 merging these items is beyond the scope of this GLEP — a similar setup is
375 already used for merging GLSAs into the rsync tree.</p>
376 <p>The main rsync tree will <strong>not</strong> use the <tt class="docutils literal"><span class="pre">yyyy/mm/</span></tt> subdirectory layout.</p>
377 </div>
378 <div class="section" id="client-side">
379 <h3><a class="toc-backref" href="#id34" name="client-side">Client Side</a></h3>
380 <p>Whenever relevant unread news items are found, the package manager will create a
381 file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-magic-chicken.unread</span></tt> (if it does not
382 already exist) and append the news item identifier (eg
383 <tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p>
384 <div class="note">
385 <p class="first admonition-title">Note</p>
386 <p class="last">Future changes to Portage involving support for multiple repositories
387 may introduce repository names. In this case, the <tt class="docutils literal"><span class="pre">magic-chicken</span></tt> part of the
388 filename should be replaced by a string representation of the repository
389 name. Thus, news item clients should use a wildcard rather than hardcoding
390 the <tt class="docutils literal"><span class="pre">magic-chicken</span></tt> string.</p>
391 </div>
392 <p>Notification that new relevant news items will be displayed via the
393 <tt class="docutils literal"><span class="pre">emerge</span></tt> tool in a similar way to the existing &quot;configuration files need
394 updating&quot; messages:</p>
395 <pre class="literal-block">
396 * Important: there are 5 unread news items.
397 * Type emerge --help news to learn how to read news files.
398 </pre>
399 <p>Checks for new news messages should be displayed:</p>
400 <ul class="simple">
401 <li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">sync</span></tt></li>
402 <li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">--pretend</span></tt></li>
403 <li>Before an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">&lt;target&gt;</span></tt> (which may also include a red warning message)</li>
404 <li>Before an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">--ask</span> <span class="pre">&lt;target&gt;</span></tt> sequence</li>
405 </ul>
406 <p>The package manager may use a timestamp check file to avoid having to process
407 news items unnecessarily.</p>
408 <p>The package manager must keep track of news items that have already been added
409 to the unread list to avoid repeatedly marking a deleted news item. This could
410 be handled via a <tt class="docutils literal"><span class="pre">news-magic-chicken.skip</span></tt> file, but implementation is not
411 specified by this GLEP.</p>
412 <p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to
413 filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p>
414 </div>
415 </div>
416 <div class="section" id="news-item-clients">
417 <h2><a class="toc-backref" href="#id35" name="news-item-clients">News Item Clients</a></h2>
418 <p>Once a news item is marked for reading, third party tools (or traditional core
419 Unix tools) can be used to display and view the news files.</p>
420 <p>When a news item is read, its name should be removed from the
421 <tt class="docutils literal"><span class="pre">news-magic-chicken.unread</span></tt> file. If a news client acts as an interactive
422 reader rather than a gateway, it should then add the name to a
423 <tt class="docutils literal"><span class="pre">news-magic-chicken.read</span></tt> file in the same directory with the same file
424 format (again, <tt class="docutils literal"><span class="pre">magic-chicken</span></tt> should be a wildcard rather than hardcoded).</p>
425 <p>An <tt class="docutils literal"><span class="pre">eselect</span></tt> <a class="footnote-reference" href="#eselect" id="id15" name="id15">[3]</a> module shall be created as the 'suggested' display
426 tool; other display tools (for example, a news to email forwarder, which would
427 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
428 desire them.</p>
429 </div>
430 <div class="section" id="news-item-removal">
431 <h2><a class="toc-backref" href="#id36" name="news-item-removal">News Item Removal</a></h2>
432 <p>News items can be removed (by removing the news file from the main tree) when
433 they are no longer relevant, if they are made obsolete by a future news item or
434 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>
435 entries.</p>
436 </div>
437 </div>
438 <div class="section" id="integration-with-existing-systems">
439 <h1><a class="toc-backref" href="#id37" name="integration-with-existing-systems">Integration with Existing Systems</a></h1>
440 <p>It would be simple to convert these news items into the format used for news
441 items on the Gentoo website or posts for the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list.</p>
442 <p>There is an existing automated tool <a class="footnote-reference" href="#forums-glsa" id="id16" name="id16">[4]</a> for posting GLSAs to the
443 forums. A similar tool can be used for these news items.</p>
444 </div>
445 <div class="section" id="backwards-compatibility">
446 <h1><a class="toc-backref" href="#id38" name="backwards-compatibility">Backwards Compatibility</a></h1>
447 <p>Backwards compatibility is not a concern here. Existing tools will simply ignore
448 the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p>
449 </div>
450 <div class="section" id="reference-implementation">
451 <h1><a class="toc-backref" href="#id39" name="reference-implementation">Reference Implementation</a></h1>
452 <div class="section" id="portage-code">
453 <h2><a class="toc-backref" href="#id40" name="portage-code">Portage Code</a></h2>
454 <p>TODO</p>
455 </div>
456 <div class="section" id="simple-eselect-news-client">
457 <h2><a class="toc-backref" href="#id41" name="simple-eselect-news-client">Simple <tt class="docutils literal docutils literal"><span class="pre">eselect</span></tt> News Client</a></h2>
458 <p>TODO Removed until the exact format details are figured out.</p>
459 </div>
460 <div class="section" id="simple-news-to-mail-forwarder">
461 <h2><a class="toc-backref" href="#id42" name="simple-news-to-mail-forwarder">Simple News to Mail Forwarder</a></h2>
462 <p>TODO Removed until the exact format details are figured out.</p>
463 </div>
464 </div>
465 <div class="section" id="credits">
466 <h1><a class="toc-backref" href="#id43" name="credits">Credits</a></h1>
467 <p>The idea behind notifying users of news updates via Portage comes from Stuart
468 Herbert <a class="footnote-reference" href="#stuart-blog" id="id17" name="id17">[15]</a>.</p>
469 <p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear,
470 Brian Harring, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec Warner for
471 input. Some of the ideas presented here are theirs, others go completely
472 against their suggestions.</p>
473 </div>
474 <div class="section" id="example-files">
475 <h1><a class="toc-backref" href="#id44" name="example-files">Example Files</a></h1>
476 <p>TODO Removed until the exact format details are figured out.</p>
477 </div>
478 <div class="section" id="references">
479 <h1><a class="toc-backref" href="#id45" name="references">References</a></h1>
480 <table class="docutils footnote" frame="void" id="bug-11359" rules="none">
481 <colgroup><col class="label" /><col /></colgroup>
482 <tbody valign="top">
483 <tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359
484 &quot;[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging&quot;,
485 <a class="reference" href="https://bugs.gentoo.org/show_bug.cgi?id=11359">https://bugs.gentoo.org/show_bug.cgi?id=11359</a></td></tr>
486 </tbody>
487 </table>
488 <table class="docutils footnote" frame="void" id="docs-policy" rules="none">
489 <colgroup><col class="label" /><col /></colgroup>
490 <tbody valign="top">
491 <tr><td class="label"><a class="fn-backref" href="#id8" name="docs-policy">[2]</a></td><td>Gentoo XML Guide, Daniel Robbins et al.,
492 <a class="reference" href="http://www.gentoo.org/doc/en/xml-guide.xml">http://www.gentoo.org/doc/en/xml-guide.xml</a></td></tr>
493 </tbody>
494 </table>
495 <table class="docutils footnote" frame="void" id="eselect" rules="none">
496 <colgroup><col class="label" /><col /></colgroup>
497 <tbody valign="top">
498 <tr><td class="label"><a class="fn-backref" href="#id15" name="eselect">[3]</a></td><td>eselect modular framework for configuration and
499 administration utilities,
500 <a class="reference" href="http://www.gentoo.org/proj/en/eselect/index.xml">http://www.gentoo.org/proj/en/eselect/index.xml</a></td></tr>
501 </tbody>
502 </table>
503 <table class="docutils footnote" frame="void" id="forums-glsa" rules="none">
504 <colgroup><col class="label" /><col /></colgroup>
505 <tbody valign="top">
506 <tr><td class="label"><a class="fn-backref" href="#id16" name="forums-glsa">[4]</a></td><td>Forums user GLSA,
507 <a class="reference" href="http://forums.gentoo.org/profile.php?mode=viewprofile&amp;u=55648">http://forums.gentoo.org/profile.php?mode=viewprofile&amp;u=55648</a></td></tr>
508 </tbody>
509 </table>
510 <table class="docutils footnote" frame="void" id="forums-apache2" rules="none">
511 <colgroup><col class="label" /><col /></colgroup>
512 <tbody valign="top">
513 <tr><td class="label"><a name="forums-apache2">[5]</a></td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id3">2</a>)</em> Forums thread &quot;Gentoo Apache2 Config Change Idiocy&quot;,
514 <a class="reference" href="http://forums.gentoo.org/viewtopic-t-384368.html">http://forums.gentoo.org/viewtopic-t-384368.html</a></td></tr>
515 </tbody>
516 </table>
517 <table class="docutils footnote" frame="void" id="glep-1" rules="none">
518 <colgroup><col class="label" /><col /></colgroup>
519 <tbody valign="top">
520 <tr><td class="label"><a class="fn-backref" href="#id11" name="glep-1">[6]</a></td><td>GLEP 1: &quot;GLEP Purpose and Guidelines&quot;, Grant Goodyear,
521 <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0001.html">http://www.gentoo.org/proj/en/glep/glep-0001.html</a></td></tr>
522 </tbody>
523 </table>
524 <table class="docutils footnote" frame="void" id="glep-22" rules="none">
525 <colgroup><col class="label" /><col /></colgroup>
526 <tbody valign="top">
527 <tr><td class="label"><a class="fn-backref" href="#id12" name="glep-22">[7]</a></td><td>GLEP 22: &quot;New &quot;keyword&quot; system to incorporate various
528 userlands/kernels/archs&quot;, Grant Goodyear,
529 <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0022.html">http://www.gentoo.org/proj/en/glep/glep-0022.html</a></td></tr>
530 </tbody>
531 </table>
532 <table class="docutils footnote" frame="void" id="glep-31" rules="none">
533 <colgroup><col class="label" /><col /></colgroup>
534 <tbody valign="top">
535 <tr><td class="label"><a class="fn-backref" href="#id9" name="glep-31">[8]</a></td><td>GLEP 31: &quot;Character Sets for Portage Tree Items&quot;, Ciaran
536 McCreesh,
537 <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0031.html">http://www.gentoo.org/proj/en/glep/glep-0031.html</a></td></tr>
538 </tbody>
539 </table>
540 <table class="docutils footnote" frame="void" id="glep-34" rules="none">
541 <colgroup><col class="label" /><col /></colgroup>
542 <tbody valign="top">
543 <tr><td class="label"><a class="fn-backref" href="#id6" name="glep-34">[9]</a></td><td>GLEP 34: &quot;Per-Category metadata.xml Files&quot;, Ciaran McCreesh,
544 <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0034.html">http://www.gentoo.org/proj/en/glep/glep-0034.html</a></td></tr>
545 </tbody>
546 </table>
547 <table class="docutils footnote" frame="void" id="glep-36" rules="none">
548 <colgroup><col class="label" /><col /></colgroup>
549 <tbody valign="top">
550 <tr><td class="label"><a class="fn-backref" href="#id4" name="glep-36">[10]</a></td><td>GLEP 36: &quot;Subversion/CVS for Gentoo Hosted Projects&quot;, Aaron
551 Walker,
552 <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0036.html">http://www.gentoo.org/proj/en/glep/glep-0036.html</a></td></tr>
553 </tbody>
554 </table>
555 <table class="docutils footnote" frame="void" id="iso-639" rules="none">
556 <colgroup><col class="label" /><col /></colgroup>
557 <tbody valign="top">
558 <tr><td class="label"><a class="fn-backref" href="#id5" name="iso-639">[11]</a></td><td>ISO 639 &quot;Code for the representation of names of languages&quot;</td></tr>
559 </tbody>
560 </table>
561 <table class="docutils footnote" frame="void" id="ramereth-repo" rules="none">
562 <colgroup><col class="label" /><col /></colgroup>
563 <tbody valign="top">
564 <tr><td class="label"><a class="fn-backref" href="#id14" name="ramereth-repo">[12]</a></td><td>&quot;Re: [gentoo-dev] GLEP ??: Critical News Reporting&quot;, Lance
565 Albertson,
566 <a class="reference" href="http://marc.theaimsgroup.com/?l=gentoo-dev&amp;m=113111585907703&amp;w=2">http://marc.theaimsgroup.com/?l=gentoo-dev&amp;m=113111585907703&amp;w=2</a></td></tr>
567 </tbody>
568 </table>
569 <table class="docutils footnote" frame="void" id="rfc-822" rules="none">
570 <colgroup><col class="label" /><col /></colgroup>
571 <tbody valign="top">
572 <tr><td class="label"><a class="fn-backref" href="#id10" name="rfc-822">[13]</a></td><td><a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> &quot;Standard for the format of ARPA Internet text messages&quot;</td></tr>
573 </tbody>
574 </table>
575 <table class="docutils footnote" frame="void" id="rfc-3629" rules="none">
576 <colgroup><col class="label" /><col /></colgroup>
577 <tbody valign="top">
578 <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;
579 <a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr>
580 </tbody>
581 </table>
582 <table class="docutils footnote" frame="void" id="stuart-blog" rules="none">
583 <colgroup><col class="label" /><col /></colgroup>
584 <tbody valign="top">
585 <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,
586 <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>
587 </tbody>
588 </table>
589 <table class="docutils footnote" frame="void" id="id18" rules="none">
590 <colgroup><col class="label" /><col /></colgroup>
591 <tbody valign="top">
592 <tr><td class="label"><a class="fn-backref" href="#id19" name="id18">[16]</a></td><td><a class="reference" href="glep-0042-extras/example-news-item.txt">glep-0042-extras/example-news-item.txt</a></td></tr>
593 </tbody>
594 </table>
595 </div>
596 <div class="section" id="copyright">
597 <h1><a class="toc-backref" href="#id46" name="copyright">Copyright</a></h1>
598 <p>This document has been placed in the public domain.</p>
599 <!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
600 </div>
602 </div>
603 <div class="footer">
604 <hr class="footer" />
605 <a class="reference" href="glep-0042.txt">View document source</a>.
606 Generated on: 2005-12-13 03:21 UTC.
607 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.
609 </div>
610 </body>
611 </html>

  ViewVC Help
Powered by ViewVC 1.1.20