/[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.6 Revision 1.8
1GLEP: 42 1GLEP: 42
2Title: Critical News Reporting 2Title: Critical News Reporting
3Version: $Revision: 1.6 $ 3Version: $Revision: 1.8 $
4Author: Ciaran McCreesh <ciaranm@gentoo.org> 4Author: Ciaran McCreesh <ciaranm@gentoo.org>
5Last-Modified: $Date: 2005/12/18 04:16:44 $ 5Last-Modified: $Date: 2006/03/02 00:19:39 $
6Status: Draft 6Status: Draft
7Type: Standards Track 7Type: Standards Track
8Content-Type: text/x-rst 8Content-Type: text/x-rst
9Created: 31-Oct-2005 9Created: 31-Oct-2005
10Post-History: 1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005, 13-Dec-2005, 18-Dec-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
11 11
12Abstract 12Abstract
13======== 13========
14 14
15This GLEP proposes a new way of informing users about important updates and news 15This GLEP proposes a new way of informing users about important updates and news
16regarding tree-related items. 16related to the tree.
17 17
18Motivation 18Motivation
19========== 19==========
20 20
21Although most package updates are clean and require little user action, 21Although most package updates are clean and require little user action,
22occasionally an upgrade requires user intervention during the upgrade process. 22occasionally an upgrade requires user intervention. Recent examples of the
23Recent examples of the latter include the ``gcc-3.4`` stabilisation on ``x86`` 23latter include the ``gcc-3.4`` stabilisation on ``x86`` and the ``mysql-4.1``
24and the ``mysql-4.1`` database format changes. 24database format changes.
25 25
26There are currently several ways of delivering important news items to our 26There are currently several ways of delivering important news items to our
27users, none of them particularly effective: 27users, none of them particularly effective:
28 28
29* Gentoo Weekly News 29* Gentoo Weekly News
32* The main Gentoo website 32* The main Gentoo website
33* RSS feeds of Gentoo news 33* RSS feeds of Gentoo news
34* ``einfo`` and ``ewarn`` messages in ``pkg_setup`` or ``pkg_postinst`` 34* ``einfo`` and ``ewarn`` messages in ``pkg_setup`` or ``pkg_postinst``
35 35
36A more reliable way of getting news of critical updates out to users is required 36A more reliable way of getting news of critical updates out to users is required
37to avoid repeats of the various recent upgrade debacles. This GLEP proposes a 37to avoid repeats of various prior upgrade debacles. This GLEP proposes a
38solution based around pushing news items out to the user via the ``rsync`` tree. 38solution based around pushing news items out to the user via the ``rsync`` tree.
39 39
40.. Important:: This GLEP does not seek to replace or modify ``einfo`` messages 40.. 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 41 which are displayed post-install. That is a separate issue which is handled
42 by ``elog`` [#bug-11359]_. 42 by ``elog`` [#bug-11359]_.
52 given ample warning to plan difficult upgrades and changes, rather than only 52 given ample warning to plan difficult upgrades and changes, rather than only
53 being told just before action is necessary. 53 being told just before action is necessary.
54 54
55No user subscription required 55No user subscription required
56 It has already been demonstrated [#forums-apache2]_ that many users do not 56 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 57 read the ``gentoo-announce`` mailing list or ``RSS`` feeds. A solution that
58 requires subscription has no advantage over current methods. 58 requires subscription has no advantage over current methods.
59 59
60No user monitoring required 60No user monitoring required
61 It has already been demonstrated [#forums-apache2]_ that many users do not 61 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 62 read news items posted to the Gentoo website, or do not read news items
139Required Portage Enhancements 139Required Portage Enhancements
140----------------------------- 140-----------------------------
141 141
142The following extensions to Portage are required: 142The following extensions to Portage are required:
143 143
144TODO: ferringb wants spaces added to the first item on the list. I don't,
145because it makes repo id -> filename mappings nasty.
146
147* Every repository (including overlays) will require a unique identifier. It is 144* Every repository (including overlays) will require a unique identifier. It is
148 assumed that an identifier will be a string consisting of characters from 145 assumed that an identifier will be a string consisting of characters from
149 ``a`` to ``z``, ``A`` to ``Z``, ``0`` to ``9``, ``+`` (plus), ``-`` (hyphen), 146 ``a`` to ``z``, ``A`` to ``Z``, ``0`` to ``9``, ``+`` (plus), ``-`` (hyphen)
150 ``:`` (colon) and ``_`` (underscore). 147 ``_`` (underscore).
151 148
152* Portage must provide a way for external programs to obtain a list of all 149* Portage must provide a way for external programs to obtain a list of all
153 repository identifiers for a given system. It is assumed that this will be in 150 repository identifiers for a given system. It is assumed that this will be in
154 the form of a ``portageq`` command (e.g. ``portageq get_repo_ids``). 151 the form of a ``portageq`` command (e.g. ``portageq get_repo_ids``).
155 152
172Each news item will have a unique identifier. This identifier will be in the 169Each news item will have a unique identifier. This identifier will be in the
173form ``yyyy-mm-dd-short-name``, where ``yyyy`` is the year (e.g. ``2005``), 170form ``yyyy-mm-dd-short-name``, where ``yyyy`` is the year (e.g. ``2005``),
174``mm`` is the month (``01`` through ``12``) and dd is the day of the month 171``mm`` is the month (``01`` through ``12``) and dd is the day of the month
175(``01`` through ``31``). The ``short-name`` is a very short name describing the 172(``01`` through ``31``). The ``short-name`` is a very short name describing the
176news item (e.g. ``yoursql-updates``), consisting only of the characters ``a-z``, 173news item (e.g. ``yoursql-updates``), consisting only of the characters ``a-z``,
177``0-9``, ``+`` (plus), ``:`` (colon), ``-`` (hyphen) and ``_`` (underscore). 174``0-9``, ``+`` (plus), ``-`` (hyphen) and ``_`` (underscore).
178 175
179News Item Directories 176News Item Directories
180--------------------- 177---------------------
181 178
182Each news item will be represented by a directory whose name is the same as the 179Each news item will be represented by a directory whose name is the same as the
184 181
185The directory will contain a file named ``yyyy-mm-dd-short-name.en.txt``, which 182The directory will contain a file named ``yyyy-mm-dd-short-name.en.txt``, which
186contains the text of the news item, in English, in the format described below. 183contains the text of the news item, in English, in the format described below.
187 184
188If a news item is translated, other files named ``yyyy-mm-dd-short-name.xx.txt`` 185If a news item is translated, other files named ``yyyy-mm-dd-short-name.xx.txt``
189(where ``xx`` is the ISO 639 [#iso-639]_ two letter country code) will also be 186(where ``xx`` is the ISO 639 [#iso-639]_ two letter country code, and the date
190provided. However, only the English version of a news item is authoritative. 187remains the same as the original news item) will also be provided. However, only
191This anglocentricity is justified by precedent [#glep-34]_. 188the English version of a news item is authoritative. This anglocentricity is
189justified by precedent [#glep-34]_.
192 190
193News Item Files 191News Item Files
194--------------- 192---------------
195 193
196A news item file is a text file, encoded using UTF-8 [#rfc-3629]_ for 194A news item file is a text file, encoded using UTF-8 [#rfc-3629]_ for
197compatibility with and for the same reasons as existing Gentoo documentation 195compatibility with and for the same reasons as existing Gentoo documentation
198[#docs-policy]_ and the tree [#glep-31]_. 196[#docs-policy]_ and the tree [#glep-31]_.
199 197
200News items should be signed with a detached GPG signature: :: 198News items must be signed with a detached GPG signature.::
201 199
202 gpg --armour --detach-sign ????-??-??-*.??.txt 200 gpg --armour --detach-sign ????-??-??-*.??.txt
201
202This GLEP does not specify the type or strength of signature to be used, nor
203does it discuss how, if at all, a centralised keychain will be provided. These
204issues should be handled as part of the signing policy discussions.
203 205
204A news item file's content will consist of an RFC 822 style header [#rfc-822]_ 206A news item file's content will consist of an RFC 822 style header [#rfc-822]_
205followed by the main body of the message as plain text. This GLEP defines 207followed by the main body of the message as plain text. This GLEP defines
206various optional and mandatory headers. Future GLEPs may propose new headers — 208various optional and mandatory headers. Future GLEPs may propose new headers —
207tools handling these news items must ignore any unrecognised header. 209tools handling these news items must ignore any unrecognised header.
225``Content-Type:`` 227``Content-Type:``
226 Must be ``text/plain``. Mandatory. 228 Must be ``text/plain``. Mandatory.
227 229
228``Posted:`` 230``Posted:``
229 Date of posting, in ``yyyy-mm-dd`` format (e.g. 2005-12-18) for 231 Date of posting, in ``yyyy-mm-dd`` format (e.g. 2005-12-18) for
230 compatibility with GLEP 45 [#glep-45]_. Mandatory. 232 compatibility with GLEP 45 [#glep-45]_. Translations should use the date
233 of the original news item. Mandatory.
231 234
232``Revision:`` 235``Revision:``
233 Initially 1. Incremented every time a non-trivial change is made. Changes 236 Initially 1. Should be incremented every time a change is made to the news
234 which require a re-read of the news item should instead use a new news item 237 item. Changes that require a re-read of the news item (i.e., most changes
238 that are not spelling or formatting related) should instead use a new news
235 file. Mandatory. 239 item. Mandatory.
236 240
237``News-Item-Format:`` 241``News-Item-Format:``
238 Must be ``1.0``. Future revisions to the format may increment the minor 242 Must be ``1.0``. Future revisions to the format may increment the minor
239 number for backwards-compatible changes, or the major number for major 243 number for backwards-compatible changes, or the major number for major
240 changes. 244 changes.
241 245
242The following headers are used for filtering: 246The following headers are used for filtering:
243 247
244``Display-If-Installed:`` 248``Display-If-Installed:``
245 A dependency atom or simple package name (for example, 249 A dependency atom (for example, ``<dev-lang/php-5_alpha`` or
246 ``<dev-lang/php-5_alpha`` or ``net-www/apache``). If the user has the 250 ``net-www/apache``). If the user has the package specified installed from
247 package specified installed from the repository from which the news item was 251 the repository from which the news item was obtained, the news item should
248 obtained, the news item should be displayed. 252 be displayed.
249 253
250``Display-If-Keyword:`` 254``Display-If-Keyword:``
251 A keyword [#glep-22]_ name, for example ``mips`` or ``x86-fbsd``. If the 255 A keyword [#glep-22]_ name, for example ``mips`` or ``x86-fbsd``. If the
252 user is on the keyword in question, the news item should be displayed. 256 user is on the keyword in question, the news item should be displayed.
253 257
292 296
293Hyperlinks may be used to refer to further information (for example, an upgrade 297Hyperlinks may be used to refer to further information (for example, an upgrade
294guide). However, the main body of the news item should be descriptive and not 298guide). However, the main body of the news item should be descriptive and not
295simply a "read this link" text. It is assumed that the user will have access to 299simply a "read this link" text. It is assumed that the user will have access to
296a web browser *somewhere*, but not necessarily on the box which is being 300a web browser *somewhere*, but not necessarily on the box which is being
297administrated — this will be the case on may servers and routers, for example. 301administrated — this will be the case on many servers and routers, for example.
298 302
299Example News Item 303Example News Item
300''''''''''''''''' 304'''''''''''''''''
301 305
302`This hypothetical news item`__ could be used for an upgrade to the 306`This hypothetical news item`__ could be used for an upgrade to the
317posted to the ``gentoo-dev`` mailing list and ``Cc:``\ed to ``pr@gentoo.org`` 321posted to the ``gentoo-dev`` mailing list and ``Cc:``\ed to ``pr@gentoo.org``
318(exceptions may be made in exceptional circumstances). Any complaints — for 322(exceptions may be made in exceptional circumstances). Any complaints — for
319example regarding wording, clarity or accuracy — **must** be addressed before 323example regarding wording, clarity or accuracy — **must** be addressed before
320the news item goes live. 324the news item goes live.
321 325
322.. Note:: A previous draft of this GLEP allowed news items to be sent to
323 ``gentoo-core`` instead of ``gentoo-dev``. It is possible that a situation
324 may arise where this will be necessary (for example, a security update which
325 must break backwards compatibility and which cannot be revealed to the public
326 before a given date).
327
328News items must only be for **important** changes that may cause serious upgrade 326News items must only be for **important** changes that may cause serious upgrade
329or compatibility problems. Ordinary upgrade messages and non-critical news items 327or compatibility problems. Ordinary upgrade messages and non-critical news items
330should remain in ``einfo`` notices. The importance of the message to its 328should remain in ``einfo`` notices. The importance of the message to its
331intended audience should be justified with the proposal. 329intended audience should be justified with the proposal.
332 330
356the current year and ``mm`` is the current month number (01 for January through 354the current year and ``mm`` is the current month number (01 for January through
35712 for December). This separation will help keep news items more manageable. 35512 for December). This separation will help keep news items more manageable.
358 356
359The contents of this repository will automatically be merged with the main rsync 357The contents of this repository will automatically be merged with the main rsync
360tree, placing the items in a ``metadata/news/`` directory. The method used for 358tree, placing the items in a ``metadata/news/`` directory. The method used for
361merging these items is beyond the scope of this GLEP — a similar setup is 359merging these items and the frequency at which it will occur is beyond the scope
362already used for merging GLSAs into the rsync tree. 360of this GLEP; a similar setup is already used for merging GLSAs into the rsync
361tree.
363 362
364The main rsync tree will **not** use the ``yyyy/mm/`` subdirectory layout. 363The main rsync tree will **not** use the ``yyyy/mm/`` subdirectory layout. The
364news item directories will all be immediately under the ``metadata/news/``
365directory.
365 366
366Client Side 367Client Side
367''''''''''' 368'''''''''''
368 369
369Whenever relevant unread news items are found, the package manager will create a 370Whenever relevant unread news items are found, the package manager will create a
370file named ``/var/lib/gentoo/news/news-repoid.unread`` (if it does not 371file named ``/var/lib/gentoo/news/news-${repoid}.unread`` (if it does not
371already exist) and append the news item identifier (eg 372already exist) and append the news item identifier (eg
372``2005-11-01-yoursql-updates``) on a new line. 373``2005-11-01-yoursql-updates``) on a new line.
374
375All news item related files should be root owned and in the ``portage`` group
376with the group write (and, for directories, execute) bits set. News files should
377be world readable.
373 378
374Notification that new relevant news items will be displayed via the 379Notification that new relevant news items will be displayed via the
375``emerge`` tool in a similar way to the existing "configuration files need 380``emerge`` tool in a similar way to the existing "configuration files need
376updating" messages: 381updating" messages:
377 382
383Checks for new news messages should be displayed: 388Checks for new news messages should be displayed:
384 389
385* After an ``emerge sync`` 390* After an ``emerge sync``
386* After an ``emerge --pretend`` 391* After an ``emerge --pretend``
387* Before an ``emerge <target>`` (which may also include a red warning message) 392* Before an ``emerge <target>`` (which may also include a red warning message)
388* Before an ``emerge --ask <target>`` sequence 393
394The package manager does not need to know how to launch the user's choice of
395news client. This is consistent with the way configuration file updates are
396handled.
389 397
390The package manager may use a timestamp check file to avoid having to process 398The package manager may use a timestamp check file to avoid having to process
391news items unnecessarily. 399news items unnecessarily.
392 400
393The package manager must keep track of news items that have already been added 401The package manager must keep track of news items that have already been added
394to the unread list to avoid repeatedly marking a deleted news item. This could 402to the unread list to avoid repeatedly marking a deleted news item. This could
395be handled via a ``news-repoid.skip`` file containing the IDs of news items that 403be handled via a ``news-${repoid}.skip`` file containing the IDs of news items
396have already been added to a ``news-repoid.unread`` file, but this method is not 404that have already been added to a ``news-${repoid}.unread`` file, but this
397required by this GLEP. 405method is not required by this GLEP.
398 406
399Users who really don't care about news items can use ``rsync_excludes`` to 407Users who really don't care about news items can use ``rsync_excludes`` to
400filter out the ``metadata/news/`` directory. 408filter out the ``metadata/news/`` directory.
401 409
402News Item Clients 410News Item Clients
404 412
405Once a news item is marked for reading, third party tools (or traditional core 413Once a news item is marked for reading, third party tools (or traditional core
406Unix tools) can be used to display and view the news files. 414Unix tools) can be used to display and view the news files.
407 415
408When a news item is read, its name should be removed from the 416When a news item is read, its name should be removed from the
409``news-repoid.unread`` file. If a news client acts as an interactive reader 417``news-${repoid}.unread`` file. If a news client acts as an interactive reader
410rather than a gateway, it should then add the name to a ``news-repoid.read`` 418rather than a gateway, it should then add the name to a ``news-${repoid}.read``
411file in the same directory with the same file format. 419file in the same directory with the same file format.
412 420
413An ``eselect`` [#eselect]_ module shall be created as the 'suggested' display 421An ``eselect`` [#eselect]_ module shall be created as the 'suggested' display
414tool; other display tools (for example, a news to email forwarder, which would 422tool; other display tools (for example, a news to email forwarder, which would
415be ideal for users who sync on a ``cron``) are left as options for those who 423be ideal for users who sync on a ``cron``) are left as options for those who
439the ``news/`` directory. 447the ``news/`` directory.
440 448
441Reference Implementation 449Reference Implementation
442======================== 450========================
443 451
444Portage Code
445------------
446
447TODO 452TODO
448
449Simple ``eselect`` News Client
450------------------------------
451
452TODO Removed until the exact format details are figured out.
453
454Simple News to Mail Forwarder
455-----------------------------
456
457TODO Removed until the exact format details are figured out.
458 453
459Credits 454Credits
460======= 455=======
461 456
462The idea behind notifying users of news updates via Portage comes from Stuart 457The idea behind notifying users of news updates via Portage comes from Stuart
463Herbert [#stuart-blog]_. 458Herbert [#stuart-blog]_.
464 459
465Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, 460Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear,
466Brian Harring, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec Warner for 461Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec
467input. Some of the ideas presented here are theirs, others go completely 462Warner for input. Some of the ideas presented here are theirs, others go
468against their suggestions. 463completely against their suggestions.
469 464
470Example Files 465Example Files
471============= 466=============
472 467
473TODO Removed until the exact format details are figured out. 468`example-news-item.txt <glep-0042-extras/example-news-item.txt>`_
469 An example news item.
474 470
475References 471References
476========== 472==========
477 473
478.. [#bug-11359] Bugzilla Bug 11359 474.. [#bug-11359] Bugzilla Bug 11359

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

  ViewVC Help
Powered by ViewVC 1.1.20