/[gentoo]/xml/htdocs/proj/en/glep/glep-0042.html
Gentoo

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.19 - (show annotations) (download) (as text)
Mon Feb 22 20:32:49 2010 UTC (4 years, 4 months ago) by zmedico
Branch: MAIN
CVS Tags: HEAD
Changes since 1.18: +185 -188 lines
File MIME type: text/html
Error occurred while calculating annotation data.
Regenerate html from updated glep-0042.txt.

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

  ViewVC Help
Powered by ViewVC 1.1.20