/[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.10
1GLEP: 42 1GLEP: 42
2Title: Critical News Reporting 2Title: Critical News Reporting
3Version: $Revision: 1.6 $ 3Version: $Revision: 1.10 $
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/06/12 22:03:07 $
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-2006, 6-Mar-2006, 12-Jun-2006
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
159 156
160* Portage must extend ``portageq has_version`` to support restrictions to a 157* Portage must extend ``portageq has_version`` to support restrictions to a
161 given repository ID. 158 given repository ID.
162 159
163* Portage must extend ``portageq`` to implement a command which returns whether 160* Portage must extend ``portageq`` to implement a command which returns whether
164 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
165 (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``).
166 164
167These extensions are assumed during the following specification. 165These extensions are assumed during the following specification.
168 166
169News Item Identities 167News Item Identities
170-------------------- 168--------------------
172Each news item will have a unique identifier. This identifier will be in the 170Each 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``), 171form ``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 172``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 173(``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``, 174news item (e.g. ``yoursql-updates``), consisting only of the characters ``a-z``,
177``0-9``, ``+`` (plus), ``:`` (colon), ``-`` (hyphen) and ``_`` (underscore). 175``0-9``, ``+`` (plus), ``-`` (hyphen) and ``_`` (underscore).
178 176
179News Item Directories 177News Item Directories
180--------------------- 178---------------------
181 179
182Each news item will be represented by a directory whose name is the same as the 180Each news item will be represented by a directory whose name is the same as the
184 182
185The directory will contain a file named ``yyyy-mm-dd-short-name.en.txt``, which 183The 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. 184contains the text of the news item, in English, in the format described below.
187 185
188If a news item is translated, other files named ``yyyy-mm-dd-short-name.xx.txt`` 186If 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 187(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. 188remains the same as the original news item) will also be provided. However, only
191This anglocentricity is justified by precedent [#glep-34]_. 189the English version of a news item is authoritative. This anglocentricity is
190justified by precedent [#glep-34]_.
192 191
193News Item Files 192News Item Files
194--------------- 193---------------
195 194
196A news item file is a text file, encoded using UTF-8 [#rfc-3629]_ for 195A 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 196compatibility with and for the same reasons as existing Gentoo documentation
198[#docs-policy]_ and the tree [#glep-31]_. 197[#docs-policy]_ and the tree [#glep-31]_.
199 198
200News items should be signed with a detached GPG signature: :: 199News items must be signed with a detached GPG signature.::
201 200
202 gpg --armour --detach-sign ????-??-??-*.??.txt 201 gpg --armour --detach-sign ????-??-??-*.??.txt
202
203This GLEP does not specify the type or strength of signature to be used, nor
204does it discuss how, if at all, a centralised keychain will be provided. These
205issues should be handled as part of the signing policy discussions.
203 206
204A news item file's content will consist of an RFC 822 style header [#rfc-822]_ 207A 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 208followed by the main body of the message as plain text. This GLEP defines
206various optional and mandatory headers. Future GLEPs may propose new headers — 209various optional and mandatory headers. Future GLEPs may propose new headers —
207tools handling these news items must ignore any unrecognised header. 210tools handling these news items must ignore any unrecognised header.
225``Content-Type:`` 228``Content-Type:``
226 Must be ``text/plain``. Mandatory. 229 Must be ``text/plain``. Mandatory.
227 230
228``Posted:`` 231``Posted:``
229 Date of posting, in ``yyyy-mm-dd`` format (e.g. 2005-12-18) for 232 Date of posting, in ``yyyy-mm-dd`` format (e.g. 2005-12-18) for
230 compatibility with GLEP 45 [#glep-45]_. Mandatory. 233 compatibility with GLEP 45 [#glep-45]_. Translations should use the date
234 of the original news item. Mandatory.
231 235
232``Revision:`` 236``Revision:``
233 Initially 1. Incremented every time a non-trivial change is made. Changes 237 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 238 item. Changes that require a re-read of the news item (i.e., most changes
239 that are not spelling or formatting related) should instead use a new news
235 file. Mandatory. 240 item. Mandatory.
236 241
237``News-Item-Format:`` 242``News-Item-Format:``
238 Must be ``1.0``. Future revisions to the format may increment the minor 243 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 244 number for backwards-compatible changes, or the major number for major
240 changes. 245 changes.
241 246
242The following headers are used for filtering: 247The following headers are used for filtering:
243 248
244``Display-If-Installed:`` 249``Display-If-Installed:``
245 A dependency atom or simple package name (for example, 250 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 251 ``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 252 the repository from which the news item was obtained, the news item should
248 obtained, the news item should be displayed. 253 be displayed.
249 254
250``Display-If-Keyword:`` 255``Display-If-Keyword:``
251 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
252 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.
253 258
254``Display-If-Profile:`` 259``Display-If-Profile:``
255 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
256 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
257 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
258 replace ``deprecated`` files in the future. 263 future.
259 264
260.. Note:: When performing package moves, developers must also update any 265.. Note:: When performing package moves, developers must also update any
261 relevant ``Display-If-Installed`` headers in news files. 266 relevant ``Display-If-Installed`` headers in news files.
262 267
263The algorithm used to determine whether a news item is 'relevant' is as 268The algorithm used to determine whether a news item is 'relevant' is as
292 297
293Hyperlinks may be used to refer to further information (for example, an upgrade 298Hyperlinks 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 299guide). 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 300simply 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 301a 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. 302administrated — this will be the case on many servers and routers, for example.
298 303
299Example News Item 304Example News Item
300''''''''''''''''' 305'''''''''''''''''
301 306
302`This hypothetical news item`__ could be used for an upgrade to the 307`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`` 322posted to the ``gentoo-dev`` mailing list and ``Cc:``\ed to ``pr@gentoo.org``
318(exceptions may be made in exceptional circumstances). Any complaints — for 323(exceptions may be made in exceptional circumstances). Any complaints — for
319example regarding wording, clarity or accuracy — **must** be addressed before 324example regarding wording, clarity or accuracy — **must** be addressed before
320the news item goes live. 325the news item goes live.
321 326
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 327News items must only be for **important** changes that may cause serious upgrade
329or compatibility problems. Ordinary upgrade messages and non-critical news items 328or compatibility problems. Ordinary upgrade messages and non-critical news items
330should remain in ``einfo`` notices. The importance of the message to its 329should remain in ``einfo`` notices. The importance of the message to its
331intended audience should be justified with the proposal. 330intended audience should be justified with the proposal.
332 331
356the current year and ``mm`` is the current month number (01 for January through 355the 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. 35612 for December). This separation will help keep news items more manageable.
358 357
359The contents of this repository will automatically be merged with the main rsync 358The 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 359tree, 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 360merging these items and the frequency at which it will occur is beyond the scope
362already used for merging GLSAs into the rsync tree. 361of this GLEP; a similar setup is already used for merging GLSAs into the rsync
362tree.
363 363
364The main rsync tree will **not** use the ``yyyy/mm/`` subdirectory layout. 364The main rsync tree will **not** use the ``yyyy/mm/`` subdirectory layout. The
365news item directories will all be immediately under the ``metadata/news/``
366directory.
365 367
366Client Side 368Client Side
367''''''''''' 369'''''''''''
368 370
369Whenever relevant unread news items are found, the package manager will create a 371Whenever 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 372file named ``/var/lib/gentoo/news/news-${repoid}.unread`` (if it does not
371already exist) and append the news item identifier (eg 373already exist) and append the news item identifier (eg
372``2005-11-01-yoursql-updates``) on a new line. 374``2005-11-01-yoursql-updates``) on a new line.
375
376All news item related files should be root owned and in the ``portage`` group
377with the group write (and, for directories, execute) bits set. News files should
378be world readable.
373 379
374Notification that new relevant news items will be displayed via the 380Notification that new relevant news items will be displayed via the
375``emerge`` tool in a similar way to the existing "configuration files need 381``emerge`` tool in a similar way to the existing "configuration files need
376updating" messages: 382updating" messages:
377 383
383Checks for new news messages should be displayed: 389Checks for new news messages should be displayed:
384 390
385* After an ``emerge sync`` 391* After an ``emerge sync``
386* After an ``emerge --pretend`` 392* After an ``emerge --pretend``
387* Before an ``emerge <target>`` (which may also include a red warning message) 393* Before an ``emerge <target>`` (which may also include a red warning message)
388* Before an ``emerge --ask <target>`` sequence 394
395The package manager does not need to know how to launch the user's choice of
396news client. This is consistent with the way configuration file updates are
397handled.
389 398
390The package manager may use a timestamp check file to avoid having to process 399The package manager may use a timestamp check file to avoid having to process
391news items unnecessarily. 400news items unnecessarily.
392 401
393The package manager must keep track of news items that have already been added 402The 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 403to 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 404be 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 405that have already been added to a ``news-${repoid}.unread`` file, but this
397required by this GLEP. 406method is not required by this GLEP.
398 407
399Users who really don't care about news items can use ``rsync_excludes`` to 408Users who really don't care about news items can use ``rsync_excludes`` to
400filter out the ``metadata/news/`` directory. 409filter out the ``metadata/news/`` directory.
401 410
402News Item Clients 411News Item Clients
404 413
405Once a news item is marked for reading, third party tools (or traditional core 414Once 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. 415Unix tools) can be used to display and view the news files.
407 416
408When a news item is read, its name should be removed from the 417When 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 418``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`` 419rather than a gateway, it should then add the name to a ``news-${repoid}.read``
411file in the same directory with the same file format. 420file in the same directory with the same file format.
412 421
413An ``eselect`` [#eselect]_ module shall be created as the 'suggested' display 422An ``eselect`` [#eselect]_ module shall be created as the 'suggested' display
414tool; other display tools (for example, a news to email forwarder, which would 423tool; 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 424be ideal for users who sync on a ``cron``) are left as options for those who
439the ``news/`` directory. 448the ``news/`` directory.
440 449
441Reference Implementation 450Reference Implementation
442======================== 451========================
443 452
444Portage Code 453A reference implementation of the required package manager support can be found
445------------ 454in Paludis [#paludis]_, along with a reference newsreader implemented as an
446 455eselect module [#eselect-news]_.
447TODO
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 456
459Credits 457Credits
460======= 458=======
461 459
462The idea behind notifying users of news updates via Portage comes from Stuart 460The idea behind notifying users of news updates via Portage comes from Stuart
463Herbert [#stuart-blog]_. 461Herbert [#stuart-blog]_.
464 462
465Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, 463Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear,
466Brian Harring, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec Warner for 464Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec
467input. Some of the ideas presented here are theirs, others go completely 465Warner for input. Some of the ideas presented here are theirs, others go
468against their suggestions. 466completely against their suggestions.
469 467
470Example Files 468Example Files
471============= 469=============
472 470
473TODO Removed until the exact format details are figured out. 471`example-news-item.txt <glep-0042-extras/example-news-item.txt>`_
472 An example news item.
474 473
475References 474References
476========== 475==========
477 476
478.. [#bug-11359] Bugzilla Bug 11359 477.. [#bug-11359] Bugzilla Bug 11359
505 Albertson, 504 Albertson,
506 http://marc.theaimsgroup.com/?l=gentoo-dev&m=113111585907703&w=2 505 http://marc.theaimsgroup.com/?l=gentoo-dev&m=113111585907703&w=2
507.. [#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"
508.. [#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"
509 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
510.. [#stuart-blog] "Favouring an automatic news mechanism", Stuart Herbert, 511.. [#stuart-blog] "Favouring an automatic news mechanism", Stuart Herbert,
511 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
512 513
513Copyright 514Copyright
514========= 515=========

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

  ViewVC Help
Powered by ViewVC 1.1.20