/[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.1 Revision 1.9
1GLEP: 42 1GLEP: 42
2Title: Critical News Reporting 2Title: Critical News Reporting
3Version: $Revision: 1.1 $ 3Version: $Revision: 1.9 $
4Author: Ciaran McCreesh <ciaranm@gentoo.org> 4Author: Ciaran McCreesh <ciaranm@gentoo.org>
5Last-Modified: $Date: 2005/11/05 03:32:09 $ 5Last-Modified: $Date: 2006/03/06 03:12:08 $
6Status: Draft 6Status: Draft
7Type: Standards Track 7Type: Standards Track
8Content-Type: text/x-rst 8Content-Type: text/x-rst
9Created: 31-October-2005 9Created: 31-Oct-2005
10Post-Date: 1-November-2005, 5-November-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
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
21There are currently several ways of getting news out to our users, none of them 21Although most package updates are clean and require little user action,
22particularly effective: 22occasionally an upgrade requires user intervention. Recent examples of the
23latter include the ``gcc-3.4`` stabilisation on ``x86`` and the ``mysql-4.1``
24database format changes.
25
26There are currently several ways of delivering important news items to our
27users, none of them particularly effective:
23 28
24* Gentoo Weekly News 29* Gentoo Weekly News
25* The ``gentoo-announce`` mailing list 30* The ``gentoo-announce``, ``gentoo-user`` and ``gentoo-dev`` mailing lists
26* The Gentoo Forums 31* The Gentoo Forums
27* The main Gentoo website 32* The main Gentoo website
28* RSS feeds of Gentoo news 33* RSS feeds of Gentoo news
34* ``einfo`` and ``ewarn`` messages in ``pkg_setup`` or ``pkg_postinst``
29 35
30A 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
31to avoid repeats of the various recent upgrade debacles. This GLEP proposes a 37to avoid repeats of various prior upgrade debacles. This GLEP proposes a
32solution 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
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
42 by ``elog`` [#bug-11359]_.
33 43
34Requirements 44Requirements
35============ 45============
36 46
37An adequate solution must meet all of the following requirements: 47An adequate solution must meet all of the following requirements:
38 48
39Preemptive 49Preemptive
40 Users should be told of changes *before* they break the user's system, 50 Users should be told of changes *before* they break a system, not after the
41 after the damage has already been done. 51 damage has already been done. Ideally, the system administrator would be
52 given ample warning to plan difficult upgrades and changes, rather than only
53 being told just before action is necessary.
42 54
43No user subscription required 55No user subscription required
44 It has already been demonstrated [#forums-whining]_ that many users do not 56 It has already been demonstrated [#forums-apache2]_ that many users do not
45 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
46 requires subscription has no advantage over current methods. 58 requires subscription has no advantage over current methods.
47 59
48No user monitoring required 60No user monitoring required
49 It has already been demonstrated [#forums-whining]_ that many users do not 61 It has already been demonstrated [#forums-apache2]_ that many users do not
50 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
51 until it is too late. A solution that relies upon active monitoring of a 63 until it is too late. A solution that relies upon active monitoring of a
52 particular source has no advantage over current methods. 64 particular source has no advantage over current methods.
53 65
54Relevant 66Relevant
58 upon users unnecessarily. 70 upon users unnecessarily.
59 71
60Lightweight 72Lightweight
61 It is not reasonable to expect all users to have an MTA, web browser, email 73 It is not reasonable to expect all users to have an MTA, web browser, email
62 client, cron daemon or text processing suite available on their system. 74 client, cron daemon or text processing suite available on their system.
75 Users must not be forced to install unreasonable extra software to be able
76 to read news items.
63 77
64No privacy violations 78No privacy violations
65 Users of the solution should not be required to provide information about 79 Users of the solution should not be required to provide information about
66 their systems (for example, IP addresses or installed packages). 80 their systems (for example, IP addresses or installed packages).
67 81
68Multiple delivery method support 82Multiple delivery method support
69 Some users may wish to view news items via email, some via a terminal and 83 Some users may wish to view news items via email, some via a terminal and
70 some via a web browser. A solution should either support all of these 84 some via a web browser. A solution should either support all of these
71 methods or (better still) make it trivial to write clients for displaying 85 methods or (better still) make it simple to write clients for displaying
72 news items in different ways. 86 news items in different ways.
73 87
74The following characteristics would be desirable: 88The following characteristics would be desirable:
75 89
76Internationalisable 90Internationalisable
77 Being able to provide messages in multiple languages may be beneficial. 91 Being able to provide messages in multiple languages may be beneficial.
78 92
79Quality control 93Quality control
80 There should be some way to ensure that badly written or irrelevant messages 94 There should be some way to ensure that badly written or irrelevant messages
81 are not sent out, for example by inexperienced developers, those whose 95 are not sent out, for example by inexperienced developers or those whose
82 English language skills are below par or morons. 96 English language skills are below par.
83 97
84Simple for developers 98Simple for developers
85 Posting news items should be as simple as is reasonably possible. 99 Posting news items should be as simple as is reasonably possible.
86 100
87Simple for users 101Simple for users
99Overview 113Overview
100-------- 114--------
101 115
102News items are published and delivered to users as follows: 116News items are published and delivered to users as follows:
103 117
1041. A news item is written. The format to be used is described in 1181. A news item is written. The format to be used is described below.
105 `News Item File Format`_. 119
1062. The news item is reviewed, following the process described in 1202. The news item is reviewed, following the process described in
107 `News Item Quality Control`_. 121 `News Item Quality Control`_.
122
1083. The news item is committed to a CVS (or Subversion [#glep-36]_) repository. 1233. The news item is committed to a CVS (or Subversion [#glep-36]_) repository.
109 From here, it is merged with the rsync tree. This is described in `News Item 124 From here, it is merged with the rsync tree. This is described in `News Item
110 Distribution`_. 125 Distribution`_.
1114. The news item is merged with the rsync tree. Implementation details of this 126
112 point are beyond the scope of this GLEP; existing solutions are in place
113 for merging GLSAs to the tree.
1145. Users fetch the news item when they sync. This ensures that the news items in 1274. Users fetch the news item when they sync. This ensures that the news items in
115 question are pushed to the user before the user accidentally makes an 128 question are pushed to the user before the user accidentally makes an
116 unwanted change. No changes to the existing rsync process are required by 129 unwanted change. No changes to the existing rsync process are required by
117 this GLEP. 130 this GLEP.
1186. Portage filters the news item and, if it is relevant, installs it in a 131
119 special location to be read by a news item reader. Messages are also 1325. The package manager filters the news item and, if it is relevant, marks the
120 displayed to inform the user that news is available. 133 news item for reading. The package manager should also display a notice
134 informing the user that there are unread news items.
135
1217. The news item is handled by the user's choice of news item reader. See `News 1366. The news item is handled by the user's choice of news item reader. See `News
122 Item Clients`_. 137 Item Clients`_.
123 138
124News Item File Format 139Required Portage Enhancements
140-----------------------------
141
142The following extensions to Portage are required:
143
144* Every repository (including overlays) will require a unique identifier. It is
145 assumed that an identifier will be a string consisting of characters from
146 ``a`` to ``z``, ``A`` to ``Z``, ``0`` to ``9``, ``+`` (plus), ``-`` (hyphen)
147 ``_`` (underscore).
148
149* Portage must provide a way for external programs to obtain a list of all
150 repository identifiers for a given system. It is assumed that this will be in
151 the form of a ``portageq`` command (e.g. ``portageq get_repo_ids``).
152
153* Portage must provide a way for external programs to obtain the base path for
154 a repository with a given ID. It is assumed that this will be in the form of
155 a ``portageq`` command (e.g. ``portageq get_repo_root gentoo-x86``).
156
157* Portage must extend ``portageq has_version`` to support restrictions to a
158 given repository ID.
159
160* Portage must extend ``portageq`` to implement a command which returns whether
161 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
163 gentoo-x86``).
164
165These extensions are assumed during the following specification.
166
167News Item Identities
168--------------------
169
170Each news item will have a unique identifier. This identifier will be in the
171form ``yyyy-mm-dd-short-name``, where ``yyyy`` is the year (e.g. ``2005``),
172``mm`` is the month (``01`` through ``12``) and dd is the day of the month
173(``01`` through ``31``). The ``short-name`` is a very short name describing the
174news item (e.g. ``yoursql-updates``), consisting only of the characters ``a-z``,
175``0-9``, ``+`` (plus), ``-`` (hyphen) and ``_`` (underscore).
176
177News Item Directories
125--------------------- 178---------------------
126 179
127Each news item will be represented by a single text file. This file will be 180Each news item will be represented by a directory whose name is the same as the
128encoded using UTF-8 for compatibility with and for the same reason as existing 181news item's identifier.
129Gentoo documentation [#docs-policy]_ and tree [#glep-31]_ practices.
130 182
131The news item will be named in the form ``yyyy-mm-dd-item-name.en.txt``, where 183The directory will contain a file named ``yyyy-mm-dd-short-name.en.txt``, which
132``item-name`` is a very short name (e.g. ``apache-updates``) and ``en`` is the 184contains the text of the news item, in English, in the format described below.
133two letter ISO 639 [#iso-639]_ language code for the news item. The short name
134must consist only of characters ``a-z``, ``A-Z``, ``0-9`` and ``-`` (hyphen).
135 185
136News items may be signed using GPG. If this is done, a detached signature should 186If a news item is translated, other files named ``yyyy-mm-dd-short-name.xx.txt``
137be used. 187(where ``xx`` is the ISO 639 [#iso-639]_ two letter country code, and the date
188remains the same as the original news item) will also be provided. However, only
189the English version of a news item is authoritative. This anglocentricity is
190justified by precedent [#glep-34]_.
138 191
139The directory and file name rules are designed specifically to allow easy 192News Item Files
140sorting by date. 193---------------
141 194
142An English (``en``) version must be available for all news items. Other 195A news item file is a text file, encoded using UTF-8 [#rfc-3629]_ for
143languages may be provided either by the original author or by other translators 196compatibility with and for the same reasons as existing Gentoo documentation
144who have commit access. This anglocentricity is justified on the grounds that 197[#docs-policy]_ and the tree [#glep-31]_.
145nobody objected to it with GLEP 34 [#glep-34]_.
146 198
199News items must be signed with a detached GPG signature.::
200
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.
206
147A news item's content will consist of an RFC 822 [#rfc-822]_ style header 207A news item file's content will consist of an RFC 822 style header [#rfc-822]_
148followed 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
149various optional and mandatory headers. Future GLEPs may propose new headers -- 209various optional and mandatory headers. Future GLEPs may propose new headers
150tools handling these news items must ignore any unrecognised header. 210tools handling these news items must ignore any unrecognised header.
151 211
152News Item Headers 212News Item Headers
153''''''''''''''''' 213'''''''''''''''''
154 214
155The following headers describe the purpose and format of the news item: 215The following headers describe the purpose and format of the news item:
156 216
157``Title:`` 217``Title:``
158 A short (maximum 44 characters) descriptive title. Mandatory. 218 A short (maximum 44 characters) descriptive title. Mandatory.
219
159``Author:`` 220``Author:``
160 Author's name and email address, in the form ``Real Name <email@address>``. 221 Author's name and email address, in the form ``Real Name <email@address>``.
161 Mandatory, multiple author fields may be specified if appropriate. 222 Mandatory; multiple author headers may be specified if appropriate.
223
162``Translator:`` 224``Translator:``
163 For translated news items, the translator's name and email address. 225 For translated news items, the translator's name and email address. Multiple
226 translator headers may be specified if appropriate.
227
164``Content-Type:`` 228``Content-Type:``
165 Must be ``text/plain``. Mandatory. 229 Must be ``text/plain``. Mandatory.
230
166``Posted:`` 231``Posted:``
167 Date of posting, in ``dd-mmm-yyyy`` format (e.g. 14-Aug-2001). UTC time in 232 Date of posting, in ``yyyy-mm-dd`` format (e.g. 2005-12-18) for
168 ``hh-mm-ss +0000`` format may also be included. This field is mandatory. 233 compatibility with GLEP 45 [#glep-45]_. Translations should use the date
234 of the original news item. Mandatory.
235
169``Version:`` 236``Revision:``
170 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
171 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
172 file. 239 that are not spelling or formatting related) should instead use a new news
240 item. Mandatory.
241
173``News-Item-Format:`` 242``News-Item-Format:``
174 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
175 number for backwards-compatible changes, or the major number for major 244 number for backwards-compatible changes, or the major number for major
176 changes. 245 changes.
177 246
178The following headers are used for filtering. If none of these headers are 247The following headers are used for filtering:
179specified, the news item is displayed for all users. Otherwise, the news item is
180displayed if *at least one* header matches.
181 248
182``Display-If-Installed:`` 249``Display-If-Installed:``
183 A dependency atom or simple package name (for example, 250 A dependency atom (for example, ``<dev-lang/php-5_alpha`` or
184 ``<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
185 package specified installed, the news item should be displayed. 252 the repository from which the news item was obtained, the news item should
253 be displayed.
186 254
187``Display-If-Keyword:`` 255``Display-If-Keyword:``
188 A keyword [#glep-22]_ name, for example ``mips``. If the user is on the arch 256 A keyword [#glep-22]_ name, for example ``mips`` or ``x86-fbsd``. If the
189 in question, the news item should be displayed. 257 user is on the keyword in question, the news item should be displayed.
190 258
191``Display-If-Profile:`` 259``Display-If-Profile:``
192 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
193 user is using the exact profile in question, the news item should be 261 user is using the exact profile in question, the news item should be
194 displayed. This header may be used to replace ``deprecated`` files in the 262 displayed. This header may be used to replace ``deprecated`` files in the
195 future. 263 future.
196 264
265.. Note:: When performing package moves, developers must also update any
266 relevant ``Display-If-Installed`` headers in news files.
267
268The algorithm used to determine whether a news item is 'relevant' is as
269follows:
270
271* For each ``Display-If-`` header type which occurs at least once:
272
273 + The news item is not relevant if none of the headers of this type are
274 successfully matched.
275
276* Otherwise the news item is relevant.
277
278In particular, if no ``Display-If-`` header is specified, a news item will be
279relevant for all users.
280
281This algorithm was chosen because it makes conditions like "display this news
282item for ``YourSQL`` users who are on ``sparc`` or ``x86-obsd`` relatively
283simple to specify — it is believed that these kinds of condition are far more
284likely to occur than "display this news item for people using ``YourSQL``, or
285for people on ``sparc`` or ``x86-obsd``\" or "display these news items for
286people who use ``YourSQL`` and who are on both ``sparc`` and ``x86-obsd``\".
287
197News Item Body 288News Item Body
198'''''''''''''' 289''''''''''''''
199 290
200The header section must be followed by a blank line, then the main body of the 291The header section must be followed by a blank line, then the main body of the
201text. 292text.
202 293
203The text body should be wrapped at 72 characters. No fancy formatting or tab 294The text body should be wrapped at 72 characters. No fancy formatting or tab
204characters should be used -- the news item may be being displayed directly to a 295characters should be used the news item may be being displayed directly to a
205terminal. Paragraphs should be separated by two blank lines. 296terminal. Paragraphs should be separated by a blank line.
206 297
207Hyperlinks 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
208guide). 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
209simply 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
210a 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
211administrated -- 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.
212 303
213Example News Item 304Example News Item
214''''''''''''''''' 305'''''''''''''''''
215 306
216The following hypothetical news item could be used for an upgrade to the 307`This hypothetical news item`__ could be used for an upgrade to the
217``YourSQL`` database format which breaks forward compatibility. It should be 308``YourSQL`` database format which breaks forward compatibility.
218named ``2005-11/2005-11-01-yoursql-upgrades.en.txt``.
219 309
220:: 310.. __: glep-0042-extras/example-news-item.txt
221
222 Title: YourSQL Upgrades from 4.0 to 4.1
223 Author: Ciaran McCreesh <ciaranm@gentoo.org>
224 Content-Type: text/plain
225 Posted: 01-Nov-2005
226 Display-If-Installed: <dev-db/yoursql-4.1_alpha
227
228 YourSQL databases created using YourSQL version 4.0 are incompatible
229 with YourSQL version 4.1 or later. There is no reliable way to
230 automate the database format conversion, so action from the system
231 administrator is required before an upgrade can take place.
232
233 Please see the Gentoo YourSQL Upgrade Guide for instructions:
234
235 http://www.gentoo.org/doc/en/yoursql-upgrading.xml
236
237 Also see the official YourSQL documentation:
238
239 http://dev.yoursql.com/doc/refman/4.1/en/upgrading-from-4-0.html
240
241 After upgrading, you should also recompile any packages which link
242 against YourSQL:
243
244 revdep-rebuild --library=libyoursqlclient.so.12
245
246 The revdep-rebuild tool is provided by app-portage/gentoolkit.
247 311
248News Item Quality Control 312News Item Quality Control
249------------------------- 313-------------------------
250 314
251There have been complaints regarding the comprehensibility of some upgrade 315There have been complaints regarding the comprehensibility of some upgrade
252notices and news items in the past. This is understandable -- not every Gentoo 316notices and news items in the past. This is understandable not every Gentoo
253developer speaks English as a first language. However, for the sake of clarity 317developer speaks English as a first language. However, for the sake of clarity,
254and professionalism it is important that any language problems be corrected 318professionalism and avoiding making us look like prats, it is important that any
255before inflicting a news item upon end users. 319language problems be corrected before inflicting a news item upon end users.
256 320
257Thus, all proposed news items must be posted to the ``gentoo-dev`` or 321Thus, at least 72 hours before a proposed news item is committed, it must be
258``gentoo-core`` mailing list, and ``Cc:``\ed to ``pr@gentoo.org`` at least 72 322posted to the ``gentoo-dev`` mailing list and ``Cc:``\ed to ``pr@gentoo.org``
259hours before being committed (exceptions may be made in exceptional 323(exceptions may be made in exceptional circumstances). Any complaints — for
260circumstances). Any complaints regarding wording or clarity **must** be 324example regarding wording, clarity or accuracy — **must** be addressed before
261addressed before the news item goes live. 325the news item goes live.
262 326
263News 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
264or compatibility problems. Ordinary upgrade messages and non-critical news items 328or compatibility problems. Ordinary upgrade messages and non-critical news items
265should remain in ``einfo`` notices. The importance of the message to its 329should remain in ``einfo`` notices. The importance of the message to its
266intended audience should be justified with the proposal. 330intended audience should be justified with the proposal.
274---------------------- 338----------------------
275 339
276Server Side 340Server Side
277''''''''''' 341'''''''''''
278 342
279News items are to be made available via the Portage tree. This removes any 343News items are to be made available via the standard rsync tree. This removes
280need for polling of a remote source. 344any need for polling of a remote source.
281 345
282A new repository will be created for news items. The type (CVS or Subversion), 346A new repository will be created for news items. The type (CVS or Subversion),
283location and access controls on this repository are beyond the scope of this 347location and access controls on this repository are beyond the scope of this
284GLEP. 348GLEP.
285 349
286.. Note:: A previous draft of this GLEP instead used the main ``gentoo-x86`` 350.. Note:: A previous draft of this GLEP instead used the main ``gentoo-x86``
287 tree. This was changed following advice from Infrastructure 351 tree. This was changed following advice from Infrastructure
288 [#ramereth-repo]_. Both solutions have the same end result. 352 [#ramereth-repo]_. Both solutions have the same end result.
289 353
290This repository will contain directories named ``yyyy-mm/``, where ``yyyy`` is 354This repository will contain directories named ``yyyy/mm/``, where ``yyyy`` is
291the 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
29212 for December). This separation will help keep news items more manageable. 35612 for December). This separation will help keep news items more manageable.
293 357
294The 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
295tree, placing the items under a top-level ``news/`` directory. The method used 359tree, placing the items in a ``metadata/news/`` directory. The method used for
296for merging 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
297already used for merging GLSAs into the rsync tree. 361of this GLEP; a similar setup is already used for merging GLSAs into the rsync
362tree.
298 363
299.. Note:: The ``profiles/`` directory will *not* be used. This fits in with 364The main rsync tree will **not** use the ``yyyy/mm/`` subdirectory layout. The
300 the Portage team's future plans for ``profiles/`` and ``metadata/`` 365news item directories will all be immediately under the ``metadata/news/``
301 separation. 366directory.
302 367
303Client Side 368Client Side
304''''''''''' 369'''''''''''
305 370
306Whenever relevant unread news items are found, ``emerge`` will copy or symlink 371Whenever relevant unread news items are found, the package manager will create a
307the news file into ``/var/lib/gentoo/news/``. 372file named ``/var/lib/gentoo/news/news-${repoid}.unread`` (if it does not
373already exist) and append the news item identifier (eg
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.
308 379
309Notification that new relevant news items will be displayed via the 380Notification that new relevant news items will be displayed via the
310``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
311updating" messages: 382updating" messages:
312 383
313:: 384::
314 385
315 * Important: 3 config files in /etc need updating.
316 * Type emerge --help config to learn how to update config files.
317
318 * Important: there are 5 unread news items. 386 * Important: there are 5 unread news items.
319 * Type emerge --help news to learn how to read news files. 387 * Type emerge --help news to learn how to read news files.
320 388
321The unread news message will also be displayed immediately after an 389Checks for new news messages should be displayed:
322``emerge sync``.
323 390
324Portage may also warn of unread news items using, for example, a red flashy 391* After an ``emerge sync``
325before actions such as merging a package. 392* After an ``emerge --pretend``
393* Before an ``emerge <target>`` (which may also include a red warning message)
326 394
327Portage must keep track of news items which have already been installed to avoid 395The package manager does not need to know how to launch the user's choice of
328repeatedly reinstalling a deleted news item. 396news client. This is consistent with the way configuration file updates are
397handled.
398
399The package manager may use a timestamp check file to avoid having to process
400news items unnecessarily.
401
402The package manager must keep track of news items that have already been added
403to the unread list to avoid repeatedly marking a deleted news item. This could
404be handled via a ``news-${repoid}.skip`` file containing the IDs of news items
405that have already been added to a ``news-${repoid}.unread`` file, but this
406method is not required by this GLEP.
329 407
330Users 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
331filter out the ``news/`` directory. 409filter out the ``metadata/news/`` directory.
332 410
333News Item Clients 411News Item Clients
334----------------- 412-----------------
335 413
336Once a news item is 'installed', third party tools (or a traditional Unix pager 414Once a news item is marked for reading, third party tools (or traditional core
337and ``rm``) can be used to display and view the news files. An ``eselect`` 415Unix tools) can be used to display and view the news files.
416
417When a news item is read, its name should be removed from the
418``news-${repoid}.unread`` file. If a news client acts as an interactive reader
419rather than a gateway, it should then add the name to a ``news-${repoid}.read``
420file in the same directory with the same file format.
421
338[#eselect]_ module shall be created as the 'suggested' display tool; other 422An ``eselect`` [#eselect]_ module shall be created as the 'suggested' display
339display tools (for example, a news to email forwarder, which would be ideal for 423tool; other display tools (for example, a news to email forwarder, which would
340users who sync on a cron) are left as options for those who desire them -- the 424be ideal for users who sync on a ``cron``) are left as options for those who
341simple file format make this relatively simple. 425desire them.
342 426
343News Item Removal 427News Item Removal
344----------------- 428-----------------
345 429
346News items can be removed (by removing the news file from the main tree) when 430News items can be removed (by removing the news file from the main tree) when
349entries. 433entries.
350 434
351Integration with Existing Systems 435Integration with Existing Systems
352================================= 436=================================
353 437
354It would be trivial to convert these news items into the format used for news 438It would be simple to convert these news items into the format used for news
355items on the Gentoo website or posts for the ``gentoo-announce`` mailing list. 439items on the Gentoo website or posts for the ``gentoo-announce`` mailing list.
356 440
357There is an existing automated tool [#forums-glsa]_ for posting GLSAs to the 441There is an existing automated tool [#forums-glsa]_ for posting GLSAs to the
358forums. A similar tool can be used for these news items. 442forums. A similar tool can be used for these news items.
359 443
364the ``news/`` directory. 448the ``news/`` directory.
365 449
366Reference Implementation 450Reference Implementation
367======================== 451========================
368 452
369Portage Code
370------------
371
372TODO 453TODO
373
374Simple ``eselect`` News Client
375------------------------------
376
377A demonstration ``eselect`` news display script follows:
378
379::
380
381 # Copyright 1999-2005 Gentoo Foundation
382 # Distributed under the terms of the GNU General Public License v2
383 # $Id: glep-0042.txt,v 1.1 2005/11/05 03:32:09 g2boojum Exp $
384
385 DESCRIPTION="Read important Gentoo news items"
386 MAINTAINER="ciaranm@gentoo.org"
387 SVN_DATE='$Date: 2005/11/05 03:32:09 $'
388 VERSION=$(svn_date_to_version "${SVN_DATE}" )
389
390 get_news_item_list() {
391 [[ -d "${ROOT}/var/lib/gentoo/news" ]] || return
392 (
393 local news
394 for news in "${ROOT}/var/lib/gentoo/news/"*.txt ; do
395 echo $(basename ${news%%.*} )
396 done
397 ) | sort -u
398 }
399
400 get_filename() {
401 local best_lang=${LANG%%_*} lang= filename="${1}"
402 [[ -e "/${filename}" ]] || for lang in "${best_lang}" "en" ; do
403 filename="${ROOT}/var/lib/gentoo/news/${1}.${lang}.txt"
404 [[ -e "${filename}" ]] && break
405 done
406 [[ -e "${filename}" ]] && echo "${filename}" || die -q "Can't find '${1}'"
407 }
408
409 get_all_filenames() {
410 if [[ -z "${1}" ]] ; then
411 echo "${ROOT}/var/lib/gentoo/news/"*.??".txt"
412 else
413 echo "${ROOT}/var/lib/gentoo/news/${1}."??".txt"
414 fi
415 }
416
417 get_headers() {
418 sed -e '/^$/Q' < $(get_filename "${1}" )
419 }
420
421 get_body() {
422 sed -e '1,/^$/d' < $(get_filename "${1}" )
423 }
424
425 get_title() {
426 get_headers "${1}" | sed -n -e '/^[Tt]itle: /s/^[^:]\+:[ \t]*//p'
427 }
428
429 ### list action
430
431 ## {{{ list stuff
432 describe_list() {
433 echo "List available news items"
434 }
435
436 do_list() {
437 write_list_start "Available news items:"
438 local empty=yes n=1
439 for news in $(get_news_item_list ) ; do
440 write_numbered_list_entry ${n} "$(highlight $(get_title ${news} ) ) (${news})"
441 n=$(( n + 1 ))
442 done
443 }
444 ## }}}
445
446 ## {{{ show stuff
447 describe_show(){
448 echo "Show a news item"
449 }
450
451 do_show() {
452 [[ -z "${1}" ]] && die -q "You didn't tell me which news item to read"
453
454 local target=${1} filename=
455 if is_number "${target}" && [[ ${target} -ge 1 ]] ; then
456 targets=( $(get_news_item_list ) )
457 target=${targets[$(( ${target} - 1 ))]}
458 fi
459
460 (
461 get_headers "${target}" | grep -v '^Display-If-\|Content-Type:'
462 echo
463 get_body "${target}"
464 ) | ${PAGER:-cat}
465 }
466 ## }}}
467
468 # {{{ delete stuff
469 describe_delete() {
470 echo "Delete a news item"
471 }
472
473 do_delete() {
474 [[ -z "${1}" ]] && die -q "You didn't tell me which news item to delete"
475
476 for target in $@ ; do
477 if is_number "${target}" && [[ ${target} -ge 1 ]] ; then
478 targets=( $(get_news_item_list ) )
479 target=${targets[$(( ${target} - 1 ))]}
480 fi
481
482 rm $(get_all_filenames "${target}" ) || die -q "Couldn't delete ${target}"
483 done
484 }
485 # }}}
486
487 # {{{ delete-all
488 describe_delete-all() {
489 echo "Delete all news items"
490 }
491
492 do_delete-all() {
493 rm $(get_all_filenames ) || die -q "Couldn't delete news items"
494 }
495 # }}}
496
497Simple News to Mail Forwarder
498-----------------------------
499
500A demonstration shell script which delivers news items via email follows:
501
502::
503
504 #!/bin/bash
505
506 to_address="root@localhost"
507 mail="mailx"
508 best_lang="${LANG%%_*}"
509
510 for news in /var/lib/gentoo/news/*.*.txt ; do
511 [[ -z "${best_lang}" ]] || news="${news%%.*}.${best_lang}.txt"
512 [[ -f "${news}" ]] || news="${news%%.*}.en.txt"
513 [[ -f "${news}" ]] || continue
514 title=$(sed -n -e '/^Title:/ { s,^[^:]\+:[ \t]\+,,p ; q }' < ${news} )
515 sed -e '1,/^$/ { /^Display-If\|Content-Type/d }' < "${news}" | \
516 ${mail} -s "Gentoo news: ${title}" "${to_address}" && \
517 for file in ${news%%.*}.*.txt ; do rm "${file}" ; done
518 done
519 454
520Credits 455Credits
521======= 456=======
522 457
523The idea behind notifying users of news updates via Portage comes from Stuart 458The idea behind notifying users of news updates via Portage comes from Stuart
524Herbert [#stuart-blog]_. 459Herbert [#stuart-blog]_.
525 460
526Thanks to Lance Albertson, Donnie Berkholz, Grant Goodyear, Brian Harring, Dan 461Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear,
527Meltzer, Paul de Vrieze and Alec Warner for input. Some of the ideas presented 462Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec
528here are theirs, others go completely against their suggestions. 463Warner for input. Some of the ideas presented here are theirs, others go
464completely against their suggestions.
465
466Example Files
467=============
468
469`example-news-item.txt <glep-0042-extras/example-news-item.txt>`_
470 An example news item.
529 471
530References 472References
531========== 473==========
532 474
475.. [#bug-11359] Bugzilla Bug 11359
476 "[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging",
477 https://bugs.gentoo.org/show_bug.cgi?id=11359
533.. [#docs-policy] Gentoo XML Guide, Daniel Robbins et al., 478.. [#docs-policy] Gentoo XML Guide, Daniel Robbins et al.,
534 http://www.gentoo.org/doc/en/xml-guide.xml 479 http://www.gentoo.org/doc/en/xml-guide.xml
535.. [#eselect] eselect modular framework for configuration and 480.. [#eselect] eselect modular framework for configuration and
536 administration utilities, 481 administration utilities,
537 http://www.gentoo.org/proj/en/eselect/index.xml 482 http://www.gentoo.org/proj/en/eselect/index.xml
538.. [#forums-glsa] Forums user GLSA, 483.. [#forums-glsa] Forums user GLSA,
539 http://forums.gentoo.org/profile.php?mode=viewprofile&u=55648 484 http://forums.gentoo.org/profile.php?mode=viewprofile&u=55648
540.. [#forums-whining] Forums thread "Gentoo Apache2 Config Change Idiocy", 485.. [#forums-apache2] Forums thread "Gentoo Apache2 Config Change Idiocy",
541 http://forums.gentoo.org/viewtopic-t-384368.html 486 http://forums.gentoo.org/viewtopic-t-384368.html
542.. [#glep-22] GLEP 22: "New "keyword" system to incorporate various 487.. [#glep-22] GLEP 22: "New "keyword" system to incorporate various
543 userlands/kernels/archs", Grant Goodyear, 488 userlands/kernels/archs", Grant Goodyear,
544 http://www.gentoo.org/proj/en/glep/glep-0022.html 489 http://www.gentoo.org/proj/en/glep/glep-0022.html
545.. [#glep-31] GLEP 31: "Character Sets for Portage Tree Items", Ciaran 490.. [#glep-31] GLEP 31: "Character Sets for Portage Tree Items", Ciaran
548.. [#glep-34] GLEP 34: "Per-Category metadata.xml Files", Ciaran McCreesh, 493.. [#glep-34] GLEP 34: "Per-Category metadata.xml Files", Ciaran McCreesh,
549 http://www.gentoo.org/proj/en/glep/glep-0034.html 494 http://www.gentoo.org/proj/en/glep/glep-0034.html
550.. [#glep-36] GLEP 36: "Subversion/CVS for Gentoo Hosted Projects", Aaron 495.. [#glep-36] GLEP 36: "Subversion/CVS for Gentoo Hosted Projects", Aaron
551 Walker, 496 Walker,
552 http://www.gentoo.org/proj/en/glep/glep-0036.html 497 http://www.gentoo.org/proj/en/glep/glep-0036.html
498.. [#glep-45] GLEP 45: "GLEP date format", Henrik Brix Andersen,
499 http://www.gentoo.org/proj/en/glep/glep-0045.html
553.. [#iso-639] ISO 639 "Code for the representation of names of languages" 500.. [#iso-639] ISO 639 "Code for the representation of names of languages"
554.. [#ramereth-repo] "Re: [gentoo-dev] GLEP ??: Critical News Reporting", Lance 501.. [#ramereth-repo] "Re: [gentoo-dev] GLEP ??: Critical News Reporting", Lance
555 Albertson, 502 Albertson,
556 http://marc.theaimsgroup.com/?l=gentoo-dev&m=113111585907703&w=2 503 http://marc.theaimsgroup.com/?l=gentoo-dev&m=113111585907703&w=2
557.. [#rfc-822] RFC 822 "Standard for the format of ARPA Internet text messages" 504.. [#rfc-822] RFC 822 "Standard for the format of ARPA Internet text messages"
505.. [#rfc-3629] RFC 3629: "UTF-8, a transformation format of ISO 10646"
506 http://www.ietf.org/rfc/rfc3629.txt
558.. [#stuart-blog] "Favouring an automatic news mechanism", Stuart Herbert, 507.. [#stuart-blog] "Favouring an automatic news mechanism", Stuart Herbert,
559 http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism 508 http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism
560 509
561Copyright 510Copyright
562========= 511=========

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.9

  ViewVC Help
Powered by ViewVC 1.1.20