| 1 | GLEP: 42 |
1 | GLEP: 42 |
| 2 | Title: Critical News Reporting |
2 | Title: Critical News Reporting |
| 3 | Version: $Revision: 1.7 $ |
3 | Version: $Revision: 1.14 $ |
| 4 | Author: Ciaran McCreesh <ciaranm@gentoo.org> |
4 | Author: Ciaran McCreesh <ciaranm@gentoo.org>, |
|
|
5 | Stephen Bennett <spb@gentoo.org>, |
|
|
6 | Zach Medico <zmedico@gentoo.org> |
| 5 | Last-Modified: $Date: 2006/01/05 15:10:45 $ |
7 | Last-Modified: $Date: 2010/02/22 11:38:26 $ |
| 6 | Status: Draft |
8 | Status: Final |
| 7 | Type: Standards Track |
9 | Type: Standards Track |
| 8 | Content-Type: text/x-rst |
10 | Content-Type: text/x-rst |
| 9 | Created: 31-Oct-2005 |
11 | Created: 31-Oct-2005 |
| 10 | Post-History: 1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005, 18-Dec-2005, 5-Jan-2006 |
12 | Post-History: 1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005, 18-Dec-2005, 5-Jan-2006, 2-Mar-2006, 6-Mar-2006, 12-Jun-2006, 5-Sep-2006 |
| 11 | |
13 | |
| 12 | Abstract |
14 | Abstract |
| 13 | ======== |
15 | ======== |
| 14 | |
16 | |
| 15 | This GLEP proposes a new way of informing users about important updates and news |
17 | This GLEP proposes a new way of informing users about important updates and news |
| 16 | regarding tree-related items. |
18 | related to the tree. |
| 17 | |
19 | |
| 18 | Motivation |
20 | Motivation |
| 19 | ========== |
21 | ========== |
| 20 | |
22 | |
| 21 | Although most package updates are clean and require little user action, |
23 | Although most package updates are clean and require little user action, |
| 22 | occasionally an upgrade requires user intervention during the upgrade process. |
24 | occasionally an upgrade requires user intervention. Recent examples of the |
| 23 | Recent examples of the latter include the ``gcc-3.4`` stabilisation on ``x86`` |
25 | latter include the ``gcc-3.4`` stabilisation on ``x86`` and the ``mysql-4.1`` |
| 24 | and the ``mysql-4.1`` database format changes. |
26 | database format changes. |
| 25 | |
27 | |
| 26 | There are currently several ways of delivering important news items to our |
28 | There are currently several ways of delivering important news items to our |
| 27 | users, none of them particularly effective: |
29 | users, none of them particularly effective: |
| 28 | |
30 | |
| 29 | * Gentoo Weekly News |
31 | * Gentoo Weekly News |
| … | |
… | |
| 32 | * The main Gentoo website |
34 | * The main Gentoo website |
| 33 | * RSS feeds of Gentoo news |
35 | * RSS feeds of Gentoo news |
| 34 | * ``einfo`` and ``ewarn`` messages in ``pkg_setup`` or ``pkg_postinst`` |
36 | * ``einfo`` and ``ewarn`` messages in ``pkg_setup`` or ``pkg_postinst`` |
| 35 | |
37 | |
| 36 | A more reliable way of getting news of critical updates out to users is required |
38 | A more reliable way of getting news of critical updates out to users is required |
| 37 | to avoid repeats of the various recent upgrade debacles. This GLEP proposes a |
39 | to avoid repeats of various prior upgrade debacles. This GLEP proposes a |
| 38 | solution based around pushing news items out to the user via the ``rsync`` tree. |
40 | solution based around pushing news items out to the user via the ``rsync`` tree. |
| 39 | |
41 | |
| 40 | .. Important:: This GLEP does not seek to replace or modify ``einfo`` messages |
42 | .. Important:: This GLEP does not seek to replace or modify ``einfo`` messages |
| 41 | which are displayed post-install. That is a separate issue which is handled |
43 | which are displayed post-install. That is a separate issue which is handled |
| 42 | by ``elog`` [#bug-11359]_. |
44 | by ``elog`` [#bug-11359]_. |
| … | |
… | |
| 52 | given ample warning to plan difficult upgrades and changes, rather than only |
54 | given ample warning to plan difficult upgrades and changes, rather than only |
| 53 | being told just before action is necessary. |
55 | being told just before action is necessary. |
| 54 | |
56 | |
| 55 | No user subscription required |
57 | No user subscription required |
| 56 | It has already been demonstrated [#forums-apache2]_ that many users do not |
58 | It has already been demonstrated [#forums-apache2]_ that many users do not |
| 57 | read the ``gentoo-announce`` mailing list or ``RSS`` feeds. A solution which |
59 | read the ``gentoo-announce`` mailing list or ``RSS`` feeds. A solution that |
| 58 | requires subscription has no advantage over current methods. |
60 | requires subscription has no advantage over current methods. |
| 59 | |
61 | |
| 60 | No user monitoring required |
62 | No user monitoring required |
| 61 | It has already been demonstrated [#forums-apache2]_ that many users do not |
63 | It has already been demonstrated [#forums-apache2]_ that many users do not |
| 62 | read news items posted to the Gentoo website, or do not read news items |
64 | read news items posted to the Gentoo website, or do not read news items |
| … | |
… | |
| 156 | |
158 | |
| 157 | * Portage must extend ``portageq has_version`` to support restrictions to a |
159 | * Portage must extend ``portageq has_version`` to support restrictions to a |
| 158 | given repository ID. |
160 | given repository ID. |
| 159 | |
161 | |
| 160 | * Portage must extend ``portageq`` to implement a command which returns whether |
162 | * Portage must extend ``portageq`` to implement a command which returns whether |
| 161 | or not the profile used for a given repository ID matches a certain base path |
163 | or not the profile used for a given repository ID is exactly the given profile |
| 162 | (e.g. ``portageq profile_used default-linux/sparc/sparc64/2004.3 gentoo-x86``). |
164 | (e.g. ``portageq profile_used default-linux/sparc/sparc64/2004.3 |
|
|
165 | gentoo-x86``). |
| 163 | |
166 | |
| 164 | These extensions are assumed during the following specification. |
167 | These extensions are assumed during the following specification. |
| 165 | |
168 | |
| 166 | News Item Identities |
169 | News Item Identities |
| 167 | -------------------- |
170 | -------------------- |
| … | |
… | |
| 181 | |
184 | |
| 182 | The directory will contain a file named ``yyyy-mm-dd-short-name.en.txt``, which |
185 | The directory will contain a file named ``yyyy-mm-dd-short-name.en.txt``, which |
| 183 | contains the text of the news item, in English, in the format described below. |
186 | contains the text of the news item, in English, in the format described below. |
| 184 | |
187 | |
| 185 | If a news item is translated, other files named ``yyyy-mm-dd-short-name.xx.txt`` |
188 | If a news item is translated, other files named ``yyyy-mm-dd-short-name.xx.txt`` |
| 186 | (where ``xx`` is the ISO 639 [#iso-639]_ two letter country code) will also be |
189 | (where ``xx`` is the ISO 639 [#iso-639]_ two letter country code, and the date |
| 187 | provided. However, only the English version of a news item is authoritative. |
190 | remains the same as the original news item) will also be provided. However, only |
| 188 | This anglocentricity is justified by precedent [#glep-34]_. |
191 | the English version of a news item is authoritative. This anglocentricity is |
|
|
192 | justified by precedent [#glep-34]_. |
| 189 | |
193 | |
| 190 | News Item Files |
194 | News Item Files |
| 191 | --------------- |
195 | --------------- |
| 192 | |
196 | |
| 193 | A news item file is a text file, encoded using UTF-8 [#rfc-3629]_ for |
197 | A news item file is a text file, encoded using UTF-8 [#rfc-3629]_ for |
| … | |
… | |
| 226 | ``Content-Type:`` |
230 | ``Content-Type:`` |
| 227 | Must be ``text/plain``. Mandatory. |
231 | Must be ``text/plain``. Mandatory. |
| 228 | |
232 | |
| 229 | ``Posted:`` |
233 | ``Posted:`` |
| 230 | Date of posting, in ``yyyy-mm-dd`` format (e.g. 2005-12-18) for |
234 | Date of posting, in ``yyyy-mm-dd`` format (e.g. 2005-12-18) for |
| 231 | compatibility with GLEP 45 [#glep-45]_. Mandatory. |
235 | compatibility with GLEP 45 [#glep-45]_. Translations should use the date |
|
|
236 | of the original news item. Mandatory. |
| 232 | |
237 | |
| 233 | ``Revision:`` |
238 | ``Revision:`` |
| 234 | Initially 1. Should be incremented every time a change is made to the news |
239 | Initially 1. Should be incremented every time a change is made to the news |
| 235 | item. Changes that require a re-read of the news item (i.e., most changes |
240 | item. Changes that require a re-read of the news item (i.e., most changes |
| 236 | that are not spelling or formatting related) should instead use a new news |
241 | that are not spelling or formatting related) should instead use a new news |
| … | |
… | |
| 253 | A keyword [#glep-22]_ name, for example ``mips`` or ``x86-fbsd``. If the |
258 | A keyword [#glep-22]_ name, for example ``mips`` or ``x86-fbsd``. If the |
| 254 | user is on the keyword in question, the news item should be displayed. |
259 | user is on the keyword in question, the news item should be displayed. |
| 255 | |
260 | |
| 256 | ``Display-If-Profile:`` |
261 | ``Display-If-Profile:`` |
| 257 | A profile path, for example ``default-linux/sparc/sparc64/server``. If the |
262 | A profile path, for example ``default-linux/sparc/sparc64/server``. If the |
| 258 | user is using the exact profile in question, or a subprofile of this |
263 | user is using the exact profile in question, the news item should be |
| 259 | profile, the news item should be displayed. This header may be used to |
264 | displayed. This header may be used to replace ``deprecated`` files in the |
| 260 | replace ``deprecated`` files in the future. |
265 | future. |
| 261 | |
266 | |
| 262 | .. Note:: When performing package moves, developers must also update any |
267 | .. Note:: When performing package moves, developers must also update any |
| 263 | relevant ``Display-If-Installed`` headers in news files. |
268 | relevant ``Display-If-Installed`` headers in news files. |
| 264 | |
269 | |
| 265 | The algorithm used to determine whether a news item is 'relevant' is as |
270 | The algorithm used to determine whether a news item is 'relevant' is as |
| … | |
… | |
| 346 | |
351 | |
| 347 | .. Note:: A previous draft of this GLEP instead used the main ``gentoo-x86`` |
352 | .. Note:: A previous draft of this GLEP instead used the main ``gentoo-x86`` |
| 348 | tree. This was changed following advice from Infrastructure |
353 | tree. This was changed following advice from Infrastructure |
| 349 | [#ramereth-repo]_. Both solutions have the same end result. |
354 | [#ramereth-repo]_. Both solutions have the same end result. |
| 350 | |
355 | |
| 351 | This repository will contain directories named ``yyyy/mm/``, where ``yyyy`` is |
356 | This repository will contain directories named ``yyyy/``, where ``yyyy`` is |
| 352 | the current year and ``mm`` is the current month number (01 for January through |
|
|
| 353 | 12 for December). This separation will help keep news items more manageable. |
357 | the current year. This separation will help keep news items more manageable. |
| 354 | |
358 | |
| 355 | The contents of this repository will automatically be merged with the main rsync |
359 | The contents of this repository will automatically be merged with the main rsync |
| 356 | tree, placing the items in a ``metadata/news/`` directory. The method used for |
360 | tree, placing the items in a ``metadata/news/`` directory. The method used for |
| 357 | merging these items and the frequency at which it will occur is beyond the scope |
361 | merging these items and the frequency at which it will occur is beyond the scope |
| 358 | of this GLEP; a similar setup is already used for merging GLSAs into the rsync |
362 | of this GLEP; a similar setup is already used for merging GLSAs into the rsync |
| 359 | tree. |
363 | tree. |
| 360 | |
364 | |
| 361 | The main rsync tree will **not** use the ``yyyy/mm/`` subdirectory layout. The |
365 | The main rsync tree will **not** use the ``yyyy/`` subdirectory layout. The |
| 362 | news item directories will all be immediately under the ``metadata/news/`` |
366 | news item directories will all be immediately under the ``metadata/news/`` |
| 363 | directory. |
367 | directory. |
| 364 | |
368 | |
| 365 | Client Side |
369 | Client Side |
| 366 | ''''''''''' |
370 | ''''''''''' |
| … | |
… | |
| 410 | |
414 | |
| 411 | Once a news item is marked for reading, third party tools (or traditional core |
415 | Once a news item is marked for reading, third party tools (or traditional core |
| 412 | Unix tools) can be used to display and view the news files. |
416 | Unix tools) can be used to display and view the news files. |
| 413 | |
417 | |
| 414 | When a news item is read, its name should be removed from the |
418 | When a news item is read, its name should be removed from the |
| 415 | ``news-repoid.unread`` file. If a news client acts as an interactive reader |
419 | ``news-${repoid}.unread`` file. If a news client acts as an interactive reader |
| 416 | rather than a gateway, it should then add the name to a ``news-repoid.read`` |
420 | rather than a gateway, it should then add the name to a ``news-${repoid}.read`` |
| 417 | file in the same directory with the same file format. |
421 | file in the same directory with the same file format. |
| 418 | |
422 | |
| 419 | An ``eselect`` [#eselect]_ module shall be created as the 'suggested' display |
423 | An ``eselect`` [#eselect]_ module shall be created as the 'suggested' display |
| 420 | tool; other display tools (for example, a news to email forwarder, which would |
424 | tool; other display tools (for example, a news to email forwarder, which would |
| 421 | be ideal for users who sync on a ``cron``) are left as options for those who |
425 | be ideal for users who sync on a ``cron``) are left as options for those who |
| … | |
… | |
| 445 | the ``news/`` directory. |
449 | the ``news/`` directory. |
| 446 | |
450 | |
| 447 | Reference Implementation |
451 | Reference Implementation |
| 448 | ======================== |
452 | ======================== |
| 449 | |
453 | |
| 450 | Portage Code |
454 | A reference implementation of the required package manager support can be found |
| 451 | ------------ |
455 | in Paludis [#paludis]_, along with a reference newsreader implemented as an |
| 452 | |
456 | eselect module [#eselect-news]_. |
| 453 | TODO |
|
|
| 454 | |
|
|
| 455 | Simple ``eselect`` News Client |
|
|
| 456 | ------------------------------ |
|
|
| 457 | |
|
|
| 458 | TODO Removed until the exact format details are figured out. |
|
|
| 459 | |
|
|
| 460 | Simple News to Mail Forwarder |
|
|
| 461 | ----------------------------- |
|
|
| 462 | |
|
|
| 463 | TODO Removed until the exact format details are figured out. |
|
|
| 464 | |
457 | |
| 465 | Credits |
458 | Credits |
| 466 | ======= |
459 | ======= |
| 467 | |
460 | |
| 468 | The idea behind notifying users of news updates via Portage comes from Stuart |
461 | The idea behind notifying users of news updates via Portage comes from Stuart |
| … | |
… | |
| 474 | completely against their suggestions. |
467 | completely against their suggestions. |
| 475 | |
468 | |
| 476 | Example Files |
469 | Example Files |
| 477 | ============= |
470 | ============= |
| 478 | |
471 | |
| 479 | TODO Removed until the exact format details are figured out. |
472 | `example-news-item.txt <glep-0042-extras/example-news-item.txt>`_ |
|
|
473 | An example news item. |
| 480 | |
474 | |
| 481 | References |
475 | References |
| 482 | ========== |
476 | ========== |
| 483 | |
477 | |
| 484 | .. [#bug-11359] Bugzilla Bug 11359 |
478 | .. [#bug-11359] Bugzilla Bug 11359 |
| … | |
… | |
| 511 | Albertson, |
505 | Albertson, |
| 512 | http://marc.theaimsgroup.com/?l=gentoo-dev&m=113111585907703&w=2 |
506 | http://marc.theaimsgroup.com/?l=gentoo-dev&m=113111585907703&w=2 |
| 513 | .. [#rfc-822] RFC 822 "Standard for the format of ARPA Internet text messages" |
507 | .. [#rfc-822] RFC 822 "Standard for the format of ARPA Internet text messages" |
| 514 | .. [#rfc-3629] RFC 3629: "UTF-8, a transformation format of ISO 10646" |
508 | .. [#rfc-3629] RFC 3629: "UTF-8, a transformation format of ISO 10646" |
| 515 | http://www.ietf.org/rfc/rfc3629.txt |
509 | http://www.ietf.org/rfc/rfc3629.txt |
|
|
510 | .. [#paludis] Paludis homepage, http://paludis.berlios.de |
|
|
511 | .. [#eselect-news] news.eselect, http://svn.berlios.de/svnroot/repos/paludis/trunk/eselect/news.eselect |
| 516 | .. [#stuart-blog] "Favouring an automatic news mechanism", Stuart Herbert, |
512 | .. [#stuart-blog] "Favouring an automatic news mechanism", Stuart Herbert, |
| 517 | http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism |
513 | http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism |
| 518 | |
514 | |
| 519 | Copyright |
515 | Copyright |
| 520 | ========= |
516 | ========= |
Parent Directory
| 
Revision Log
| 
Patch