--- xml/htdocs/proj/en/glep/glep-0042.html 2006/02/13 16:26:47 1.8 +++ xml/htdocs/proj/en/glep/glep-0042.html 2006/03/02 00:19:39 1.9 @@ -10,7 +10,250 @@ GLEP 42 -- Critical News Reporting - + - + - + @@ -46,7 +289,7 @@ - + @@ -80,29 +323,24 @@
  • Integration with Existing Systems
  • Backwards Compatibility
  • -
  • Reference Implementation -
  • -
  • Credits
  • -
  • Example Files
  • -
  • References
  • -
  • Copyright
  • +
  • Reference Implementation
  • +
  • Credits
  • +
  • Example Files
  • +
  • References
  • +
  • Copyright
  • Abstract

    This GLEP proposes a new way of informing users about important updates and news -regarding tree-related items.

    +related to the tree.

    Motivation

    Although most package updates are clean and require little user action, -occasionally an upgrade requires user intervention during the upgrade process. -Recent examples of the latter include the gcc-3.4 stabilisation on x86 -and the mysql-4.1 database format changes.

    +occasionally an upgrade requires user intervention. Recent examples of the +latter include the gcc-3.4 stabilisation on x86 and the mysql-4.1 +database format changes.

    There are currently several ways of delivering important news items to our users, none of them particularly effective:

    A more reliable way of getting news of critical updates out to users is required -to avoid repeats of the various recent upgrade debacles. This GLEP proposes a +to avoid repeats of various prior upgrade debacles. This GLEP proposes a solution based around pushing news items out to the user via the rsync tree.

    Important

    @@ -134,7 +372,7 @@ being told just before action is necessary.
    No user subscription required
    It has already been demonstrated [5] that many users do not -read the gentoo-announce mailing list or RSS feeds. A solution which +read the gentoo-announce mailing list or RSS feeds. A solution that requires subscription has no advantage over current methods.
    No user monitoring required
    It has already been demonstrated [5] that many users do not @@ -240,9 +478,10 @@

    The directory will contain a file named yyyy-mm-dd-short-name.en.txt, which contains the text of the news item, in English, in the format described below.

    If a news item is translated, other files named yyyy-mm-dd-short-name.xx.txt -(where xx is the ISO 639 [11] two letter country code) will also be -provided. However, only the English version of a news item is authoritative. -This anglocentricity is justified by precedent [8].

    +(where xx is the ISO 639 [11] two letter country code, and the date +remains the same as the original news item) will also be provided. However, only +the English version of a news item is authoritative. This anglocentricity is +justified by precedent [8].

    News Item Files

    @@ -276,7 +515,8 @@
    Must be text/plain. Mandatory.
    Posted:
    Date of posting, in yyyy-mm-dd format (e.g. 2005-12-18) for -compatibility with GLEP 45 [10]. Mandatory.
    +compatibility with GLEP 45 [10]. Translations should use the date +of the original news item. Mandatory.
    Revision:
    Initially 1. Should be incremented every time a change is made to the news item. Changes that require a re-read of the news item (i.e., most changes @@ -438,8 +678,8 @@

    Once a news item is marked for reading, third party tools (or traditional core Unix tools) can be used to display and view the news files.

    When a news item is read, its name should be removed from the -news-repoid.unread file. If a news client acts as an interactive reader -rather than a gateway, it should then add the name to a news-repoid.read +news-${repoid}.unread file. If a news client acts as an interactive reader +rather than a gateway, it should then add the name to a news-${repoid}.read file in the same directory with the same file format.

    An eselect [3] module shall be created as the 'suggested' display tool; other display tools (for example, a news to email forwarder, which would @@ -468,21 +708,10 @@

    Reference Implementation

    -
    -

    Portage Code

    TODO

    -

    Simple eselect News Client

    -

    TODO Removed until the exact format details are figured out.

    -
    -
    -

    Simple News to Mail Forwarder

    -

    TODO Removed until the exact format details are figured out.

    -
    -
    -
    -

    Credits

    +

    Credits

    The idea behind notifying users of news updates via Portage comes from Stuart Herbert [15].

    Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, @@ -491,11 +720,14 @@ completely against their suggestions.

    -

    Example Files

    -

    TODO Removed until the exact format details are figured out.

    +

    Example Files

    +
    +
    example-news-item.txt
    +
    An example news item.
    +
    -

    References

    +

    References

    @@ -613,7 +845,7 @@
    -

    Copyright

    +

    Copyright

    This document has been placed in the public domain.

    @@ -622,7 +854,7 @@