--- xml/htdocs/proj/en/glep/glep-0042.html 2005/12/18 04:16:44 1.6 +++ xml/htdocs/proj/en/glep/glep-0042.html 2006/01/05 15:10:45 1.7 @@ -32,11 +32,11 @@ Title:Critical News Reporting -Version:$Revision: 1.6 $ +Version:$Revision: 1.7 $ Author:Ciaran McCreesh <ciaranm at gentoo.org> -Last-Modified:$Date: 2005/12/18 04:16:44 $ +Last-Modified:$Date: 2006/01/05 15:10:45 $ Status:Draft @@ -46,7 +46,7 @@ Created:31-Oct-2005 -Post-History:1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005, 18-Dec-2005 +Post-History:1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005, 18-Dec-2005, 5-Jan-2006 @@ -205,13 +205,11 @@

Required Portage Enhancements

The following extensions to Portage are required:

-

TODO: ferringb wants spaces added to the first item on the list. I don't, -because it makes repo id -> filename mappings nasty.

News Item Directories

@@ -251,10 +249,13 @@

A news item file is a text file, encoded using UTF-8 [14] for compatibility with and for the same reasons as existing Gentoo documentation [2] and the tree [7].

-

News items should be signed with a detached GPG signature:

+

News items must be signed with a detached GPG signature.:

 gpg --armour --detach-sign ????-??-??-*.??.txt
 
+

This GLEP does not specify the type or strength of signature to be used, nor +does it discuss how, if at all, a centralised keychain will be provided. These +issues should be handled as part of the signing policy discussions.

A news item file's content will consist of an RFC 822 style header [13] followed by the main body of the message as plain text. This GLEP defines various optional and mandatory headers. Future GLEPs may propose new headers — @@ -277,9 +278,10 @@

Date of posting, in yyyy-mm-dd format (e.g. 2005-12-18) for compatibility with GLEP 45 [10]. Mandatory.
Revision:
-
Initially 1. Incremented every time a non-trivial change is made. Changes -which require a re-read of the news item should instead use a new news item -file. Mandatory.
+
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 +that are not spelling or formatting related) should instead use a new news +item. Mandatory.
News-Item-Format:
Must be 1.0. Future revisions to the format may increment the minor number for backwards-compatible changes, or the major number for major @@ -288,10 +290,10 @@

The following headers are used for filtering:

Display-If-Installed:
-
A dependency atom or simple package name (for example, -<dev-lang/php-5_alpha or net-www/apache). If the user has the -package specified installed from the repository from which the news item was -obtained, the news item should be displayed.
+
A dependency atom (for example, <dev-lang/php-5_alpha or +net-www/apache). If the user has the package specified installed from +the repository from which the news item was obtained, the news item should +be displayed.
Display-If-Keyword:
A keyword [6] name, for example mips or x86-fbsd. If the user is on the keyword in question, the news item should be displayed.
@@ -336,7 +338,7 @@ guide). However, the main body of the news item should be descriptive and not simply a "read this link" text. It is assumed that the user will have access to a web browser somewhere, but not necessarily on the box which is being -administrated — this will be the case on may servers and routers, for example.

+administrated — this will be the case on many servers and routers, for example.

Example News Item

@@ -356,14 +358,6 @@ (exceptions may be made in exceptional circumstances). Any complaints — for example regarding wording, clarity or accuracy — must be addressed before the news item goes live.

-
-

Note

-

A previous draft of this GLEP allowed news items to be sent to -gentoo-core instead of gentoo-dev. It is possible that a situation -may arise where this will be necessary (for example, a security update which -must break backwards compatibility and which cannot be revealed to the public -before a given date).

-

News items must only be for important changes that may cause serious upgrade or compatibility problems. Ordinary upgrade messages and non-critical news items should remain in einfo notices. The importance of the message to its @@ -396,16 +390,22 @@ 12 for December). This separation will help keep news items more manageable.

The contents of this repository will automatically be merged with the main rsync tree, placing the items in a metadata/news/ directory. The method used for -merging these items is beyond the scope of this GLEP — a similar setup is -already used for merging GLSAs into the rsync tree.

-

The main rsync tree will not use the yyyy/mm/ subdirectory layout.

+merging these items and the frequency at which it will occur is beyond the scope +of this GLEP; a similar setup is already used for merging GLSAs into the rsync +tree.

+

The main rsync tree will not use the yyyy/mm/ subdirectory layout. The +news item directories will all be immediately under the metadata/news/ +directory.

Client Side

Whenever relevant unread news items are found, the package manager will create a -file named /var/lib/gentoo/news/news-repoid.unread (if it does not +file named /var/lib/gentoo/news/news-${repoid}.unread (if it does not already exist) and append the news item identifier (eg 2005-11-01-yoursql-updates) on a new line.

+

All news item related files should be root owned and in the portage group +with the group write (and, for directories, execute) bits set. News files should +be world readable.

Notification that new relevant news items will be displayed via the emerge tool in a similar way to the existing "configuration files need updating" messages:

@@ -418,15 +418,17 @@
  • After an emerge sync
  • After an emerge --pretend
  • Before an emerge <target> (which may also include a red warning message)
  • -
  • Before an emerge --ask <target> sequence
  • +

    The package manager does not need to know how to launch the user's choice of +news client. This is consistent with the way configuration file updates are +handled.

    The package manager may use a timestamp check file to avoid having to process news items unnecessarily.

    The package manager must keep track of news items that have already been added to the unread list to avoid repeatedly marking a deleted news item. This could -be handled via a news-repoid.skip file containing the IDs of news items that -have already been added to a news-repoid.unread file, but this method is not -required by this GLEP.

    +be handled via a news-${repoid}.skip file containing the IDs of news items +that have already been added to a news-${repoid}.unread file, but this +method is not required by this GLEP.

    Users who really don't care about news items can use rsync_excludes to filter out the metadata/news/ directory.

    @@ -484,9 +486,9 @@

    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, -Brian Harring, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec Warner for -input. Some of the ideas presented here are theirs, others go completely -against their suggestions.

    +Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec +Warner for input. Some of the ideas presented here are theirs, others go +completely against their suggestions.

    Example Files

    @@ -620,7 +622,7 @@