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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.3 - (show annotations) (download) (as text)
Mon Nov 7 22:26:59 2005 UTC (13 years, 4 months ago) by ciaranm
Branch: MAIN
Changes since 1.2: +7 -7 lines
File MIME type: text/html
Fix header typos, GLEP 1 compliance

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">1.2</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">2005/11/07 17:02:42</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</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="id14" name="id14">Abstract</a></li>
58 <li><a class="reference" href="#motivation" id="id15" name="id15">Motivation</a></li>
59 <li><a class="reference" href="#requirements" id="id16" name="id16">Requirements</a></li>
60 <li><a class="reference" href="#specification" id="id17" name="id17">Specification</a><ul>
61 <li><a class="reference" href="#overview" id="id18" name="id18">Overview</a></li>
62 <li><a class="reference" href="#news-item-file-format" id="id19" name="id19">News Item File Format</a><ul>
63 <li><a class="reference" href="#news-item-headers" id="id20" name="id20">News Item Headers</a></li>
64 <li><a class="reference" href="#news-item-body" id="id21" name="id21">News Item Body</a></li>
65 <li><a class="reference" href="#example-news-item" id="id22" name="id22">Example News Item</a></li>
66 </ul>
67 </li>
68 <li><a class="reference" href="#news-item-quality-control" id="id23" name="id23">News Item Quality Control</a></li>
69 <li><a class="reference" href="#news-item-distribution" id="id24" name="id24">News Item Distribution</a><ul>
70 <li><a class="reference" href="#server-side" id="id25" name="id25">Server Side</a></li>
71 <li><a class="reference" href="#client-side" id="id26" name="id26">Client Side</a></li>
72 </ul>
73 </li>
74 <li><a class="reference" href="#news-item-clients" id="id27" name="id27">News Item Clients</a></li>
75 <li><a class="reference" href="#news-item-removal" id="id28" name="id28">News Item Removal</a></li>
76 </ul>
77 </li>
78 <li><a class="reference" href="#integration-with-existing-systems" id="id29" name="id29">Integration with Existing Systems</a></li>
79 <li><a class="reference" href="#backwards-compatibility" id="id30" name="id30">Backwards Compatibility</a></li>
80 <li><a class="reference" href="#reference-implementation" id="id31" name="id31">Reference Implementation</a><ul>
81 <li><a class="reference" href="#portage-code" id="id32" name="id32">Portage Code</a></li>
82 <li><a class="reference" href="#simple-eselect-news-client" id="id33" name="id33">Simple <tt class="docutils literal"><span class="pre">eselect</span></tt> News Client</a></li>
83 <li><a class="reference" href="#simple-news-to-mail-forwarder" id="id34" name="id34">Simple News to Mail Forwarder</a></li>
84 </ul>
85 </li>
86 <li><a class="reference" href="#credits" id="id35" name="id35">Credits</a></li>
87 <li><a class="reference" href="#references" id="id36" name="id36">References</a></li>
88 <li><a class="reference" href="#copyright" id="id37" name="id37">Copyright</a></li>
89 </ul>
90 </div>
91 <div class="section" id="abstract">
92 <h1><a class="toc-backref" href="#id14" name="abstract">Abstract</a></h1>
93 <p>This GLEP proposes a new way of informing users about important updates and news
94 regarding tree-related items.</p>
95 </div>
96 <div class="section" id="motivation">
97 <h1><a class="toc-backref" href="#id15" name="motivation">Motivation</a></h1>
98 <p>There are currently several ways of getting news out to our users, none of them
99 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> mailing list</li>
103 <li>The Gentoo Forums</li>
104 <li>The main Gentoo website</li>
105 <li>RSS feeds of Gentoo news</li>
106 </ul>
107 <p>A more reliable way of getting news of critical updates out to users is required
108 to avoid repeats of the various recent upgrade debacles. This GLEP proposes a
109 solution based around pushing news items out to the user via the <tt class="docutils literal"><span class="pre">rsync</span></tt> tree.</p>
110 </div>
111 <div class="section" id="requirements">
112 <h1><a class="toc-backref" href="#id16" name="requirements">Requirements</a></h1>
113 <p>An adequate solution must meet all of the following requirements:</p>
114 <dl class="docutils">
115 <dt>Preemptive</dt>
116 <dd>Users should be told of changes <em>before</em> they break the user's system,
117 not after the damage has already been done.</dd>
118 <dt>No user subscription required</dt>
119 <dd>It has already been demonstrated <a class="footnote-reference" href="#forums-whining" id="id1" name="id1">[4]</a> that many users do not
120 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
121 requires subscription has no advantage over current methods.</dd>
122 <dt>No user monitoring required</dt>
123 <dd>It has already been demonstrated <a class="footnote-reference" href="#forums-whining" id="id2" name="id2">[4]</a> that many users do not
124 read news items posted to the Gentoo website, or do not read news items
125 until it is too late. A solution that relies upon active monitoring of a
126 particular source has no advantage over current methods.</dd>
127 <dt>Relevant</dt>
128 <dd>System administrators who do not use a particular package should not have to
129 read news items which affect purely that package. Some news items may be of
130 relevance to most or all users, but those that are not should not be forced
131 upon users unnecessarily.</dd>
132 <dt>Lightweight</dt>
133 <dd>It is not reasonable to expect all users to have an MTA, web browser, email
134 client, cron daemon or text processing suite available on their system.</dd>
135 <dt>No privacy violations</dt>
136 <dd>Users of the solution should not be required to provide information about
137 their systems (for example, IP addresses or installed packages).</dd>
138 <dt>Multiple delivery method support</dt>
139 <dd>Some users may wish to view news items via email, some via a terminal and
140 some via a web browser. A solution should either support all of these
141 methods or (better still) make it trivial to write clients for displaying
142 news items in different ways.</dd>
143 </dl>
144 <p>The following characteristics would be desirable:</p>
145 <dl class="docutils">
146 <dt>Internationalisable</dt>
147 <dd>Being able to provide messages in multiple languages may be beneficial.</dd>
148 <dt>Quality control</dt>
149 <dd>There should be some way to ensure that badly written or irrelevant messages
150 are not sent out, for example by inexperienced developers, those whose
151 English language skills are below par or morons.</dd>
152 <dt>Simple for developers</dt>
153 <dd>Posting news items should be as simple as is reasonably possible.</dd>
154 <dt>Simple for users</dt>
155 <dd>Reading relevant news items should be as simple as is reasonably possible.</dd>
156 <dt>Compatibility with existing and future news sources</dt>
157 <dd>A news system would ideally be able to be integrated with existing news
158 sources (for example, Forums, GWN, the main Gentoo website) without
159 excessive difficulty. Similarly, easy interoperation with any future news
160 sources should not be precluded.</dd>
161 </dl>
162 </div>
163 <div class="section" id="specification">
164 <h1><a class="toc-backref" href="#id17" name="specification">Specification</a></h1>
165 <div class="section" id="overview">
166 <h2><a class="toc-backref" href="#id18" name="overview">Overview</a></h2>
167 <p>News items are published and delivered to users as follows:</p>
168 <ol class="arabic simple">
169 <li>A news item is written. The format to be used is described in
170 <a class="reference" href="#news-item-file-format">News Item File Format</a>.</li>
171 <li>The news item is reviewed, following the process described in
172 <a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li>
173 <li>The news item is committed to a CVS (or Subversion <a class="footnote-reference" href="#glep-36" id="id3" name="id3">[8]</a>) repository.
174 From here, it is merged with the rsync tree. This is described in <a class="reference" href="#news-item-distribution">News Item
175 Distribution</a>.</li>
176 <li>The news item is merged with the rsync tree. Implementation details of this
177 point are beyond the scope of this GLEP; existing solutions are in place
178 for merging GLSAs to the tree.</li>
179 <li>Users fetch the news item when they sync. This ensures that the news items in
180 question are pushed to the user before the user accidentally makes an
181 unwanted change. No changes to the existing rsync process are required by
182 this GLEP.</li>
183 <li>Portage filters the news item and, if it is relevant, installs it in a
184 special location to be read by a news item reader. Messages are also
185 displayed to inform the user that news is available.</li>
186 <li>The news item is handled by the user's choice of news item reader. See <a class="reference" href="#news-item-clients">News
187 Item Clients</a>.</li>
188 </ol>
189 </div>
190 <div class="section" id="news-item-file-format">
191 <h2><a class="toc-backref" href="#id19" name="news-item-file-format">News Item File Format</a></h2>
192 <p>Each news item will be represented by a single text file. This file will be
193 encoded using UTF-8 for compatibility with and for the same reason as existing
194 Gentoo documentation <a class="footnote-reference" href="#docs-policy" id="id4" name="id4">[1]</a> and tree <a class="footnote-reference" href="#glep-31" id="id5" name="id5">[6]</a> practices.</p>
195 <p>The news item will be named in the form <tt class="docutils literal"><span class="pre">yyyy-mm-dd-item-name.en.txt</span></tt>, where
196 <tt class="docutils literal"><span class="pre">item-name</span></tt> is a very short name (e.g. <tt class="docutils literal"><span class="pre">apache-updates</span></tt>) and <tt class="docutils literal"><span class="pre">en</span></tt> is the
197 two letter ISO 639 <a class="footnote-reference" href="#iso-639" id="id6" name="id6">[9]</a> language code for the news item. The short name
198 must consist only of characters <tt class="docutils literal"><span class="pre">a-z</span></tt>, <tt class="docutils literal"><span class="pre">A-Z</span></tt>, <tt class="docutils literal"><span class="pre">0-9</span></tt> and <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen).</p>
199 <p>News items may be signed using GPG. If this is done, a detached signature should
200 be used.</p>
201 <p>The directory and file name rules are designed specifically to allow easy
202 sorting by date.</p>
203 <p>An English (<tt class="docutils literal"><span class="pre">en</span></tt>) version must be available for all news items. Other
204 languages may be provided either by the original author or by other translators
205 who have commit access. This anglocentricity is justified on the grounds that
206 nobody objected to it with GLEP 34 <a class="footnote-reference" href="#glep-34" id="id7" name="id7">[7]</a>.</p>
207 <p>A news item's content will consist of an <a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> <a class="footnote-reference" href="#rfc-822" id="id8" name="id8">[11]</a> style header
208 followed by the main body of the message as plain text. This GLEP defines
209 various optional and mandatory headers. Future GLEPs may propose new headers --
210 tools handling these news items must ignore any unrecognised header.</p>
211 <div class="section" id="news-item-headers">
212 <h3><a class="toc-backref" href="#id20" name="news-item-headers">News Item Headers</a></h3>
213 <p>The following headers describe the purpose and format of the news item:</p>
214 <dl class="docutils">
215 <dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt>
216 <dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd>
217 <dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt>
218 <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>.
219 Mandatory, multiple author fields may be specified if appropriate.</dd>
220 <dt><tt class="docutils literal"><span class="pre">Translator:</span></tt></dt>
221 <dd>For translated news items, the translator's name and email address.</dd>
222 <dt><tt class="docutils literal"><span class="pre">Content-Type:</span></tt></dt>
223 <dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd>
224 <dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt>
225 <dd>Date of posting, in <tt class="docutils literal"><span class="pre">dd-mmm-yyyy</span></tt> format (e.g. 14-Aug-2001). UTC time in
226 <tt class="docutils literal"><span class="pre">hh-mm-ss</span> <span class="pre">+0000</span></tt> format may also be included. This field is mandatory.</dd>
227 <dt><tt class="docutils literal"><span class="pre">Version:</span></tt></dt>
228 <dd>Initially 1. Incremented every time a non-trivial change is made. Changes
229 which require a re-read of the news item should instead use a new news item
230 file.</dd>
231 <dt><tt class="docutils literal"><span class="pre">News-Item-Format:</span></tt></dt>
232 <dd>Must be <tt class="docutils literal"><span class="pre">1.0</span></tt>. Future revisions to the format may increment the minor
233 number for backwards-compatible changes, or the major number for major
234 changes.</dd>
235 </dl>
236 <p>The following headers are used for filtering. If none of these headers are
237 specified, the news item is displayed for all users. Otherwise, the news item is
238 displayed if <em>at least one</em> header matches.</p>
239 <dl class="docutils">
240 <dt><tt class="docutils literal"><span class="pre">Display-If-Installed:</span></tt></dt>
241 <dd>A dependency atom or simple package name (for example,
242 <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
243 package specified installed, the news item should be displayed.</dd>
244 <dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt>
245 <dd>A keyword <a class="footnote-reference" href="#glep-22" id="id9" name="id9">[5]</a> name, for example <tt class="docutils literal"><span class="pre">mips</span></tt>. If the user is on the arch
246 in question, the news item should be displayed.</dd>
247 <dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt>
248 <dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. If the
249 user is using the exact profile in question, the news item should be
250 displayed. This header may be used to replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the
251 future.</dd>
252 </dl>
253 </div>
254 <div class="section" id="news-item-body">
255 <h3><a class="toc-backref" href="#id21" name="news-item-body">News Item Body</a></h3>
256 <p>The header section must be followed by a blank line, then the main body of the
257 text.</p>
258 <p>The text body should be wrapped at 72 characters. No fancy formatting or tab
259 characters should be used -- the news item may be being displayed directly to a
260 terminal. Paragraphs should be separated by a blank line.</p>
261 <p>Hyperlinks may be used to refer to further information (for example, an upgrade
262 guide). However, the main body of the news item should be descriptive and not
263 simply a &quot;read this link&quot; text. It is assumed that the user will have access to
264 a web browser <em>somewhere</em>, but not necessarily on the box which is being
265 administrated -- this will be the case on may servers and routers, for example.</p>
266 </div>
267 <div class="section" id="example-news-item">
268 <h3><a class="toc-backref" href="#id22" name="example-news-item">Example News Item</a></h3>
269 <p>The following hypothetical news item could be used for an upgrade to the
270 <tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility. It should be
271 named <tt class="docutils literal"><span class="pre">2005-11/2005-11-01-yoursql-upgrades.en.txt</span></tt>.</p>
272 <pre class="literal-block">
273 Title: YourSQL Upgrades from 4.0 to 4.1
274 Author: Ciaran McCreesh &lt;ciaranm&#64;gentoo.org&gt;
275 Content-Type: text/plain
276 Posted: 01-Nov-2005
277 Display-If-Installed: &lt;dev-db/yoursql-4.1_alpha
279 YourSQL databases created using YourSQL version 4.0 are incompatible
280 with YourSQL version 4.1 or later. There is no reliable way to
281 automate the database format conversion, so action from the system
282 administrator is required before an upgrade can take place.
284 Please see the Gentoo YourSQL Upgrade Guide for instructions:
286 http://www.gentoo.org/doc/en/yoursql-upgrading.xml
288 Also see the official YourSQL documentation:
290 http://dev.yoursql.com/doc/refman/4.1/en/upgrading-from-4-0.html
292 After upgrading, you should also recompile any packages which link
293 against YourSQL:
295 revdep-rebuild --library=libyoursqlclient.so.12
297 The revdep-rebuild tool is provided by app-portage/gentoolkit.
298 </pre>
299 </div>
300 </div>
301 <div class="section" id="news-item-quality-control">
302 <h2><a class="toc-backref" href="#id23" name="news-item-quality-control">News Item Quality Control</a></h2>
303 <p>There have been complaints regarding the comprehensibility of some upgrade
304 notices and news items in the past. This is understandable -- not every Gentoo
305 developer speaks English as a first language. However, for the sake of clarity
306 and professionalism it is important that any language problems be corrected
307 before inflicting a news item upon end users.</p>
308 <p>Thus, all proposed news items must be posted to the <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt> or
309 <tt class="docutils literal"><span class="pre">gentoo-core</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> at least 72
310 hours before being committed (exceptions may be made in exceptional
311 circumstances). Any complaints regarding wording or clarity <strong>must</strong> be
312 addressed before the news item goes live.</p>
313 <p>News items must only be for <strong>important</strong> changes that may cause serious upgrade
314 or compatibility problems. Ordinary upgrade messages and non-critical news items
315 should remain in <tt class="docutils literal"><span class="pre">einfo</span></tt> notices. The importance of the message to its
316 intended audience should be justified with the proposal.</p>
317 <div class="important">
318 <p class="first admonition-title">Important</p>
319 <p class="last">The filtering system means that it is appropriate to send out
320 news items which are aimed at users of an uncommon package or architecture.
321 Thus, the justification should be in the form &quot;this message is important to
322 YourSQL users because ...&quot;, not &quot;YourSQL is important because ...&quot;.</p>
323 </div>
324 </div>
325 <div class="section" id="news-item-distribution">
326 <h2><a class="toc-backref" href="#id24" name="news-item-distribution">News Item Distribution</a></h2>
327 <div class="section" id="server-side">
328 <h3><a class="toc-backref" href="#id25" name="server-side">Server Side</a></h3>
329 <p>News items are to be made available via the Portage tree. This removes any
330 need for polling of a remote source.</p>
331 <p>A new repository will be created for news items. The type (CVS or Subversion),
332 location and access controls on this repository are beyond the scope of this
333 GLEP.</p>
334 <div class="note">
335 <p class="first admonition-title">Note</p>
336 <p class="last">A previous draft of this GLEP instead used the main <tt class="docutils literal"><span class="pre">gentoo-x86</span></tt>
337 tree. This was changed following advice from Infrastructure
338 <a class="footnote-reference" href="#ramereth-repo" id="id10" name="id10">[10]</a>. Both solutions have the same end result.</p>
339 </div>
340 <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
341 the current year and <tt class="docutils literal"><span class="pre">mm</span></tt> is the current month number (01 for January through
342 12 for December). This separation will help keep news items more manageable.</p>
343 <p>The contents of this repository will automatically be merged with the main rsync
344 tree, placing the items under a top-level <tt class="docutils literal"><span class="pre">news/</span></tt> directory. The method used
345 for merging these items is beyond the scope of this GLEP -- a similar setup is
346 already used for merging GLSAs into the rsync tree.</p>
347 <div class="note">
348 <p class="first admonition-title">Note</p>
349 <p class="last">The <tt class="docutils literal"><span class="pre">profiles/</span></tt> directory will <em>not</em> be used. This fits in with
350 the Portage team's future plans for <tt class="docutils literal"><span class="pre">profiles/</span></tt> and <tt class="docutils literal"><span class="pre">metadata/</span></tt>
351 separation.</p>
352 </div>
353 </div>
354 <div class="section" id="client-side">
355 <h3><a class="toc-backref" href="#id26" name="client-side">Client Side</a></h3>
356 <p>Whenever relevant unread news items are found, <tt class="docutils literal"><span class="pre">emerge</span></tt> will copy or symlink
357 the news file into <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/</span></tt>.</p>
358 <p>Notification that new relevant news items will be displayed via the
359 <tt class="docutils literal"><span class="pre">emerge</span></tt> tool in a similar way to the existing &quot;configuration files need
360 updating&quot; messages:</p>
361 <pre class="literal-block">
362 * Important: 3 config files in /etc need updating.
363 * Type emerge --help config to learn how to update config files.
365 * Important: there are 5 unread news items.
366 * Type emerge --help news to learn how to read news files.
367 </pre>
368 <p>The unread news message will also be displayed immediately after an
369 <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">sync</span></tt>.</p>
370 <p>Portage may also warn of unread news items using, for example, a red flashy
371 before actions such as merging a package.</p>
372 <p>Portage must keep track of news items which have already been installed to avoid
373 repeatedly reinstalling a deleted news item.</p>
374 <p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to
375 filter out the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p>
376 </div>
377 </div>
378 <div class="section" id="news-item-clients">
379 <h2><a class="toc-backref" href="#id27" name="news-item-clients">News Item Clients</a></h2>
380 <p>Once a news item is 'installed', third party tools (or a traditional Unix pager
381 and <tt class="docutils literal"><span class="pre">rm</span></tt>) can be used to display and view the news files. An <tt class="docutils literal"><span class="pre">eselect</span></tt>
382 <a class="footnote-reference" href="#eselect" id="id11" name="id11">[2]</a> module shall be created as the 'suggested' display tool; other
383 display tools (for example, a news to email forwarder, which would be ideal for
384 users who sync on a cron) are left as options for those who desire them -- the
385 simple file format make this relatively simple.</p>
386 </div>
387 <div class="section" id="news-item-removal">
388 <h2><a class="toc-backref" href="#id28" name="news-item-removal">News Item Removal</a></h2>
389 <p>News items can be removed (by removing the news file from the main tree) when
390 they are no longer relevant, if they are made obsolete by a future news item or
391 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>
392 entries.</p>
393 </div>
394 </div>
395 <div class="section" id="integration-with-existing-systems">
396 <h1><a class="toc-backref" href="#id29" name="integration-with-existing-systems">Integration with Existing Systems</a></h1>
397 <p>It would be trivial to convert these news items into the format used for news
398 items on the Gentoo website or posts for the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list.</p>
399 <p>There is an existing automated tool <a class="footnote-reference" href="#forums-glsa" id="id12" name="id12">[3]</a> for posting GLSAs to the
400 forums. A similar tool can be used for these news items.</p>
401 </div>
402 <div class="section" id="backwards-compatibility">
403 <h1><a class="toc-backref" href="#id30" name="backwards-compatibility">Backwards Compatibility</a></h1>
404 <p>Backwards compatibility is not a concern here. Existing tools will simply ignore
405 the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p>
406 </div>
407 <div class="section" id="reference-implementation">
408 <h1><a class="toc-backref" href="#id31" name="reference-implementation">Reference Implementation</a></h1>
409 <div class="section" id="portage-code">
410 <h2><a class="toc-backref" href="#id32" name="portage-code">Portage Code</a></h2>
411 <p>TODO</p>
412 </div>
413 <div class="section" id="simple-eselect-news-client">
414 <h2><a class="toc-backref" href="#id33" name="simple-eselect-news-client">Simple <tt class="docutils literal docutils literal"><span class="pre">eselect</span></tt> News Client</a></h2>
415 <p>A demonstration <tt class="docutils literal"><span class="pre">eselect</span></tt> news display script follows:</p>
416 <pre class="literal-block">
417 # Copyright 1999-2005 Gentoo Foundation
418 # Distributed under the terms of the GNU General Public License v2
419 # $Id: glep-0042.txt,v 1.2 2005/11/07 17:02:42 ciaranm Exp $
421 DESCRIPTION=&quot;Read important Gentoo news items&quot;
422 MAINTAINER=&quot;ciaranm&#64;gentoo.org&quot;
423 SVN_DATE='$Date: 2005/11/07 17:02:42 $'
424 VERSION=$(svn_date_to_version &quot;${SVN_DATE}&quot; )
426 get_news_item_list() {
427 [[ -d &quot;${ROOT}/var/lib/gentoo/news&quot; ]] || return
428 (
429 local news
430 for news in &quot;${ROOT}/var/lib/gentoo/news/&quot;*.txt ; do
431 echo $(basename ${news%%.*} )
432 done
433 ) | sort -u
434 }
436 get_filename() {
437 local best_lang=${LANG%%_*} lang= filename=&quot;${1}&quot;
438 [[ -e &quot;/${filename}&quot; ]] || for lang in &quot;${best_lang}&quot; &quot;en&quot; ; do
439 filename=&quot;${ROOT}/var/lib/gentoo/news/${1}.${lang}.txt&quot;
440 [[ -e &quot;${filename}&quot; ]] &amp;&amp; break
441 done
442 [[ -e &quot;${filename}&quot; ]] &amp;&amp; echo &quot;${filename}&quot; || die -q &quot;Can't find '${1}'&quot;
443 }
445 get_all_filenames() {
446 if [[ -z &quot;${1}&quot; ]] ; then
447 echo &quot;${ROOT}/var/lib/gentoo/news/&quot;*.??&quot;.txt&quot;
448 else
449 echo &quot;${ROOT}/var/lib/gentoo/news/${1}.&quot;??&quot;.txt&quot;
450 fi
451 }
453 get_headers() {
454 sed -e '/^$/Q' &lt; $(get_filename &quot;${1}&quot; )
455 }
457 get_body() {
458 sed -e '1,/^$/d' &lt; $(get_filename &quot;${1}&quot; )
459 }
461 get_title() {
462 get_headers &quot;${1}&quot; | sed -n -e '/^[Tt]itle: /s/^[^:]\+:[ \t]*//p'
463 }
465 ### list action
467 ## {{{ list stuff
468 describe_list() {
469 echo &quot;List available news items&quot;
470 }
472 do_list() {
473 write_list_start &quot;Available news items:&quot;
474 local empty=yes n=1
475 for news in $(get_news_item_list ) ; do
476 write_numbered_list_entry ${n} &quot;$(highlight $(get_title ${news} ) ) (${news})&quot;
477 n=$(( n + 1 ))
478 done
479 }
480 ## }}}
482 ## {{{ show stuff
483 describe_show(){
484 echo &quot;Show a news item&quot;
485 }
487 do_show() {
488 [[ -z &quot;${1}&quot; ]] &amp;&amp; die -q &quot;You didn't tell me which news item to read&quot;
490 local target=${1} filename=
491 if is_number &quot;${target}&quot; &amp;&amp; [[ ${target} -ge 1 ]] ; then
492 targets=( $(get_news_item_list ) )
493 target=${targets[$(( ${target} - 1 ))]}
494 fi
496 (
497 get_headers &quot;${target}&quot; | grep -v '^Display-If-\|Content-Type:'
498 echo
499 get_body &quot;${target}&quot;
500 ) | ${PAGER:-cat}
501 }
502 ## }}}
504 # {{{ delete stuff
505 describe_delete() {
506 echo &quot;Delete a news item&quot;
507 }
509 do_delete() {
510 [[ -z &quot;${1}&quot; ]] &amp;&amp; die -q &quot;You didn't tell me which news item to delete&quot;
512 for target in $&#64; ; do
513 if is_number &quot;${target}&quot; &amp;&amp; [[ ${target} -ge 1 ]] ; then
514 targets=( $(get_news_item_list ) )
515 target=${targets[$(( ${target} - 1 ))]}
516 fi
518 rm $(get_all_filenames &quot;${target}&quot; ) || die -q &quot;Couldn't delete ${target}&quot;
519 done
520 }
521 # }}}
523 # {{{ delete-all
524 describe_delete-all() {
525 echo &quot;Delete all news items&quot;
526 }
528 do_delete-all() {
529 rm $(get_all_filenames ) || die -q &quot;Couldn't delete news items&quot;
530 }
531 # }}}
532 </pre>
533 </div>
534 <div class="section" id="simple-news-to-mail-forwarder">
535 <h2><a class="toc-backref" href="#id34" name="simple-news-to-mail-forwarder">Simple News to Mail Forwarder</a></h2>
536 <p>A demonstration shell script which delivers news items via email follows:</p>
537 <pre class="literal-block">
538 #!/bin/bash
540 to_address=&quot;root&#64;localhost&quot;
541 mail=&quot;mailx&quot;
542 best_lang=&quot;${LANG%%_*}&quot;
544 for news in /var/lib/gentoo/news/*.*.txt ; do
545 [[ -z &quot;${best_lang}&quot; ]] || news=&quot;${news%%.*}.${best_lang}.txt&quot;
546 [[ -f &quot;${news}&quot; ]] || news=&quot;${news%%.*}.en.txt&quot;
547 [[ -f &quot;${news}&quot; ]] || continue
548 title=$(sed -n -e '/^Title:/ { s,^[^:]\+:[ \t]\+,,p ; q }' &lt; ${news} )
549 sed -e '1,/^$/ { /^Display-If\|Content-Type/d }' &lt; &quot;${news}&quot; | \
550 ${mail} -s &quot;Gentoo news: ${title}&quot; &quot;${to_address}&quot; &amp;&amp; \
551 for file in ${news%%.*}.*.txt ; do rm &quot;${file}&quot; ; done
552 done
553 </pre>
554 </div>
555 </div>
556 <div class="section" id="credits">
557 <h1><a class="toc-backref" href="#id35" name="credits">Credits</a></h1>
558 <p>The idea behind notifying users of news updates via Portage comes from Stuart
559 Herbert <a class="footnote-reference" href="#stuart-blog" id="id13" name="id13">[12]</a>.</p>
560 <p>Thanks to Lance Albertson, Donnie Berkholz, Grant Goodyear, Brian Harring, Dan
561 Meltzer, Paul de Vrieze and Alec Warner for input. Some of the ideas presented
562 here are theirs, others go completely against their suggestions.</p>
563 </div>
564 <div class="section" id="references">
565 <h1><a class="toc-backref" href="#id36" name="references">References</a></h1>
566 <table class="docutils footnote" frame="void" id="docs-policy" rules="none">
567 <colgroup><col class="label" /><col /></colgroup>
568 <tbody valign="top">
569 <tr><td class="label"><a class="fn-backref" href="#id4" name="docs-policy">[1]</a></td><td>Gentoo XML Guide, Daniel Robbins et al.,
570 <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>
571 </tbody>
572 </table>
573 <table class="docutils footnote" frame="void" id="eselect" rules="none">
574 <colgroup><col class="label" /><col /></colgroup>
575 <tbody valign="top">
576 <tr><td class="label"><a class="fn-backref" href="#id11" name="eselect">[2]</a></td><td>eselect modular framework for configuration and
577 administration utilities,
578 <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>
579 </tbody>
580 </table>
581 <table class="docutils footnote" frame="void" id="forums-glsa" rules="none">
582 <colgroup><col class="label" /><col /></colgroup>
583 <tbody valign="top">
584 <tr><td class="label"><a class="fn-backref" href="#id12" name="forums-glsa">[3]</a></td><td>Forums user GLSA,
585 <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>
586 </tbody>
587 </table>
588 <table class="docutils footnote" frame="void" id="forums-whining" rules="none">
589 <colgroup><col class="label" /><col /></colgroup>
590 <tbody valign="top">
591 <tr><td class="label"><a name="forums-whining">[4]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>)</em> Forums thread &quot;Gentoo Apache2 Config Change Idiocy&quot;,
592 <a class="reference" href="http://forums.gentoo.org/viewtopic-t-384368.html">http://forums.gentoo.org/viewtopic-t-384368.html</a></td></tr>
593 </tbody>
594 </table>
595 <table class="docutils footnote" frame="void" id="glep-22" rules="none">
596 <colgroup><col class="label" /><col /></colgroup>
597 <tbody valign="top">
598 <tr><td class="label"><a class="fn-backref" href="#id9" name="glep-22">[5]</a></td><td>GLEP 22: &quot;New &quot;keyword&quot; system to incorporate various
599 userlands/kernels/archs&quot;, Grant Goodyear,
600 <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>
601 </tbody>
602 </table>
603 <table class="docutils footnote" frame="void" id="glep-31" rules="none">
604 <colgroup><col class="label" /><col /></colgroup>
605 <tbody valign="top">
606 <tr><td class="label"><a class="fn-backref" href="#id5" name="glep-31">[6]</a></td><td>GLEP 31: &quot;Character Sets for Portage Tree Items&quot;, Ciaran
607 McCreesh,
608 <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>
609 </tbody>
610 </table>
611 <table class="docutils footnote" frame="void" id="glep-34" rules="none">
612 <colgroup><col class="label" /><col /></colgroup>
613 <tbody valign="top">
614 <tr><td class="label"><a class="fn-backref" href="#id7" name="glep-34">[7]</a></td><td>GLEP 34: &quot;Per-Category metadata.xml Files&quot;, Ciaran McCreesh,
615 <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>
616 </tbody>
617 </table>
618 <table class="docutils footnote" frame="void" id="glep-36" rules="none">
619 <colgroup><col class="label" /><col /></colgroup>
620 <tbody valign="top">
621 <tr><td class="label"><a class="fn-backref" href="#id3" name="glep-36">[8]</a></td><td>GLEP 36: &quot;Subversion/CVS for Gentoo Hosted Projects&quot;, Aaron
622 Walker,
623 <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>
624 </tbody>
625 </table>
626 <table class="docutils footnote" frame="void" id="iso-639" rules="none">
627 <colgroup><col class="label" /><col /></colgroup>
628 <tbody valign="top">
629 <tr><td class="label"><a class="fn-backref" href="#id6" name="iso-639">[9]</a></td><td>ISO 639 &quot;Code for the representation of names of languages&quot;</td></tr>
630 </tbody>
631 </table>
632 <table class="docutils footnote" frame="void" id="ramereth-repo" rules="none">
633 <colgroup><col class="label" /><col /></colgroup>
634 <tbody valign="top">
635 <tr><td class="label"><a class="fn-backref" href="#id10" name="ramereth-repo">[10]</a></td><td>&quot;Re: [gentoo-dev] GLEP ??: Critical News Reporting&quot;, Lance
636 Albertson,
637 <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>
638 </tbody>
639 </table>
640 <table class="docutils footnote" frame="void" id="rfc-822" rules="none">
641 <colgroup><col class="label" /><col /></colgroup>
642 <tbody valign="top">
643 <tr><td class="label"><a class="fn-backref" href="#id8" name="rfc-822">[11]</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>
644 </tbody>
645 </table>
646 <table class="docutils footnote" frame="void" id="stuart-blog" rules="none">
647 <colgroup><col class="label" /><col /></colgroup>
648 <tbody valign="top">
649 <tr><td class="label"><a class="fn-backref" href="#id13" name="stuart-blog">[12]</a></td><td>&quot;Favouring an automatic news mechanism&quot;, Stuart Herbert,
650 <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>
651 </tbody>
652 </table>
653 </div>
654 <div class="section" id="copyright">
655 <h1><a class="toc-backref" href="#id37" name="copyright">Copyright</a></h1>
656 <p>This document has been placed in the public domain.</p>
657 <!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
658 </div>
660 </div>
661 <div class="footer">
662 <hr class="footer" />
663 <a class="reference" href="glep-0042.txt">View document source</a>.
664 Generated on: 2005-11-07 22:15 UTC.
665 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.
667 </div>
668 </body>
669 </html>

  ViewVC Help
Powered by ViewVC 1.1.20