/[gentoo]/xml/htdocs/proj/en/glep/glep-0042.txt
Gentoo

Diff of /xml/htdocs/proj/en/glep/glep-0042.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.8 Revision 1.14
1GLEP: 42 1GLEP: 42
2Title: Critical News Reporting 2Title: Critical News Reporting
3Version: $Revision: 1.8 $ 3Version: $Revision: 1.14 $
4Author: Ciaran McCreesh <ciaranm@gentoo.org> 4Author: Ciaran McCreesh <ciaranm@gentoo.org>,
5 Stephen Bennett <spb@gentoo.org>,
6 Zach Medico <zmedico@gentoo.org>
5Last-Modified: $Date: 2006/03/02 00:19:39 $ 7Last-Modified: $Date: 2010/02/22 11:38:26 $
6Status: Draft 8Status: Final
7Type: Standards Track 9Type: Standards Track
8Content-Type: text/x-rst 10Content-Type: text/x-rst
9Created: 31-Oct-2005 11Created: 31-Oct-2005
10Post-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 12Post-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
12Abstract 14Abstract
13======== 15========
14 16
15This GLEP proposes a new way of informing users about important updates and news 17This GLEP proposes a new way of informing users about important updates and news
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
164These extensions are assumed during the following specification. 167These extensions are assumed during the following specification.
165 168
166News Item Identities 169News Item Identities
167-------------------- 170--------------------
255 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
256 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.
257 260
258``Display-If-Profile:`` 261``Display-If-Profile:``
259 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
260 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
261 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
262 replace ``deprecated`` files in the future. 265 future.
263 266
264.. Note:: When performing package moves, developers must also update any 267.. Note:: When performing package moves, developers must also update any
265 relevant ``Display-If-Installed`` headers in news files. 268 relevant ``Display-If-Installed`` headers in news files.
266 269
267The algorithm used to determine whether a news item is 'relevant' is as 270The algorithm used to determine whether a news item is 'relevant' is as
348 351
349.. 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``
350 tree. This was changed following advice from Infrastructure 353 tree. This was changed following advice from Infrastructure
351 [#ramereth-repo]_. Both solutions have the same end result. 354 [#ramereth-repo]_. Both solutions have the same end result.
352 355
353This repository will contain directories named ``yyyy/mm/``, where ``yyyy`` is 356This repository will contain directories named ``yyyy/``, where ``yyyy`` is
354the current year and ``mm`` is the current month number (01 for January through
35512 for December). This separation will help keep news items more manageable. 357the current year. This separation will help keep news items more manageable.
356 358
357The contents of this repository will automatically be merged with the main rsync 359The contents of this repository will automatically be merged with the main rsync
358tree, placing the items in a ``metadata/news/`` directory. The method used for 360tree, placing the items in a ``metadata/news/`` directory. The method used for
359merging these items and the frequency at which it will occur is beyond the scope 361merging these items and the frequency at which it will occur is beyond the scope
360of this GLEP; a similar setup is already used for merging GLSAs into the rsync 362of this GLEP; a similar setup is already used for merging GLSAs into the rsync
361tree. 363tree.
362 364
363The main rsync tree will **not** use the ``yyyy/mm/`` subdirectory layout. The 365The main rsync tree will **not** use the ``yyyy/`` subdirectory layout. The
364news item directories will all be immediately under the ``metadata/news/`` 366news item directories will all be immediately under the ``metadata/news/``
365directory. 367directory.
366 368
367Client Side 369Client Side
368''''''''''' 370'''''''''''
447the ``news/`` directory. 449the ``news/`` directory.
448 450
449Reference Implementation 451Reference Implementation
450======================== 452========================
451 453
452TODO 454A reference implementation of the required package manager support can be found
455in Paludis [#paludis]_, along with a reference newsreader implemented as an
456eselect module [#eselect-news]_.
453 457
454Credits 458Credits
455======= 459=======
456 460
457The idea behind notifying users of news updates via Portage comes from Stuart 461The idea behind notifying users of news updates via Portage comes from Stuart
501 Albertson, 505 Albertson,
502 http://marc.theaimsgroup.com/?l=gentoo-dev&m=113111585907703&w=2 506 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" 507.. [#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" 508.. [#rfc-3629] RFC 3629: "UTF-8, a transformation format of ISO 10646"
505 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
506.. [#stuart-blog] "Favouring an automatic news mechanism", Stuart Herbert, 512.. [#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 513 http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism
508 514
509Copyright 515Copyright
510========= 516=========

Legend:
Removed from v.1.8  
changed lines
  Added in v.1.14

  ViewVC Help
Powered by ViewVC 1.1.20