/[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.4 - (hide annotations) (download) (as text)
Sun Dec 11 01:38:18 2005 UTC (8 years, 9 months ago) by ciaranm
Branch: MAIN
Changes since 1.3: +266 -330 lines
File MIME type: text/html
New glep 42 draft

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

  ViewVC Help
Powered by ViewVC 1.1.20