| 1 | GLEP: 42 |
1 | GLEP: 42 |
| 2 | Title: Critical News Reporting |
2 | Title: Critical News Reporting |
| 3 | Version: $Revision: 1.8 $ |
3 | Version: $Revision: 1.10 $ |
| 4 | Author: Ciaran McCreesh <ciaranm@gentoo.org> |
4 | Author: Ciaran McCreesh <ciaranm@gentoo.org> |
| 5 | Last-Modified: $Date: 2006/03/02 00:19:39 $ |
5 | Last-Modified: $Date: 2006/06/12 22:03:07 $ |
| 6 | Status: Draft |
6 | Status: Draft |
| 7 | Type: Standards Track |
7 | Type: Standards Track |
| 8 | Content-Type: text/x-rst |
8 | Content-Type: text/x-rst |
| 9 | Created: 31-Oct-2005 |
9 | 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, 2-Mar-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, 2-Mar-2006, 6-Mar-2006, 12-Jun-2006 |
| 11 | |
11 | |
| 12 | Abstract |
12 | Abstract |
| 13 | ======== |
13 | ======== |
| 14 | |
14 | |
| 15 | This GLEP proposes a new way of informing users about important updates and news |
15 | This GLEP proposes a new way of informing users about important updates and news |
| … | |
… | |
| 156 | |
156 | |
| 157 | * Portage must extend ``portageq has_version`` to support restrictions to a |
157 | * Portage must extend ``portageq has_version`` to support restrictions to a |
| 158 | given repository ID. |
158 | given repository ID. |
| 159 | |
159 | |
| 160 | * Portage must extend ``portageq`` to implement a command which returns whether |
160 | * 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 |
161 | 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``). |
162 | (e.g. ``portageq profile_used default-linux/sparc/sparc64/2004.3 |
|
|
163 | gentoo-x86``). |
| 163 | |
164 | |
| 164 | These extensions are assumed during the following specification. |
165 | These extensions are assumed during the following specification. |
| 165 | |
166 | |
| 166 | News Item Identities |
167 | News Item Identities |
| 167 | -------------------- |
168 | -------------------- |
| … | |
… | |
| 255 | A keyword [#glep-22]_ name, for example ``mips`` or ``x86-fbsd``. If the |
256 | A keyword [#glep-22]_ name, for example ``mips`` or ``x86-fbsd``. If the |
| 256 | user is on the keyword in question, the news item should be displayed. |
257 | user is on the keyword in question, the news item should be displayed. |
| 257 | |
258 | |
| 258 | ``Display-If-Profile:`` |
259 | ``Display-If-Profile:`` |
| 259 | A profile path, for example ``default-linux/sparc/sparc64/server``. If the |
260 | A profile path, for example ``default-linux/sparc/sparc64/server``. If the |
| 260 | user is using the exact profile in question, or a subprofile of this |
261 | user is using the exact profile in question, the news item should be |
| 261 | profile, the news item should be displayed. This header may be used to |
262 | displayed. This header may be used to replace ``deprecated`` files in the |
| 262 | replace ``deprecated`` files in the future. |
263 | future. |
| 263 | |
264 | |
| 264 | .. Note:: When performing package moves, developers must also update any |
265 | .. Note:: When performing package moves, developers must also update any |
| 265 | relevant ``Display-If-Installed`` headers in news files. |
266 | relevant ``Display-If-Installed`` headers in news files. |
| 266 | |
267 | |
| 267 | The algorithm used to determine whether a news item is 'relevant' is as |
268 | The algorithm used to determine whether a news item is 'relevant' is as |
| … | |
… | |
| 447 | the ``news/`` directory. |
448 | the ``news/`` directory. |
| 448 | |
449 | |
| 449 | Reference Implementation |
450 | Reference Implementation |
| 450 | ======================== |
451 | ======================== |
| 451 | |
452 | |
| 452 | TODO |
453 | A reference implementation of the required package manager support can be found |
|
|
454 | in Paludis [#paludis]_, along with a reference newsreader implemented as an |
|
|
455 | eselect module [#eselect-news]_. |
| 453 | |
456 | |
| 454 | Credits |
457 | Credits |
| 455 | ======= |
458 | ======= |
| 456 | |
459 | |
| 457 | The idea behind notifying users of news updates via Portage comes from Stuart |
460 | The idea behind notifying users of news updates via Portage comes from Stuart |
| … | |
… | |
| 501 | Albertson, |
504 | Albertson, |
| 502 | http://marc.theaimsgroup.com/?l=gentoo-dev&m=113111585907703&w=2 |
505 | http://marc.theaimsgroup.com/?l=gentoo-dev&m=113111585907703&w=2 |
| 503 | .. [#rfc-822] RFC 822 "Standard for the format of ARPA Internet text messages" |
506 | .. [#rfc-822] RFC 822 "Standard for the format of ARPA Internet text messages" |
| 504 | .. [#rfc-3629] RFC 3629: "UTF-8, a transformation format of ISO 10646" |
507 | .. [#rfc-3629] RFC 3629: "UTF-8, a transformation format of ISO 10646" |
| 505 | http://www.ietf.org/rfc/rfc3629.txt |
508 | http://www.ietf.org/rfc/rfc3629.txt |
|
|
509 | .. [#paludis] Paludis homepage, http://paludis.berlios.de |
|
|
510 | .. [#eselect-news] news.eselect, http://svn.berlios.de/svnroot/repos/paludis/trunk/eselect/news.eselect |
| 506 | .. [#stuart-blog] "Favouring an automatic news mechanism", Stuart Herbert, |
511 | .. [#stuart-blog] "Favouring an automatic news mechanism", Stuart Herbert, |
| 507 | http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism |
512 | http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism |
| 508 | |
513 | |
| 509 | Copyright |
514 | Copyright |
| 510 | ========= |
515 | ========= |