| … | |
… | |
| 30 | <tbody valign="top"> |
30 | <tbody valign="top"> |
| 31 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td> |
31 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td> |
| 32 | </tr> |
32 | </tr> |
| 33 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td> |
33 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td> |
| 34 | </tr> |
34 | </tr> |
| 35 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">$Revision: 1.6 $</td> |
35 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">$Revision: 1.7 $</td> |
| 36 | </tr> |
36 | </tr> |
| 37 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh <ciaranm at gentoo.org></td> |
37 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh <ciaranm at gentoo.org></td> |
| 38 | </tr> |
38 | </tr> |
| 39 | <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0042.txt?cvsroot=gentoo">$Date: 2005/12/18 04:16:44 $</a></td> |
39 | <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0042.txt?cvsroot=gentoo">$Date: 2006/01/05 15:10:45 $</a></td> |
| 40 | </tr> |
40 | </tr> |
| 41 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> |
41 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> |
| 42 | </tr> |
42 | </tr> |
| 43 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
43 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
| 44 | </tr> |
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> |
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> |
46 | </tr> |
| 47 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td> |
47 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td> |
| 48 | </tr> |
48 | </tr> |
| 49 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005, 18-Dec-2005</td> |
49 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005, 18-Dec-2005, 5-Jan-2006</td> |
| 50 | </tr> |
50 | </tr> |
| 51 | </tbody> |
51 | </tbody> |
| 52 | </table> |
52 | </table> |
| 53 | <hr /> |
53 | <hr /> |
| 54 | <div class="contents topic" id="contents"> |
54 | <div class="contents topic" id="contents"> |
| … | |
… | |
| 203 | </ol> |
203 | </ol> |
| 204 | </div> |
204 | </div> |
| 205 | <div class="section" id="required-portage-enhancements"> |
205 | <div class="section" id="required-portage-enhancements"> |
| 206 | <h2><a class="toc-backref" href="#id25" name="required-portage-enhancements">Required Portage Enhancements</a></h2> |
206 | <h2><a class="toc-backref" href="#id25" name="required-portage-enhancements">Required Portage Enhancements</a></h2> |
| 207 | <p>The following extensions to Portage are required:</p> |
207 | <p>The following extensions to Portage are required:</p> |
| 208 | <p>TODO: ferringb wants spaces added to the first item on the list. I don't, |
|
|
| 209 | because it makes repo id -> filename mappings nasty.</p> |
|
|
| 210 | <ul class="simple"> |
208 | <ul class="simple"> |
| 211 | <li>Every repository (including overlays) will require a unique identifier. It is |
209 | <li>Every repository (including overlays) will require a unique identifier. It is |
| 212 | assumed that an identifier will be a string consisting of characters from |
210 | assumed that an identifier will be a string consisting of characters from |
| 213 | <tt class="docutils literal"><span class="pre">a</span></tt> to <tt class="docutils literal"><span class="pre">z</span></tt>, <tt class="docutils literal"><span class="pre">A</span></tt> to <tt class="docutils literal"><span class="pre">Z</span></tt>, <tt class="docutils literal"><span class="pre">0</span></tt> to <tt class="docutils literal"><span class="pre">9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen), |
211 | <tt class="docutils literal"><span class="pre">a</span></tt> to <tt class="docutils literal"><span class="pre">z</span></tt>, <tt class="docutils literal"><span class="pre">A</span></tt> to <tt class="docutils literal"><span class="pre">Z</span></tt>, <tt class="docutils literal"><span class="pre">0</span></tt> to <tt class="docutils literal"><span class="pre">9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen) |
| 214 | <tt class="docutils literal"><span class="pre">:</span></tt> (colon) and <tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</li> |
212 | <tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</li> |
| 215 | <li>Portage must provide a way for external programs to obtain a list of all |
213 | <li>Portage must provide a way for external programs to obtain a list of all |
| 216 | repository identifiers for a given system. It is assumed that this will be in |
214 | repository identifiers for a given system. It is assumed that this will be in |
| 217 | the form of a <tt class="docutils literal"><span class="pre">portageq</span></tt> command (e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">get_repo_ids</span></tt>).</li> |
215 | the form of a <tt class="docutils literal"><span class="pre">portageq</span></tt> command (e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">get_repo_ids</span></tt>).</li> |
| 218 | <li>Portage must provide a way for external programs to obtain the base path for |
216 | <li>Portage must provide a way for external programs to obtain the base path for |
| 219 | a repository with a given ID. It is assumed that this will be in the form of |
217 | a repository with a given ID. It is assumed that this will be in the form of |
| … | |
… | |
| 231 | <p>Each news item will have a unique identifier. This identifier will be in the |
229 | <p>Each news item will have a unique identifier. This identifier will be in the |
| 232 | 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>), |
230 | form <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name</span></tt>, where <tt class="docutils literal"><span class="pre">yyyy</span></tt> is the year (e.g. <tt class="docutils literal"><span class="pre">2005</span></tt>), |
| 233 | <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 |
231 | <tt class="docutils literal"><span class="pre">mm</span></tt> is the month (<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">12</span></tt>) and dd is the day of the month |
| 234 | (<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 |
232 | (<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">31</span></tt>). The <tt class="docutils literal"><span class="pre">short-name</span></tt> is a very short name describing the |
| 235 | 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>, |
233 | news item (e.g. <tt class="docutils literal"><span class="pre">yoursql-updates</span></tt>), consisting only of the characters <tt class="docutils literal"><span class="pre">a-z</span></tt>, |
| 236 | <tt class="docutils literal"><span class="pre">0-9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">:</span></tt> (colon), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen) and <tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</p> |
234 | <tt class="docutils literal"><span class="pre">0-9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen) and <tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</p> |
| 237 | </div> |
235 | </div> |
| 238 | <div class="section" id="news-item-directories"> |
236 | <div class="section" id="news-item-directories"> |
| 239 | <h2><a class="toc-backref" href="#id27" name="news-item-directories">News Item Directories</a></h2> |
237 | <h2><a class="toc-backref" href="#id27" name="news-item-directories">News Item Directories</a></h2> |
| 240 | <p>Each news item will be represented by a directory whose name is the same as the |
238 | <p>Each news item will be represented by a directory whose name is the same as the |
| 241 | news item's identifier.</p> |
239 | news item's identifier.</p> |
| … | |
… | |
| 249 | <div class="section" id="news-item-files"> |
247 | <div class="section" id="news-item-files"> |
| 250 | <h2><a class="toc-backref" href="#id28" name="news-item-files">News Item Files</a></h2> |
248 | <h2><a class="toc-backref" href="#id28" name="news-item-files">News Item Files</a></h2> |
| 251 | <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 |
249 | <p>A news item file is a text file, encoded using UTF-8 <a class="footnote-reference" href="#rfc-3629" id="id7" name="id7">[14]</a> for |
| 252 | compatibility with and for the same reasons as existing Gentoo documentation |
250 | compatibility with and for the same reasons as existing Gentoo documentation |
| 253 | <a class="footnote-reference" href="#docs-policy" id="id8" name="id8">[2]</a> and the tree <a class="footnote-reference" href="#glep-31" id="id9" name="id9">[7]</a>.</p> |
251 | <a class="footnote-reference" href="#docs-policy" id="id8" name="id8">[2]</a> and the tree <a class="footnote-reference" href="#glep-31" id="id9" name="id9">[7]</a>.</p> |
| 254 | <p>News items should be signed with a detached GPG signature:</p> |
252 | <p>News items must be signed with a detached GPG signature.:</p> |
| 255 | <pre class="literal-block"> |
253 | <pre class="literal-block"> |
| 256 | gpg --armour --detach-sign ????-??-??-*.??.txt |
254 | gpg --armour --detach-sign ????-??-??-*.??.txt |
| 257 | </pre> |
255 | </pre> |
|
|
256 | <p>This GLEP does not specify the type or strength of signature to be used, nor |
|
|
257 | does it discuss how, if at all, a centralised keychain will be provided. These |
|
|
258 | issues should be handled as part of the signing policy discussions.</p> |
| 258 | <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> |
259 | <p>A news item file's content will consist of an <a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> style header <a class="footnote-reference" href="#rfc-822" id="id10" name="id10">[13]</a> |
| 259 | followed by the main body of the message as plain text. This GLEP defines |
260 | followed by the main body of the message as plain text. This GLEP defines |
| 260 | various optional and mandatory headers. Future GLEPs may propose new headers — |
261 | various optional and mandatory headers. Future GLEPs may propose new headers — |
| 261 | tools handling these news items must ignore any unrecognised header.</p> |
262 | tools handling these news items must ignore any unrecognised header.</p> |
| 262 | <div class="section" id="news-item-headers"> |
263 | <div class="section" id="news-item-headers"> |
| … | |
… | |
| 275 | <dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd> |
276 | <dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd> |
| 276 | <dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt> |
277 | <dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt> |
| 277 | <dd>Date of posting, in <tt class="docutils literal"><span class="pre">yyyy-mm-dd</span></tt> format (e.g. 2005-12-18) for |
278 | <dd>Date of posting, in <tt class="docutils literal"><span class="pre">yyyy-mm-dd</span></tt> format (e.g. 2005-12-18) for |
| 278 | compatibility with GLEP 45 <a class="footnote-reference" href="#glep-45" id="id11" name="id11">[10]</a>. Mandatory.</dd> |
279 | compatibility with GLEP 45 <a class="footnote-reference" href="#glep-45" id="id11" name="id11">[10]</a>. Mandatory.</dd> |
| 279 | <dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt> |
280 | <dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt> |
| 280 | <dd>Initially 1. Incremented every time a non-trivial change is made. Changes |
281 | <dd>Initially 1. Should be incremented every time a change is made to the news |
| 281 | which require a re-read of the news item should instead use a new news item |
282 | item. Changes that require a re-read of the news item (i.e., most changes |
|
|
283 | that are not spelling or formatting related) should instead use a new news |
| 282 | file. Mandatory.</dd> |
284 | item. Mandatory.</dd> |
| 283 | <dt><tt class="docutils literal"><span class="pre">News-Item-Format:</span></tt></dt> |
285 | <dt><tt class="docutils literal"><span class="pre">News-Item-Format:</span></tt></dt> |
| 284 | <dd>Must be <tt class="docutils literal"><span class="pre">1.0</span></tt>. Future revisions to the format may increment the minor |
286 | <dd>Must be <tt class="docutils literal"><span class="pre">1.0</span></tt>. Future revisions to the format may increment the minor |
| 285 | number for backwards-compatible changes, or the major number for major |
287 | number for backwards-compatible changes, or the major number for major |
| 286 | changes.</dd> |
288 | changes.</dd> |
| 287 | </dl> |
289 | </dl> |
| 288 | <p>The following headers are used for filtering:</p> |
290 | <p>The following headers are used for filtering:</p> |
| 289 | <dl class="docutils"> |
291 | <dl class="docutils"> |
| 290 | <dt><tt class="docutils literal"><span class="pre">Display-If-Installed:</span></tt></dt> |
292 | <dt><tt class="docutils literal"><span class="pre">Display-If-Installed:</span></tt></dt> |
| 291 | <dd>A dependency atom or simple package name (for example, |
293 | <dd>A dependency atom (for example, <tt class="docutils literal"><span class="pre"><dev-lang/php-5_alpha</span></tt> or |
| 292 | <tt class="docutils literal"><span class="pre"><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 |
294 | <tt class="docutils literal"><span class="pre">net-www/apache</span></tt>). If the user has the package specified installed from |
| 293 | package specified installed from the repository from which the news item was |
295 | the repository from which the news item was obtained, the news item should |
| 294 | obtained, the news item should be displayed.</dd> |
296 | be displayed.</dd> |
| 295 | <dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt> |
297 | <dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt> |
| 296 | <dd>A keyword <a class="footnote-reference" href="#glep-22" id="id12" name="id12">[6]</a> name, for example <tt class="docutils literal"><span class="pre">mips</span></tt> or <tt class="docutils literal"><span class="pre">x86-fbsd</span></tt>. If the |
298 | <dd>A keyword <a class="footnote-reference" href="#glep-22" id="id12" name="id12">[6]</a> name, for example <tt class="docutils literal"><span class="pre">mips</span></tt> or <tt class="docutils literal"><span class="pre">x86-fbsd</span></tt>. If the |
| 297 | user is on the keyword in question, the news item should be displayed.</dd> |
299 | user is on the keyword in question, the news item should be displayed.</dd> |
| 298 | <dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt> |
300 | <dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt> |
| 299 | <dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. If the |
301 | <dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. If the |
| … | |
… | |
| 334 | terminal. Paragraphs should be separated by a blank line.</p> |
336 | terminal. Paragraphs should be separated by a blank line.</p> |
| 335 | <p>Hyperlinks may be used to refer to further information (for example, an upgrade |
337 | <p>Hyperlinks may be used to refer to further information (for example, an upgrade |
| 336 | guide). However, the main body of the news item should be descriptive and not |
338 | guide). However, the main body of the news item should be descriptive and not |
| 337 | simply a "read this link" text. It is assumed that the user will have access to |
339 | simply a "read this link" text. It is assumed that the user will have access to |
| 338 | a web browser <em>somewhere</em>, but not necessarily on the box which is being |
340 | a web browser <em>somewhere</em>, but not necessarily on the box which is being |
| 339 | administrated — this will be the case on may servers and routers, for example.</p> |
341 | administrated — this will be the case on many servers and routers, for example.</p> |
| 340 | </div> |
342 | </div> |
| 341 | <div class="section" id="example-news-item"> |
343 | <div class="section" id="example-news-item"> |
| 342 | <h3><a class="toc-backref" href="#id31" name="example-news-item">Example News Item</a></h3> |
344 | <h3><a class="toc-backref" href="#id31" name="example-news-item">Example News Item</a></h3> |
| 343 | <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 |
345 | <p><a class="reference" href="glep-0042-extras/example-news-item.txt">This hypothetical news item</a> <a class="footnote-reference" href="#id18" id="id19" name="id19">[16]</a> could be used for an upgrade to the |
| 344 | <tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p> |
346 | <tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p> |
| … | |
… | |
| 354 | <p>Thus, at least 72 hours before a proposed news item is committed, it must be |
356 | <p>Thus, at least 72 hours before a proposed news item is committed, it must be |
| 355 | 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@gentoo.org</span></tt> |
357 | 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@gentoo.org</span></tt> |
| 356 | (exceptions may be made in exceptional circumstances). Any complaints — for |
358 | (exceptions may be made in exceptional circumstances). Any complaints — for |
| 357 | example regarding wording, clarity or accuracy — <strong>must</strong> be addressed before |
359 | example regarding wording, clarity or accuracy — <strong>must</strong> be addressed before |
| 358 | the news item goes live.</p> |
360 | the news item goes live.</p> |
| 359 | <div class="note"> |
|
|
| 360 | <p class="first admonition-title">Note</p> |
|
|
| 361 | <p class="last">A previous draft of this GLEP allowed news items to be sent to |
|
|
| 362 | <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 |
|
|
| 363 | may arise where this will be necessary (for example, a security update which |
|
|
| 364 | must break backwards compatibility and which cannot be revealed to the public |
|
|
| 365 | before a given date).</p> |
|
|
| 366 | </div> |
|
|
| 367 | <p>News items must only be for <strong>important</strong> changes that may cause serious upgrade |
361 | <p>News items must only be for <strong>important</strong> changes that may cause serious upgrade |
| 368 | or compatibility problems. Ordinary upgrade messages and non-critical news items |
362 | or compatibility problems. Ordinary upgrade messages and non-critical news items |
| 369 | should remain in <tt class="docutils literal"><span class="pre">einfo</span></tt> notices. The importance of the message to its |
363 | should remain in <tt class="docutils literal"><span class="pre">einfo</span></tt> notices. The importance of the message to its |
| 370 | intended audience should be justified with the proposal.</p> |
364 | intended audience should be justified with the proposal.</p> |
| 371 | <div class="important"> |
365 | <div class="important"> |
| … | |
… | |
| 394 | <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 |
388 | <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 |
| 395 | the current year and <tt class="docutils literal"><span class="pre">mm</span></tt> is the current month number (01 for January through |
389 | the current year and <tt class="docutils literal"><span class="pre">mm</span></tt> is the current month number (01 for January through |
| 396 | 12 for December). This separation will help keep news items more manageable.</p> |
390 | 12 for December). This separation will help keep news items more manageable.</p> |
| 397 | <p>The contents of this repository will automatically be merged with the main rsync |
391 | <p>The contents of this repository will automatically be merged with the main rsync |
| 398 | tree, placing the items in a <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory. The method used for |
392 | tree, placing the items in a <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory. The method used for |
| 399 | merging these items is beyond the scope of this GLEP — a similar setup is |
393 | merging these items and the frequency at which it will occur is beyond the scope |
| 400 | already used for merging GLSAs into the rsync tree.</p> |
394 | of this GLEP; a similar setup is already used for merging GLSAs into the rsync |
|
|
395 | tree.</p> |
| 401 | <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> |
396 | <p>The main rsync tree will <strong>not</strong> use the <tt class="docutils literal"><span class="pre">yyyy/mm/</span></tt> subdirectory layout. The |
|
|
397 | news item directories will all be immediately under the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> |
|
|
398 | directory.</p> |
| 402 | </div> |
399 | </div> |
| 403 | <div class="section" id="client-side"> |
400 | <div class="section" id="client-side"> |
| 404 | <h3><a class="toc-backref" href="#id35" name="client-side">Client Side</a></h3> |
401 | <h3><a class="toc-backref" href="#id35" name="client-side">Client Side</a></h3> |
| 405 | <p>Whenever relevant unread news items are found, the package manager will create a |
402 | <p>Whenever relevant unread news items are found, the package manager will create a |
| 406 | file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-repoid.unread</span></tt> (if it does not |
403 | file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-${repoid}.unread</span></tt> (if it does not |
| 407 | already exist) and append the news item identifier (eg |
404 | already exist) and append the news item identifier (eg |
| 408 | <tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p> |
405 | <tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p> |
|
|
406 | <p>All news item related files should be root owned and in the <tt class="docutils literal"><span class="pre">portage</span></tt> group |
|
|
407 | with the group write (and, for directories, execute) bits set. News files should |
|
|
408 | be world readable.</p> |
| 409 | <p>Notification that new relevant news items will be displayed via the |
409 | <p>Notification that new relevant news items will be displayed via the |
| 410 | <tt class="docutils literal"><span class="pre">emerge</span></tt> tool in a similar way to the existing "configuration files need |
410 | <tt class="docutils literal"><span class="pre">emerge</span></tt> tool in a similar way to the existing "configuration files need |
| 411 | updating" messages:</p> |
411 | updating" messages:</p> |
| 412 | <pre class="literal-block"> |
412 | <pre class="literal-block"> |
| 413 | * Important: there are 5 unread news items. |
413 | * Important: there are 5 unread news items. |
| … | |
… | |
| 416 | <p>Checks for new news messages should be displayed:</p> |
416 | <p>Checks for new news messages should be displayed:</p> |
| 417 | <ul class="simple"> |
417 | <ul class="simple"> |
| 418 | <li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">sync</span></tt></li> |
418 | <li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">sync</span></tt></li> |
| 419 | <li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">--pretend</span></tt></li> |
419 | <li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">--pretend</span></tt></li> |
| 420 | <li>Before an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre"><target></span></tt> (which may also include a red warning message)</li> |
420 | <li>Before an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre"><target></span></tt> (which may also include a red warning message)</li> |
| 421 | <li>Before an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">--ask</span> <span class="pre"><target></span></tt> sequence</li> |
|
|
| 422 | </ul> |
421 | </ul> |
|
|
422 | <p>The package manager does not need to know how to launch the user's choice of |
|
|
423 | news client. This is consistent with the way configuration file updates are |
|
|
424 | handled.</p> |
| 423 | <p>The package manager may use a timestamp check file to avoid having to process |
425 | <p>The package manager may use a timestamp check file to avoid having to process |
| 424 | news items unnecessarily.</p> |
426 | news items unnecessarily.</p> |
| 425 | <p>The package manager must keep track of news items that have already been added |
427 | <p>The package manager must keep track of news items that have already been added |
| 426 | to the unread list to avoid repeatedly marking a deleted news item. This could |
428 | to the unread list to avoid repeatedly marking a deleted news item. This could |
| 427 | be handled via a <tt class="docutils literal"><span class="pre">news-repoid.skip</span></tt> file containing the IDs of news items that |
429 | be handled via a <tt class="docutils literal"><span class="pre">news-${repoid}.skip</span></tt> file containing the IDs of news items |
| 428 | have already been added to a <tt class="docutils literal"><span class="pre">news-repoid.unread</span></tt> file, but this method is not |
430 | that have already been added to a <tt class="docutils literal"><span class="pre">news-${repoid}.unread</span></tt> file, but this |
| 429 | required by this GLEP.</p> |
431 | method is not required by this GLEP.</p> |
| 430 | <p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to |
432 | <p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to |
| 431 | filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p> |
433 | filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p> |
| 432 | </div> |
434 | </div> |
| 433 | </div> |
435 | </div> |
| 434 | <div class="section" id="news-item-clients"> |
436 | <div class="section" id="news-item-clients"> |
| … | |
… | |
| 482 | <div class="section" id="credits"> |
484 | <div class="section" id="credits"> |
| 483 | <h1><a class="toc-backref" href="#id44" name="credits">Credits</a></h1> |
485 | <h1><a class="toc-backref" href="#id44" name="credits">Credits</a></h1> |
| 484 | <p>The idea behind notifying users of news updates via Portage comes from Stuart |
486 | <p>The idea behind notifying users of news updates via Portage comes from Stuart |
| 485 | Herbert <a class="footnote-reference" href="#stuart-blog" id="id17" name="id17">[15]</a>.</p> |
487 | Herbert <a class="footnote-reference" href="#stuart-blog" id="id17" name="id17">[15]</a>.</p> |
| 486 | <p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, |
488 | <p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, |
| 487 | Brian Harring, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec Warner for |
489 | Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec |
| 488 | input. Some of the ideas presented here are theirs, others go completely |
490 | Warner for input. Some of the ideas presented here are theirs, others go |
| 489 | against their suggestions.</p> |
491 | completely against their suggestions.</p> |
| 490 | </div> |
492 | </div> |
| 491 | <div class="section" id="example-files"> |
493 | <div class="section" id="example-files"> |
| 492 | <h1><a class="toc-backref" href="#id45" name="example-files">Example Files</a></h1> |
494 | <h1><a class="toc-backref" href="#id45" name="example-files">Example Files</a></h1> |
| 493 | <p>TODO Removed until the exact format details are figured out.</p> |
495 | <p>TODO Removed until the exact format details are figured out.</p> |
| 494 | </div> |
496 | </div> |
| … | |
… | |
| 618 | |
620 | |
| 619 | </div> |
621 | </div> |
| 620 | <div class="footer"> |
622 | <div class="footer"> |
| 621 | <hr class="footer" /> |
623 | <hr class="footer" /> |
| 622 | <a class="reference" href="glep-0042.txt">View document source</a>. |
624 | <a class="reference" href="glep-0042.txt">View document source</a>. |
| 623 | Generated on: 2005-12-18 04:15 UTC. |
625 | Generated on: 2006-01-05 15:09 UTC. |
| 624 | 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. |
626 | Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
| 625 | |
627 | |
| 626 | </div> |
628 | </div> |
| 627 | </body> |
629 | </body> |
| 628 | </html> |
630 | </html> |