… | |
… | |
6 | PEP, see http://www.python.org/peps/pep-0001.html for instructions and links |
6 | PEP, see http://www.python.org/peps/pep-0001.html for instructions and links |
7 | to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! |
7 | to templates. DO NOT USE THIS HTML FILE AS YOUR TEMPLATE! |
8 | --> |
8 | --> |
9 | <head> |
9 | <head> |
10 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
10 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
11 | <meta name="generator" content="Docutils 0.3.9: http://docutils.sourceforge.net/" /> |
11 | <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> |
12 | <title>GLEP 42 -- Critical News Reporting</title> |
12 | <title>GLEP 42 -- Critical News Reporting</title> |
13 | <link rel="stylesheet" href="tools/glep.css" type="text/css" /> |
13 | <style type="text/css"> |
|
|
14 | |
|
|
15 | /* |
|
|
16 | :Author: David Goodger |
|
|
17 | :Contact: goodger@users.sourceforge.net |
|
|
18 | :date: $Date: 2006/10/10 20:25:14 $ |
|
|
19 | :version: $Revision: 1.15 $ |
|
|
20 | :copyright: This stylesheet has been placed in the public domain. |
|
|
21 | |
|
|
22 | Default cascading style sheet for the PEP HTML output of Docutils. |
|
|
23 | */ |
|
|
24 | |
|
|
25 | .first { |
|
|
26 | margin-top: 0 } |
|
|
27 | |
|
|
28 | .last { |
|
|
29 | margin-bottom: 0 } |
|
|
30 | |
|
|
31 | .navigation { |
|
|
32 | width: 100% ; |
|
|
33 | background: #cc99ff ; |
|
|
34 | margin-top: 0px ; |
|
|
35 | margin-bottom: 0px } |
|
|
36 | |
|
|
37 | .navigation .navicon { |
|
|
38 | width: 150px ; |
|
|
39 | height: 35px } |
|
|
40 | |
|
|
41 | .navigation .textlinks { |
|
|
42 | padding-left: 1em ; |
|
|
43 | text-align: left } |
|
|
44 | |
|
|
45 | .navigation td, .navigation th { |
|
|
46 | padding-left: 0em ; |
|
|
47 | padding-right: 0em ; |
|
|
48 | vertical-align: middle } |
|
|
49 | |
|
|
50 | .rfc2822 { |
|
|
51 | margin-top: 0.5em ; |
|
|
52 | margin-left: 0.5em ; |
|
|
53 | margin-right: 0.5em ; |
|
|
54 | margin-bottom: 0em } |
|
|
55 | |
|
|
56 | .rfc2822 td { |
|
|
57 | text-align: left } |
|
|
58 | |
|
|
59 | .rfc2822 th.field-name { |
|
|
60 | text-align: right ; |
|
|
61 | font-family: sans-serif ; |
|
|
62 | padding-right: 0.5em ; |
|
|
63 | font-weight: bold ; |
|
|
64 | margin-bottom: 0em } |
|
|
65 | |
|
|
66 | a.toc-backref { |
|
|
67 | text-decoration: none ; |
|
|
68 | color: black } |
|
|
69 | |
|
|
70 | body { |
|
|
71 | margin: 0px ; |
|
|
72 | margin-bottom: 1em ; |
|
|
73 | padding: 0px } |
|
|
74 | |
|
|
75 | dd { |
|
|
76 | margin-bottom: 0.5em } |
|
|
77 | |
|
|
78 | div.section { |
|
|
79 | margin-left: 1em ; |
|
|
80 | margin-right: 1em ; |
|
|
81 | margin-bottom: 1.5em } |
|
|
82 | |
|
|
83 | div.section div.section { |
|
|
84 | margin-left: 0em ; |
|
|
85 | margin-right: 0em ; |
|
|
86 | margin-top: 1.5em } |
|
|
87 | |
|
|
88 | div.abstract { |
|
|
89 | margin: 2em 5em } |
|
|
90 | |
|
|
91 | div.abstract p.topic-title { |
|
|
92 | font-weight: bold ; |
|
|
93 | text-align: center } |
|
|
94 | |
|
|
95 | div.attention, div.caution, div.danger, div.error, div.hint, |
|
|
96 | div.important, div.note, div.tip, div.warning { |
|
|
97 | margin: 2em ; |
|
|
98 | border: medium outset ; |
|
|
99 | padding: 1em } |
|
|
100 | |
|
|
101 | div.attention p.admonition-title, div.caution p.admonition-title, |
|
|
102 | div.danger p.admonition-title, div.error p.admonition-title, |
|
|
103 | div.warning p.admonition-title { |
|
|
104 | color: red ; |
|
|
105 | font-weight: bold ; |
|
|
106 | font-family: sans-serif } |
|
|
107 | |
|
|
108 | div.hint p.admonition-title, div.important p.admonition-title, |
|
|
109 | div.note p.admonition-title, div.tip p.admonition-title { |
|
|
110 | font-weight: bold ; |
|
|
111 | font-family: sans-serif } |
|
|
112 | |
|
|
113 | div.figure { |
|
|
114 | margin-left: 2em } |
|
|
115 | |
|
|
116 | div.footer, div.header { |
|
|
117 | font-size: smaller } |
|
|
118 | |
|
|
119 | div.footer { |
|
|
120 | margin-left: 1em ; |
|
|
121 | margin-right: 1em } |
|
|
122 | |
|
|
123 | div.system-messages { |
|
|
124 | margin: 5em } |
|
|
125 | |
|
|
126 | div.system-messages h1 { |
|
|
127 | color: red } |
|
|
128 | |
|
|
129 | div.system-message { |
|
|
130 | border: medium outset ; |
|
|
131 | padding: 1em } |
|
|
132 | |
|
|
133 | div.system-message p.system-message-title { |
|
|
134 | color: red ; |
|
|
135 | font-weight: bold } |
|
|
136 | |
|
|
137 | div.topic { |
|
|
138 | margin: 2em } |
|
|
139 | |
|
|
140 | h1 { |
|
|
141 | font-family: sans-serif ; |
|
|
142 | font-size: large } |
|
|
143 | |
|
|
144 | h2 { |
|
|
145 | font-family: sans-serif ; |
|
|
146 | font-size: medium } |
|
|
147 | |
|
|
148 | h3 { |
|
|
149 | font-family: sans-serif ; |
|
|
150 | font-size: small } |
|
|
151 | |
|
|
152 | h4 { |
|
|
153 | font-family: sans-serif ; |
|
|
154 | font-style: italic ; |
|
|
155 | font-size: small } |
|
|
156 | |
|
|
157 | h5 { |
|
|
158 | font-family: sans-serif; |
|
|
159 | font-size: x-small } |
|
|
160 | |
|
|
161 | h6 { |
|
|
162 | font-family: sans-serif; |
|
|
163 | font-style: italic ; |
|
|
164 | font-size: x-small } |
|
|
165 | |
|
|
166 | .section hr { |
|
|
167 | width: 75% } |
|
|
168 | |
|
|
169 | ol.simple, ul.simple { |
|
|
170 | margin-bottom: 1em } |
|
|
171 | |
|
|
172 | ol.arabic { |
|
|
173 | list-style: decimal } |
|
|
174 | |
|
|
175 | ol.loweralpha { |
|
|
176 | list-style: lower-alpha } |
|
|
177 | |
|
|
178 | ol.upperalpha { |
|
|
179 | list-style: upper-alpha } |
|
|
180 | |
|
|
181 | ol.lowerroman { |
|
|
182 | list-style: lower-roman } |
|
|
183 | |
|
|
184 | ol.upperroman { |
|
|
185 | list-style: upper-roman } |
|
|
186 | |
|
|
187 | p.caption { |
|
|
188 | font-style: italic } |
|
|
189 | |
|
|
190 | p.credits { |
|
|
191 | font-style: italic ; |
|
|
192 | font-size: smaller } |
|
|
193 | |
|
|
194 | p.label { |
|
|
195 | white-space: nowrap } |
|
|
196 | |
|
|
197 | p.topic-title { |
|
|
198 | font-family: sans-serif ; |
|
|
199 | font-weight: bold } |
|
|
200 | |
|
|
201 | pre.line-block { |
|
|
202 | font-family: serif ; |
|
|
203 | font-size: 100% } |
|
|
204 | |
|
|
205 | pre.literal-block, pre.doctest-block { |
|
|
206 | margin-left: 2em ; |
|
|
207 | margin-right: 2em ; |
|
|
208 | background-color: #eeeeee } |
|
|
209 | |
|
|
210 | span.classifier { |
|
|
211 | font-family: sans-serif ; |
|
|
212 | font-style: oblique } |
|
|
213 | |
|
|
214 | span.classifier-delimiter { |
|
|
215 | font-family: sans-serif ; |
|
|
216 | font-weight: bold } |
|
|
217 | |
|
|
218 | span.interpreted { |
|
|
219 | font-family: sans-serif } |
|
|
220 | |
|
|
221 | span.option-argument { |
|
|
222 | font-style: italic } |
|
|
223 | |
|
|
224 | span.pre { |
|
|
225 | white-space: pre } |
|
|
226 | |
|
|
227 | span.problematic { |
|
|
228 | color: red } |
|
|
229 | |
|
|
230 | table { |
|
|
231 | margin-top: 0.5em ; |
|
|
232 | margin-bottom: 0.5em } |
|
|
233 | |
|
|
234 | td, th { |
|
|
235 | padding-left: 0.5em ; |
|
|
236 | padding-right: 0.5em ; |
|
|
237 | vertical-align: top } |
|
|
238 | |
|
|
239 | td.num { |
|
|
240 | text-align: right } |
|
|
241 | |
|
|
242 | th.field-name { |
|
|
243 | font-weight: bold ; |
|
|
244 | text-align: left ; |
|
|
245 | white-space: nowrap } |
|
|
246 | |
|
|
247 | h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { |
|
|
248 | font-size: 100% } |
|
|
249 | |
|
|
250 | tt { |
|
|
251 | background-color: #eeeeee } |
|
|
252 | |
|
|
253 | ul.auto-toc { |
|
|
254 | list-style-type: none } |
|
|
255 | |
|
|
256 | </style> |
14 | </head> |
257 | </head> |
15 | <body bgcolor="white"> |
258 | <body bgcolor="white"> |
16 | <table class="navigation" cellpadding="0" cellspacing="0" |
259 | <table class="navigation" cellpadding="0" cellspacing="0" |
17 | width="100%" border="0"> |
260 | width="100%" border="0"> |
18 | <tr><td class="navicon" width="150" height="35"> |
261 | <tr><td class="navicon" width="150" height="35"> |
19 | <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> |
262 | <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page"> |
20 | <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
263 | <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]" |
21 | border="0" width="150" height="35" /></a></td> |
264 | border="0" width="150" height="35" /></a></td> |
22 | <td class="textlinks" align="left"> |
265 | <td class="textlinks" align="left"> |
23 | [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
266 | [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>] |
24 | [<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>] |
267 | [<b><a href="http://www.gentoo.org/peps">GLEP Index</a></b>] |
25 | [<b><a href="./glep-0042.txt">GLEP Source</a></b>] |
268 | [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0042.txt">GLEP Source</a></b>] |
26 | </td></tr></table> |
269 | </td></tr></table> |
27 | <table class="rfc2822 docutils field-list" frame="void" rules="none"> |
270 | <table class="rfc2822 docutils field-list" frame="void" rules="none"> |
28 | <col class="field-name" /> |
271 | <col class="field-name" /> |
29 | <col class="field-body" /> |
272 | <col class="field-body" /> |
30 | <tbody valign="top"> |
273 | <tbody valign="top"> |
31 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td> |
274 | <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">42</td> |
32 | </tr> |
275 | </tr> |
33 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td> |
276 | <tr class="field"><th class="field-name">Title:</th><td class="field-body">Critical News Reporting</td> |
34 | </tr> |
277 | </tr> |
35 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">$Revision: 1.4 $</td> |
278 | <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.12</td> |
36 | </tr> |
279 | </tr> |
37 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh <ciaranm at gentoo.org></td> |
280 | <tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh <ciaranm at gentoo.org>, |
|
|
281 | Stephen Bennett <spb at gentoo.org>, |
|
|
282 | Zach Medico <zmedico at gentoo.org></td> |
38 | </tr> |
283 | </tr> |
39 | <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs/xml/htdocs/proj/en/glep/glep-0042.txt?cvsroot=gentoo">$Date: 2005/12/11 01:38:18 $</a></td> |
284 | <tr class="field"><th class="field-name">Last-Modified:</th><td class="field-body"><a class="reference" href="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/proj/en/glep/glep-0042.txt?cvsroot=gentoo">2006/09/05 20:36:38</a></td> |
40 | </tr> |
285 | </tr> |
41 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> |
286 | <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td> |
42 | </tr> |
287 | </tr> |
43 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
288 | <tr class="field"><th class="field-name">Type:</th><td class="field-body">Standards Track</td> |
44 | </tr> |
289 | </tr> |
45 | <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="http://www.python.org/peps/glep-0012.html">text/x-rst</a></td> |
290 | <tr class="field"><th class="field-name">Content-Type:</th><td class="field-body"><a class="reference" href="glep-0002.html">text/x-rst</a></td> |
46 | </tr> |
291 | </tr> |
47 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td> |
292 | <tr class="field"><th class="field-name">Created:</th><td class="field-body">31-Oct-2005</td> |
48 | </tr> |
293 | </tr> |
49 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">1-Nov-2005, 5-Nov-2005, 7-Nov-2005, 11-Dec-2005</td> |
294 | <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">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, 5-Sep-2006</td> |
50 | </tr> |
295 | </tr> |
51 | </tbody> |
296 | </tbody> |
52 | </table> |
297 | </table> |
53 | <hr /> |
298 | <hr /> |
54 | <div class="contents topic" id="contents"> |
299 | <div class="contents topic"> |
55 | <p class="topic-title first"><a name="contents">Contents</a></p> |
300 | <p class="topic-title first"><a id="contents" name="contents">Contents</a></p> |
56 | <ul class="simple"> |
301 | <ul class="simple"> |
57 | <li><a class="reference" href="#abstract" id="id20" name="id20">Abstract</a></li> |
302 | <li><a class="reference" href="#abstract" id="id22" name="id22">Abstract</a></li> |
58 | <li><a class="reference" href="#motivation" id="id21" name="id21">Motivation</a></li> |
303 | <li><a class="reference" href="#motivation" id="id23" name="id23">Motivation</a></li> |
59 | <li><a class="reference" href="#requirements" id="id22" name="id22">Requirements</a></li> |
304 | <li><a class="reference" href="#requirements" id="id24" name="id24">Requirements</a></li> |
60 | <li><a class="reference" href="#specification" id="id23" name="id23">Specification</a><ul> |
305 | <li><a class="reference" href="#specification" id="id25" name="id25">Specification</a><ul> |
61 | <li><a class="reference" href="#overview" id="id24" name="id24">Overview</a></li> |
306 | <li><a class="reference" href="#overview" id="id26" name="id26">Overview</a></li> |
|
|
307 | <li><a class="reference" href="#required-portage-enhancements" id="id27" name="id27">Required Portage Enhancements</a></li> |
62 | <li><a class="reference" href="#news-item-identities" id="id25" name="id25">News Item Identities</a></li> |
308 | <li><a class="reference" href="#news-item-identities" id="id28" name="id28">News Item Identities</a></li> |
63 | <li><a class="reference" href="#news-item-directories" id="id26" name="id26">News Item Directories</a></li> |
309 | <li><a class="reference" href="#news-item-directories" id="id29" name="id29">News Item Directories</a></li> |
64 | <li><a class="reference" href="#news-item-files" id="id27" name="id27">News Item Files</a><ul> |
310 | <li><a class="reference" href="#news-item-files" id="id30" name="id30">News Item Files</a><ul> |
65 | <li><a class="reference" href="#news-item-headers" id="id28" name="id28">News Item Headers</a></li> |
311 | <li><a class="reference" href="#news-item-headers" id="id31" name="id31">News Item Headers</a></li> |
66 | <li><a class="reference" href="#news-item-body" id="id29" name="id29">News Item Body</a></li> |
312 | <li><a class="reference" href="#news-item-body" id="id32" name="id32">News Item Body</a></li> |
67 | <li><a class="reference" href="#example-news-item" id="id30" name="id30">Example News Item</a></li> |
313 | <li><a class="reference" href="#example-news-item" id="id33" name="id33">Example News Item</a></li> |
68 | </ul> |
314 | </ul> |
69 | </li> |
315 | </li> |
70 | <li><a class="reference" href="#news-item-quality-control" id="id31" name="id31">News Item Quality Control</a></li> |
316 | <li><a class="reference" href="#news-item-quality-control" id="id34" name="id34">News Item Quality Control</a></li> |
71 | <li><a class="reference" href="#news-item-distribution" id="id32" name="id32">News Item Distribution</a><ul> |
317 | <li><a class="reference" href="#news-item-distribution" id="id35" name="id35">News Item Distribution</a><ul> |
72 | <li><a class="reference" href="#server-side" id="id33" name="id33">Server Side</a></li> |
318 | <li><a class="reference" href="#server-side" id="id36" name="id36">Server Side</a></li> |
73 | <li><a class="reference" href="#client-side" id="id34" name="id34">Client Side</a></li> |
319 | <li><a class="reference" href="#client-side" id="id37" name="id37">Client Side</a></li> |
74 | </ul> |
320 | </ul> |
75 | </li> |
321 | </li> |
76 | <li><a class="reference" href="#news-item-clients" id="id35" name="id35">News Item Clients</a></li> |
322 | <li><a class="reference" href="#news-item-clients" id="id38" name="id38">News Item Clients</a></li> |
77 | <li><a class="reference" href="#news-item-removal" id="id36" name="id36">News Item Removal</a></li> |
323 | <li><a class="reference" href="#news-item-removal" id="id39" name="id39">News Item Removal</a></li> |
78 | </ul> |
324 | </ul> |
79 | </li> |
325 | </li> |
80 | <li><a class="reference" href="#integration-with-existing-systems" id="id37" name="id37">Integration with Existing Systems</a></li> |
326 | <li><a class="reference" href="#integration-with-existing-systems" id="id40" name="id40">Integration with Existing Systems</a></li> |
81 | <li><a class="reference" href="#backwards-compatibility" id="id38" name="id38">Backwards Compatibility</a></li> |
327 | <li><a class="reference" href="#backwards-compatibility" id="id41" name="id41">Backwards Compatibility</a></li> |
82 | <li><a class="reference" href="#reference-implementation" id="id39" name="id39">Reference Implementation</a><ul> |
328 | <li><a class="reference" href="#reference-implementation" id="id42" name="id42">Reference Implementation</a></li> |
83 | <li><a class="reference" href="#portage-code" id="id40" name="id40">Portage Code</a></li> |
|
|
84 | <li><a class="reference" href="#simple-eselect-news-client" id="id41" name="id41">Simple <tt class="docutils literal"><span class="pre">eselect</span></tt> News Client</a></li> |
|
|
85 | <li><a class="reference" href="#simple-news-to-mail-forwarder" id="id42" name="id42">Simple News to Mail Forwarder</a></li> |
|
|
86 | </ul> |
|
|
87 | </li> |
|
|
88 | <li><a class="reference" href="#credits" id="id43" name="id43">Credits</a></li> |
329 | <li><a class="reference" href="#credits" id="id43" name="id43">Credits</a></li> |
89 | <li><a class="reference" href="#example-files" id="id44" name="id44">Example Files</a></li> |
330 | <li><a class="reference" href="#example-files" id="id44" name="id44">Example Files</a></li> |
90 | <li><a class="reference" href="#references" id="id45" name="id45">References</a></li> |
331 | <li><a class="reference" href="#references" id="id45" name="id45">References</a></li> |
91 | <li><a class="reference" href="#copyright" id="id46" name="id46">Copyright</a></li> |
332 | <li><a class="reference" href="#copyright" id="id46" name="id46">Copyright</a></li> |
92 | </ul> |
333 | </ul> |
93 | </div> |
334 | </div> |
94 | <div class="section" id="abstract"> |
335 | <div class="section"> |
95 | <h1><a class="toc-backref" href="#id20" name="abstract">Abstract</a></h1> |
336 | <h1><a class="toc-backref" href="#id22" id="abstract" name="abstract">Abstract</a></h1> |
96 | <p>This GLEP proposes a new way of informing users about important updates and news |
337 | <p>This GLEP proposes a new way of informing users about important updates and news |
97 | regarding tree-related items.</p> |
338 | related to the tree.</p> |
98 | </div> |
339 | </div> |
99 | <div class="section" id="motivation"> |
340 | <div class="section"> |
100 | <h1><a class="toc-backref" href="#id21" name="motivation">Motivation</a></h1> |
341 | <h1><a class="toc-backref" href="#id23" id="motivation" name="motivation">Motivation</a></h1> |
101 | <p>Although most package updates are clean and require little user action, |
342 | <p>Although most package updates are clean and require little user action, |
102 | occasionally an upgrade requires user intervention during the upgrade process. |
343 | occasionally an upgrade requires user intervention. Recent examples of the |
103 | Recent examples of the latter include the <tt class="docutils literal"><span class="pre">gcc-3.4</span></tt> stabilisation on <tt class="docutils literal"><span class="pre">x86</span></tt> |
344 | latter include the <tt class="docutils literal"><span class="pre">gcc-3.4</span></tt> stabilisation on <tt class="docutils literal"><span class="pre">x86</span></tt> and the <tt class="docutils literal"><span class="pre">mysql-4.1</span></tt> |
104 | and the <tt class="docutils literal"><span class="pre">mysql-5</span></tt> database format changes.</p> |
345 | database format changes.</p> |
105 | <p>There are currently several ways of delivering important news items to our |
346 | <p>There are currently several ways of delivering important news items to our |
106 | users, none of them particularly effective:</p> |
347 | users, none of them particularly effective:</p> |
107 | <ul class="simple"> |
348 | <ul class="simple"> |
108 | <li>Gentoo Weekly News</li> |
349 | <li>Gentoo Weekly News</li> |
109 | <li>The <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt>, <tt class="docutils literal"><span class="pre">gentoo-user</span></tt> and <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt> mailing lists</li> |
350 | <li>The <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt>, <tt class="docutils literal"><span class="pre">gentoo-user</span></tt> and <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt> mailing lists</li> |
110 | <li>The Gentoo Forums</li> |
351 | <li>The Gentoo Forums</li> |
111 | <li>The main Gentoo website</li> |
352 | <li>The main Gentoo website</li> |
112 | <li>RSS feeds of Gentoo news</li> |
353 | <li>RSS feeds of Gentoo news</li> |
|
|
354 | <li><tt class="docutils literal"><span class="pre">einfo</span></tt> and <tt class="docutils literal"><span class="pre">ewarn</span></tt> messages in <tt class="docutils literal"><span class="pre">pkg_setup</span></tt> or <tt class="docutils literal"><span class="pre">pkg_postinst</span></tt></li> |
113 | </ul> |
355 | </ul> |
114 | <p>A more reliable way of getting news of critical updates out to users is required |
356 | <p>A more reliable way of getting news of critical updates out to users is required |
115 | to avoid repeats of the various recent upgrade debacles. This GLEP proposes a |
357 | to avoid repeats of various prior upgrade debacles. This GLEP proposes a |
116 | solution based around pushing news items out to the user via the <tt class="docutils literal"><span class="pre">rsync</span></tt> tree.</p> |
358 | solution based around pushing news items out to the user via the <tt class="docutils literal"><span class="pre">rsync</span></tt> tree.</p> |
117 | <div class="important"> |
359 | <div class="important"> |
118 | <p class="first admonition-title">Important</p> |
360 | <p class="first admonition-title">Important</p> |
119 | <p class="last">This GLEP does not seek to replace or modify <tt class="docutils literal"><span class="pre">einfo</span></tt> messages |
361 | <p class="last">This GLEP does not seek to replace or modify <tt class="docutils literal"><span class="pre">einfo</span></tt> messages |
120 | which are displayed post-install. That is a separate issue which is handled |
362 | which are displayed post-install. That is a separate issue which is handled |
121 | by <tt class="docutils literal"><span class="pre">elog</span></tt> <a class="footnote-reference" href="#bug-11359" id="id1" name="id1">[1]</a>.</p> |
363 | by <tt class="docutils literal"><span class="pre">elog</span></tt> <a class="footnote-reference" href="#bug-11359" id="id1" name="id1">[1]</a>.</p> |
122 | </div> |
364 | </div> |
123 | </div> |
365 | </div> |
124 | <div class="section" id="requirements"> |
366 | <div class="section"> |
125 | <h1><a class="toc-backref" href="#id22" name="requirements">Requirements</a></h1> |
367 | <h1><a class="toc-backref" href="#id24" id="requirements" name="requirements">Requirements</a></h1> |
126 | <p>An adequate solution must meet all of the following requirements:</p> |
368 | <p>An adequate solution must meet all of the following requirements:</p> |
127 | <dl class="docutils"> |
369 | <dl class="docutils"> |
128 | <dt>Preemptive</dt> |
370 | <dt>Preemptive</dt> |
129 | <dd>Users should be told of changes <em>before</em> they break a system, not after the |
371 | <dd>Users should be told of changes <em>before</em> they break a system, not after the |
130 | damage has already been done. Ideally, the system administrator would be |
372 | damage has already been done. Ideally, the system administrator would be |
131 | given ample warning to plan difficult upgrades and changes, rather than only |
373 | given ample warning to plan difficult upgrades and changes, rather than only |
132 | being told just before action is necessary.</dd> |
374 | being told just before action is necessary.</dd> |
133 | <dt>No user subscription required</dt> |
375 | <dt>No user subscription required</dt> |
134 | <dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id2" name="id2">[5]</a> that many users do not |
376 | <dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id2" name="id2">[5]</a> that many users do not |
135 | read the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list or <tt class="docutils literal"><span class="pre">RSS</span></tt> feeds. A solution which |
377 | read the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list or <tt class="docutils literal"><span class="pre">RSS</span></tt> feeds. A solution that |
136 | requires subscription has no advantage over current methods.</dd> |
378 | requires subscription has no advantage over current methods.</dd> |
137 | <dt>No user monitoring required</dt> |
379 | <dt>No user monitoring required</dt> |
138 | <dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id3" name="id3">[5]</a> that many users do not |
380 | <dd>It has already been demonstrated <a class="footnote-reference" href="#forums-apache2" id="id3" name="id3">[5]</a> that many users do not |
139 | read news items posted to the Gentoo website, or do not read news items |
381 | read news items posted to the Gentoo website, or do not read news items |
140 | until it is too late. A solution that relies upon active monitoring of a |
382 | until it is too late. A solution that relies upon active monitoring of a |
… | |
… | |
175 | sources (for example, Forums, GWN, the main Gentoo website) without |
417 | sources (for example, Forums, GWN, the main Gentoo website) without |
176 | excessive difficulty. Similarly, easy interoperation with any future news |
418 | excessive difficulty. Similarly, easy interoperation with any future news |
177 | sources should not be precluded.</dd> |
419 | sources should not be precluded.</dd> |
178 | </dl> |
420 | </dl> |
179 | </div> |
421 | </div> |
180 | <div class="section" id="specification"> |
422 | <div class="section"> |
181 | <h1><a class="toc-backref" href="#id23" name="specification">Specification</a></h1> |
423 | <h1><a class="toc-backref" href="#id25" id="specification" name="specification">Specification</a></h1> |
182 | <div class="section" id="overview"> |
424 | <div class="section"> |
183 | <h2><a class="toc-backref" href="#id24" name="overview">Overview</a></h2> |
425 | <h2><a class="toc-backref" href="#id26" id="overview" name="overview">Overview</a></h2> |
184 | <p>News items are published and delivered to users as follows:</p> |
426 | <p>News items are published and delivered to users as follows:</p> |
185 | <ol class="arabic simple"> |
427 | <ol class="arabic simple"> |
186 | <li>A news item is written. The format to be used is described below.</li> |
428 | <li>A news item is written. The format to be used is described below.</li> |
187 | <li>The news item is reviewed, following the process described in |
429 | <li>The news item is reviewed, following the process described in |
188 | <a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li> |
430 | <a class="reference" href="#news-item-quality-control">News Item Quality Control</a>.</li> |
189 | <li>The news item is committed to a CVS (or Subversion <a class="footnote-reference" href="#glep-36" id="id4" name="id4">[10]</a>) repository. |
431 | <li>The news item is committed to a CVS (or Subversion <a class="footnote-reference" href="#glep-36" id="id4" name="id4">[9]</a>) repository. |
190 | From here, it is merged with the rsync tree. This is described in <a class="reference" href="#news-item-distribution">News Item |
432 | From here, it is merged with the rsync tree. This is described in <a class="reference" href="#news-item-distribution">News Item |
191 | Distribution</a>.</li> |
433 | Distribution</a>.</li> |
192 | <li>Users fetch the news item when they sync. This ensures that the news items in |
434 | <li>Users fetch the news item when they sync. This ensures that the news items in |
193 | question are pushed to the user before the user accidentally makes an |
435 | question are pushed to the user before the user accidentally makes an |
194 | unwanted change. No changes to the existing rsync process are required by |
436 | unwanted change. No changes to the existing rsync process are required by |
… | |
… | |
198 | informing the user that there are unread news items.</li> |
440 | informing the user that there are unread news items.</li> |
199 | <li>The news item is handled by the user's choice of news item reader. See <a class="reference" href="#news-item-clients">News |
441 | <li>The news item is handled by the user's choice of news item reader. See <a class="reference" href="#news-item-clients">News |
200 | Item Clients</a>.</li> |
442 | Item Clients</a>.</li> |
201 | </ol> |
443 | </ol> |
202 | </div> |
444 | </div> |
203 | <div class="section" id="news-item-identities"> |
445 | <div class="section"> |
|
|
446 | <h2><a class="toc-backref" href="#id27" id="required-portage-enhancements" name="required-portage-enhancements">Required Portage Enhancements</a></h2> |
|
|
447 | <p>The following extensions to Portage are required:</p> |
|
|
448 | <ul class="simple"> |
|
|
449 | <li>Every repository (including overlays) will require a unique identifier. It is |
|
|
450 | assumed that an identifier will be a string consisting of characters from |
|
|
451 | <tt class="docutils literal"><span class="pre">a</span></tt> to <tt class="docutils literal"><span class="pre">z</span></tt>, <tt class="docutils literal"><span class="pre">A</span></tt> to <tt class="docutils literal"><span class="pre">Z</span></tt>, <tt class="docutils literal"><span class="pre">0</span></tt> to <tt class="docutils literal"><span class="pre">9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen) |
|
|
452 | <tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</li> |
|
|
453 | <li>Portage must provide a way for external programs to obtain a list of all |
|
|
454 | repository identifiers for a given system. It is assumed that this will be in |
|
|
455 | the form of a <tt class="docutils literal"><span class="pre">portageq</span></tt> command (e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">get_repo_ids</span></tt>).</li> |
|
|
456 | <li>Portage must provide a way for external programs to obtain the base path for |
|
|
457 | a repository with a given ID. It is assumed that this will be in the form of |
|
|
458 | a <tt class="docutils literal"><span class="pre">portageq</span></tt> command (e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">get_repo_root</span> <span class="pre">gentoo-x86</span></tt>).</li> |
|
|
459 | <li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">has_version</span></tt> to support restrictions to a |
|
|
460 | given repository ID.</li> |
|
|
461 | <li>Portage must extend <tt class="docutils literal"><span class="pre">portageq</span></tt> to implement a command which returns whether |
|
|
462 | or not the profile used for a given repository ID is exactly the given profile |
|
|
463 | (e.g. <tt class="docutils literal"><span class="pre">portageq</span> <span class="pre">profile_used</span> <span class="pre">default-linux/sparc/sparc64/2004.3</span> |
|
|
464 | <span class="pre">gentoo-x86</span></tt>).</li> |
|
|
465 | </ul> |
|
|
466 | <p>These extensions are assumed during the following specification.</p> |
|
|
467 | </div> |
|
|
468 | <div class="section"> |
204 | <h2><a class="toc-backref" href="#id25" name="news-item-identities">News Item Identities</a></h2> |
469 | <h2><a class="toc-backref" href="#id28" id="news-item-identities" name="news-item-identities">News Item Identities</a></h2> |
205 | <p>Each news item will have a unique identifier. This identifier will be in the |
470 | <p>Each news item will have a unique identifier. This identifier will be in the |
206 | form <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name</span></tt>, where <tt class="docutils literal"><span class="pre">yyyy</span></tt> is the year (e.g. <tt class="docutils literal"><span class="pre">2005</span></tt>), |
471 | form <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name</span></tt>, where <tt class="docutils literal"><span class="pre">yyyy</span></tt> is the year (e.g. <tt class="docutils literal"><span class="pre">2005</span></tt>), |
207 | <tt class="docutils literal"><span class="pre">mm</span></tt> is the month (<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">12</span></tt>) and dd is the day of the month |
472 | <tt class="docutils literal"><span class="pre">mm</span></tt> is the month (<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">12</span></tt>) and dd is the day of the month |
208 | (<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">31</span></tt>). The <tt class="docutils literal"><span class="pre">short-name</span></tt> is a very short name describing the |
473 | (<tt class="docutils literal"><span class="pre">01</span></tt> through <tt class="docutils literal"><span class="pre">31</span></tt>). The <tt class="docutils literal"><span class="pre">short-name</span></tt> is a very short name describing the |
209 | news item (e.g. <tt class="docutils literal"><span class="pre">yoursql-updates</span></tt>), consisting only of the characters <tt class="docutils literal"><span class="pre">a-z</span></tt>, |
474 | news item (e.g. <tt class="docutils literal"><span class="pre">yoursql-updates</span></tt>), consisting only of the characters <tt class="docutils literal"><span class="pre">a-z</span></tt>, |
210 | <tt class="docutils literal"><span class="pre">0-9</span></tt> and <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen).</p> |
475 | <tt class="docutils literal"><span class="pre">0-9</span></tt>, <tt class="docutils literal"><span class="pre">+</span></tt> (plus), <tt class="docutils literal"><span class="pre">-</span></tt> (hyphen) and <tt class="docutils literal"><span class="pre">_</span></tt> (underscore).</p> |
211 | </div> |
476 | </div> |
212 | <div class="section" id="news-item-directories"> |
477 | <div class="section"> |
213 | <h2><a class="toc-backref" href="#id26" name="news-item-directories">News Item Directories</a></h2> |
478 | <h2><a class="toc-backref" href="#id29" id="news-item-directories" name="news-item-directories">News Item Directories</a></h2> |
214 | <p>Each news item will be represented by a directory whose name is the same as the |
479 | <p>Each news item will be represented by a directory whose name is the same as the |
215 | news item's identifier.</p> |
480 | news item's identifier.</p> |
216 | <p>The directory will contain a file named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.en.txt</span></tt>, which |
481 | <p>The directory will contain a file named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.en.txt</span></tt>, which |
217 | contains the text of the news item, in English, in the format described below.</p> |
482 | contains the text of the news item, in English, in the format described below.</p> |
218 | <p>If a news item is translated, other files named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.xx.txt</span></tt> |
483 | <p>If a news item is translated, other files named <tt class="docutils literal"><span class="pre">yyyy-mm-dd-short-name.xx.txt</span></tt> |
219 | (where <tt class="docutils literal"><span class="pre">xx</span></tt> is the ISO 639 <a class="footnote-reference" href="#iso-639" id="id5" name="id5">[11]</a> two letter country code) will also be |
484 | (where <tt class="docutils literal"><span class="pre">xx</span></tt> is the ISO 639 <a class="footnote-reference" href="#iso-639" id="id5" name="id5">[11]</a> two letter country code, and the date |
220 | provided. However, only the English version of a news item is authoritative. |
485 | remains the same as the original news item) will also be provided. However, only |
|
|
486 | the English version of a news item is authoritative. This anglocentricity is |
221 | This anglocentricity is justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[9]</a>.</p> |
487 | justified by precedent <a class="footnote-reference" href="#glep-34" id="id6" name="id6">[8]</a>.</p> |
222 | </div> |
488 | </div> |
223 | <div class="section" id="news-item-files"> |
489 | <div class="section"> |
224 | <h2><a class="toc-backref" href="#id27" name="news-item-files">News Item Files</a></h2> |
490 | <h2><a class="toc-backref" href="#id30" id="news-item-files" name="news-item-files">News Item Files</a></h2> |
225 | <p>A news item file is a text file, encoded using UTF-8 <a class="footnote-reference" href="#rfc-3629" id="id7" name="id7">[14]</a> for |
491 | <p>A news item file is a text file, encoded using UTF-8 <a class="footnote-reference" href="#rfc-3629" id="id7" name="id7">[14]</a> for |
226 | compatibility with and for the same reasons as existing Gentoo documentation |
492 | compatibility with and for the same reasons as existing Gentoo documentation |
227 | <a class="footnote-reference" href="#docs-policy" id="id8" name="id8">[2]</a> and the tree <a class="footnote-reference" href="#glep-31" id="id9" name="id9">[8]</a>.</p> |
493 | <a class="footnote-reference" href="#docs-policy" id="id8" name="id8">[2]</a> and the tree <a class="footnote-reference" href="#glep-31" id="id9" name="id9">[7]</a>.</p> |
228 | <p>News items should be signed with a detached GPG signature:</p> |
494 | <p>News items must be signed with a detached GPG signature.:</p> |
229 | <pre class="literal-block"> |
495 | <pre class="literal-block"> |
230 | gpg --armour --detach-sign ????-??-??-*.??.txt |
496 | gpg --armour --detach-sign ????-??-??-*.??.txt |
231 | </pre> |
497 | </pre> |
|
|
498 | <p>This GLEP does not specify the type or strength of signature to be used, nor |
|
|
499 | does it discuss how, if at all, a centralised keychain will be provided. These |
|
|
500 | issues should be handled as part of the signing policy discussions.</p> |
232 | <p>A news item file's content will consist of an <a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> style header <a class="footnote-reference" href="#rfc-822" id="id10" name="id10">[13]</a> |
501 | <p>A news item file's content will consist of an <a class="reference" href="http://www.faqs.org/rfcs/rfc822.html">RFC 822</a> style header <a class="footnote-reference" href="#rfc-822" id="id10" name="id10">[13]</a> |
233 | followed by the main body of the message as plain text. This GLEP defines |
502 | followed by the main body of the message as plain text. This GLEP defines |
234 | various optional and mandatory headers. Future GLEPs may propose new headers — |
503 | various optional and mandatory headers. Future GLEPs may propose new headers — |
235 | tools handling these news items must ignore any unrecognised header.</p> |
504 | tools handling these news items must ignore any unrecognised header.</p> |
236 | <div class="section" id="news-item-headers"> |
505 | <div class="section"> |
237 | <h3><a class="toc-backref" href="#id28" name="news-item-headers">News Item Headers</a></h3> |
506 | <h3><a class="toc-backref" href="#id31" id="news-item-headers" name="news-item-headers">News Item Headers</a></h3> |
238 | <p>The following headers describe the purpose and format of the news item:</p> |
507 | <p>The following headers describe the purpose and format of the news item:</p> |
239 | <dl class="docutils"> |
508 | <dl class="docutils"> |
240 | <dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt> |
509 | <dt><tt class="docutils literal"><span class="pre">Title:</span></tt></dt> |
241 | <dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd> |
510 | <dd>A short (maximum 44 characters) descriptive title. Mandatory.</dd> |
242 | <dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt> |
511 | <dt><tt class="docutils literal"><span class="pre">Author:</span></tt></dt> |
… | |
… | |
246 | <dd>For translated news items, the translator's name and email address. Multiple |
515 | <dd>For translated news items, the translator's name and email address. Multiple |
247 | translator headers may be specified if appropriate.</dd> |
516 | translator headers may be specified if appropriate.</dd> |
248 | <dt><tt class="docutils literal"><span class="pre">Content-Type:</span></tt></dt> |
517 | <dt><tt class="docutils literal"><span class="pre">Content-Type:</span></tt></dt> |
249 | <dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd> |
518 | <dd>Must be <tt class="docutils literal"><span class="pre">text/plain</span></tt>. Mandatory.</dd> |
250 | <dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt> |
519 | <dt><tt class="docutils literal"><span class="pre">Posted:</span></tt></dt> |
251 | <dd>Date of posting, in <tt class="docutils literal"><span class="pre">dd-mmm-yyyy</span></tt> format (e.g. 14-Aug-2001) for |
520 | <dd>Date of posting, in <tt class="docutils literal"><span class="pre">yyyy-mm-dd</span></tt> format (e.g. 2005-12-18) for |
252 | compatibility with GLEP 1 <a class="footnote-reference" href="#glep-1" id="id11" name="id11">[6]</a>. UTC time in <tt class="docutils literal"><span class="pre">hh-mm-ss</span> <span class="pre">+0000</span></tt> format |
521 | compatibility with GLEP 45 <a class="footnote-reference" href="#glep-45" id="id11" name="id11">[10]</a>. Translations should use the date |
253 | may also be included. Mandatory.</dd> |
522 | of the original news item. Mandatory.</dd> |
254 | <dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt> |
523 | <dt><tt class="docutils literal"><span class="pre">Revision:</span></tt></dt> |
255 | <dd>Initially 1. Incremented every time a non-trivial change is made. Changes |
524 | <dd>Initially 1. Should be incremented every time a change is made to the news |
256 | which require a re-read of the news item should instead use a new news item |
525 | item. Changes that require a re-read of the news item (i.e., most changes |
|
|
526 | that are not spelling or formatting related) should instead use a new news |
257 | file. Mandatory.</dd> |
527 | item. Mandatory.</dd> |
258 | <dt><tt class="docutils literal"><span class="pre">News-Item-Format:</span></tt></dt> |
528 | <dt><tt class="docutils literal"><span class="pre">News-Item-Format:</span></tt></dt> |
259 | <dd>Must be <tt class="docutils literal"><span class="pre">1.0</span></tt>. Future revisions to the format may increment the minor |
529 | <dd>Must be <tt class="docutils literal"><span class="pre">1.0</span></tt>. Future revisions to the format may increment the minor |
260 | number for backwards-compatible changes, or the major number for major |
530 | number for backwards-compatible changes, or the major number for major |
261 | changes.</dd> |
531 | changes.</dd> |
262 | </dl> |
532 | </dl> |
263 | <p>The following headers are used for filtering:</p> |
533 | <p>The following headers are used for filtering:</p> |
264 | <dl class="docutils"> |
534 | <dl class="docutils"> |
265 | <dt><tt class="docutils literal"><span class="pre">Display-If-Installed:</span></tt></dt> |
535 | <dt><tt class="docutils literal"><span class="pre">Display-If-Installed:</span></tt></dt> |
266 | <dd>A dependency atom or simple package name (for example, |
536 | <dd>A dependency atom (for example, <tt class="docutils literal"><span class="pre"><dev-lang/php-5_alpha</span></tt> or |
267 | <tt class="docutils literal"><span class="pre"><dev-lang/php-5_alpha</span></tt> or <tt class="docutils literal"><span class="pre">net-www/apache</span></tt>). If the user has the |
537 | <tt class="docutils literal"><span class="pre">net-www/apache</span></tt>). If the user has the package specified installed from |
268 | package specified installed, the news item should be displayed.</dd> |
538 | the repository from which the news item was obtained, the news item should |
|
|
539 | be displayed.</dd> |
269 | <dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt> |
540 | <dt><tt class="docutils literal"><span class="pre">Display-If-Keyword:</span></tt></dt> |
270 | <dd>A keyword <a class="footnote-reference" href="#glep-22" id="id12" name="id12">[7]</a> name, for example <tt class="docutils literal"><span class="pre">mips</span></tt> or <tt class="docutils literal"><span class="pre">x86-fbsd</span></tt>. If the |
541 | <dd>A keyword <a class="footnote-reference" href="#glep-22" id="id12" name="id12">[6]</a> name, for example <tt class="docutils literal"><span class="pre">mips</span></tt> or <tt class="docutils literal"><span class="pre">x86-fbsd</span></tt>. If the |
271 | user is on the keyword in question, the news item should be displayed.</dd> |
542 | user is on the keyword in question, the news item should be displayed.</dd> |
272 | <dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt> |
543 | <dt><tt class="docutils literal"><span class="pre">Display-If-Profile:</span></tt></dt> |
273 | <dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. Standard |
544 | <dd>A profile path, for example <tt class="docutils literal"><span class="pre">default-linux/sparc/sparc64/server</span></tt>. If the |
274 | shell GLOB wildcards may be used. If the user is using the exact profile in |
545 | user is using the exact profile in question, the news item should be |
275 | question, the news item should be displayed. This header may be used to |
|
|
276 | replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the future.</dd> |
546 | displayed. This header may be used to replace <tt class="docutils literal"><span class="pre">deprecated</span></tt> files in the |
|
|
547 | future.</dd> |
277 | </dl> |
548 | </dl> |
278 | <div class="note"> |
549 | <div class="note"> |
279 | <p class="first admonition-title">Note</p> |
550 | <p class="first admonition-title">Note</p> |
280 | <p class="last">When performing package moves, developers must also update any |
551 | <p class="last">When performing package moves, developers must also update any |
281 | relevant <tt class="docutils literal"><span class="pre">Display-If-Installed</span></tt> headers in news files.</p> |
552 | relevant <tt class="docutils literal"><span class="pre">Display-If-Installed</span></tt> headers in news files.</p> |
… | |
… | |
297 | simple to specify — it is believed that these kinds of condition are far more |
568 | simple to specify — it is believed that these kinds of condition are far more |
298 | likely to occur than "display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or |
569 | likely to occur than "display this news item for people using <tt class="docutils literal"><span class="pre">YourSQL</span></tt>, or |
299 | for people on <tt class="docutils literal"><span class="pre">sparc</span></tt> or <tt class="docutils literal"><span class="pre">x86-obsd</span></tt>" or "display these news items for |
570 | for people on <tt class="docutils literal"><span class="pre">sparc</span></tt> or <tt class="docutils literal"><span class="pre">x86-obsd</span></tt>" or "display these news items for |
300 | people who use <tt class="docutils literal"><span class="pre">YourSQL</span></tt> and who are on both <tt class="docutils literal"><span class="pre">sparc</span></tt> and <tt class="docutils literal"><span class="pre">x86-obsd</span></tt>".</p> |
571 | people who use <tt class="docutils literal"><span class="pre">YourSQL</span></tt> and who are on both <tt class="docutils literal"><span class="pre">sparc</span></tt> and <tt class="docutils literal"><span class="pre">x86-obsd</span></tt>".</p> |
301 | </div> |
572 | </div> |
302 | <div class="section" id="news-item-body"> |
573 | <div class="section"> |
303 | <h3><a class="toc-backref" href="#id29" name="news-item-body">News Item Body</a></h3> |
574 | <h3><a class="toc-backref" href="#id32" id="news-item-body" name="news-item-body">News Item Body</a></h3> |
304 | <p>The header section must be followed by a blank line, then the main body of the |
575 | <p>The header section must be followed by a blank line, then the main body of the |
305 | text.</p> |
576 | text.</p> |
306 | <p>The text body should be wrapped at 72 characters. No fancy formatting or tab |
577 | <p>The text body should be wrapped at 72 characters. No fancy formatting or tab |
307 | characters should be used — the news item may be being displayed directly to a |
578 | characters should be used — the news item may be being displayed directly to a |
308 | terminal. Paragraphs should be separated by a blank line.</p> |
579 | terminal. Paragraphs should be separated by a blank line.</p> |
309 | <p>Hyperlinks may be used to refer to further information (for example, an upgrade |
580 | <p>Hyperlinks may be used to refer to further information (for example, an upgrade |
310 | guide). However, the main body of the news item should be descriptive and not |
581 | guide). However, the main body of the news item should be descriptive and not |
311 | simply a "read this link" text. It is assumed that the user will have access to |
582 | simply a "read this link" text. It is assumed that the user will have access to |
312 | a web browser <em>somewhere</em>, but not necessarily on the box which is being |
583 | a web browser <em>somewhere</em>, but not necessarily on the box which is being |
313 | administrated — this will be the case on may servers and routers, for example.</p> |
584 | administrated — this will be the case on many servers and routers, for example.</p> |
314 | </div> |
585 | </div> |
315 | <div class="section" id="example-news-item"> |
586 | <div class="section"> |
316 | <h3><a class="toc-backref" href="#id30" name="example-news-item">Example News Item</a></h3> |
587 | <h3><a class="toc-backref" href="#id33" id="example-news-item" name="example-news-item">Example News Item</a></h3> |
317 | <p><a class="reference" href="glep-0042-extras/example-news-item.txt">This hypothetical news item</a> <a class="footnote-reference" href="#id18" id="id19" name="id19">[16]</a> could be used for an upgrade to the |
588 | <p><a class="reference" href="glep-0042-extras/example-news-item.txt">This hypothetical news item</a> <a class="footnote-reference" href="#id20" id="id21" name="id21">[18]</a> could be used for an upgrade to the |
318 | <tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p> |
589 | <tt class="docutils literal"><span class="pre">YourSQL</span></tt> database format which breaks forward compatibility.</p> |
319 | </div> |
590 | </div> |
320 | </div> |
591 | </div> |
321 | <div class="section" id="news-item-quality-control"> |
592 | <div class="section"> |
322 | <h2><a class="toc-backref" href="#id31" name="news-item-quality-control">News Item Quality Control</a></h2> |
593 | <h2><a class="toc-backref" href="#id34" id="news-item-quality-control" name="news-item-quality-control">News Item Quality Control</a></h2> |
323 | <p>There have been complaints regarding the comprehensibility of some upgrade |
594 | <p>There have been complaints regarding the comprehensibility of some upgrade |
324 | notices and news items in the past. This is understandable — not every Gentoo |
595 | notices and news items in the past. This is understandable — not every Gentoo |
325 | developer speaks English as a first language. However, for the sake of clarity, |
596 | developer speaks English as a first language. However, for the sake of clarity, |
326 | professionalism and avoiding making us look like prats, it is important that any |
597 | professionalism and avoiding making us look like prats, it is important that any |
327 | language problems be corrected before inflicting a news item upon end users.</p> |
598 | language problems be corrected before inflicting a news item upon end users.</p> |
328 | <p>Thus, at least 72 hours before a proposed news item is committed, it must be |
599 | <p>Thus, at least 72 hours before a proposed news item is committed, it must be |
329 | posted to the <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt> mailing list and <tt class="docutils literal"><span class="pre">Cc:</span></tt>ed to <tt class="docutils literal"><span class="pre">pr@gentoo.org</span></tt> |
600 | posted to the <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt> mailing list and <tt class="docutils literal"><span class="pre">Cc:</span></tt>ed to <tt class="docutils literal"><span class="pre">pr@gentoo.org</span></tt> |
330 | (exceptions may be made in exceptional circumstances). Any complaints — for |
601 | (exceptions may be made in exceptional circumstances). Any complaints — for |
331 | example regarding wording, clarity or accuracy — <strong>must</strong> be addressed before |
602 | example regarding wording, clarity or accuracy — <strong>must</strong> be addressed before |
332 | the news item goes live.</p> |
603 | the news item goes live.</p> |
333 | <div class="note"> |
|
|
334 | <p class="first admonition-title">Note</p> |
|
|
335 | <p class="last">A previous draft of this GLEP allowed news items to be sent to |
|
|
336 | <tt class="docutils literal"><span class="pre">gentoo-core</span></tt> instead of <tt class="docutils literal"><span class="pre">gentoo-dev</span></tt>. It is possible that a situation |
|
|
337 | may arise where this will be necessary (for example, a security update which |
|
|
338 | must break backwards compatibility and which cannot be revealed to the public |
|
|
339 | before a given date).</p> |
|
|
340 | </div> |
|
|
341 | <p>News items must only be for <strong>important</strong> changes that may cause serious upgrade |
604 | <p>News items must only be for <strong>important</strong> changes that may cause serious upgrade |
342 | or compatibility problems. Ordinary upgrade messages and non-critical news items |
605 | or compatibility problems. Ordinary upgrade messages and non-critical news items |
343 | should remain in <tt class="docutils literal"><span class="pre">einfo</span></tt> notices. The importance of the message to its |
606 | should remain in <tt class="docutils literal"><span class="pre">einfo</span></tt> notices. The importance of the message to its |
344 | intended audience should be justified with the proposal.</p> |
607 | intended audience should be justified with the proposal.</p> |
345 | <div class="important"> |
608 | <div class="important"> |
… | |
… | |
348 | news items which are aimed at users of an uncommon package or architecture. |
611 | news items which are aimed at users of an uncommon package or architecture. |
349 | Thus, the justification should be in the form "this message is important to |
612 | Thus, the justification should be in the form "this message is important to |
350 | YourSQL users because ...", not "YourSQL is important because ...".</p> |
613 | YourSQL users because ...", not "YourSQL is important because ...".</p> |
351 | </div> |
614 | </div> |
352 | </div> |
615 | </div> |
353 | <div class="section" id="news-item-distribution"> |
616 | <div class="section"> |
354 | <h2><a class="toc-backref" href="#id32" name="news-item-distribution">News Item Distribution</a></h2> |
617 | <h2><a class="toc-backref" href="#id35" id="news-item-distribution" name="news-item-distribution">News Item Distribution</a></h2> |
355 | <div class="section" id="server-side"> |
618 | <div class="section"> |
356 | <h3><a class="toc-backref" href="#id33" name="server-side">Server Side</a></h3> |
619 | <h3><a class="toc-backref" href="#id36" id="server-side" name="server-side">Server Side</a></h3> |
357 | <p>News items are to be made available via the standard rsync tree. This removes |
620 | <p>News items are to be made available via the standard rsync tree. This removes |
358 | any need for polling of a remote source.</p> |
621 | any need for polling of a remote source.</p> |
359 | <p>A new repository will be created for news items. The type (CVS or Subversion), |
622 | <p>A new repository will be created for news items. The type (CVS or Subversion), |
360 | location and access controls on this repository are beyond the scope of this |
623 | location and access controls on this repository are beyond the scope of this |
361 | GLEP.</p> |
624 | GLEP.</p> |
… | |
… | |
368 | <p>This repository will contain directories named <tt class="docutils literal"><span class="pre">yyyy/mm/</span></tt>, where <tt class="docutils literal"><span class="pre">yyyy</span></tt> is |
631 | <p>This repository will contain directories named <tt class="docutils literal"><span class="pre">yyyy/mm/</span></tt>, where <tt class="docutils literal"><span class="pre">yyyy</span></tt> is |
369 | the current year and <tt class="docutils literal"><span class="pre">mm</span></tt> is the current month number (01 for January through |
632 | the current year and <tt class="docutils literal"><span class="pre">mm</span></tt> is the current month number (01 for January through |
370 | 12 for December). This separation will help keep news items more manageable.</p> |
633 | 12 for December). This separation will help keep news items more manageable.</p> |
371 | <p>The contents of this repository will automatically be merged with the main rsync |
634 | <p>The contents of this repository will automatically be merged with the main rsync |
372 | tree, placing the items in a <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory. The method used for |
635 | tree, placing the items in a <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory. The method used for |
373 | merging these items is beyond the scope of this GLEP — a similar setup is |
636 | merging these items and the frequency at which it will occur is beyond the scope |
374 | already used for merging GLSAs into the rsync tree.</p> |
637 | of this GLEP; a similar setup is already used for merging GLSAs into the rsync |
|
|
638 | tree.</p> |
375 | <p>The main rsync tree will <strong>not</strong> use the <tt class="docutils literal"><span class="pre">yyyy/mm/</span></tt> subdirectory layout.</p> |
639 | <p>The main rsync tree will <strong>not</strong> use the <tt class="docutils literal"><span class="pre">yyyy/mm/</span></tt> subdirectory layout. The |
|
|
640 | news item directories will all be immediately under the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> |
|
|
641 | directory.</p> |
376 | </div> |
642 | </div> |
377 | <div class="section" id="client-side"> |
643 | <div class="section"> |
378 | <h3><a class="toc-backref" href="#id34" name="client-side">Client Side</a></h3> |
644 | <h3><a class="toc-backref" href="#id37" id="client-side" name="client-side">Client Side</a></h3> |
379 | <p>Whenever relevant unread news items are found, the package manager will create a |
645 | <p>Whenever relevant unread news items are found, the package manager will create a |
380 | file named <tt class="docutils literal"><span class="pre">/var/lib/portage/news/news.unread</span></tt> (if it does not already exist) |
646 | file named <tt class="docutils literal"><span class="pre">/var/lib/gentoo/news/news-${repoid}.unread</span></tt> (if it does not |
|
|
647 | already exist) and append the news item identifier (eg |
381 | and append the news item identifier (eg <tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new |
648 | <tt class="docutils literal"><span class="pre">2005-11-01-yoursql-updates</span></tt>) on a new line.</p> |
382 | line.</p> |
649 | <p>All news item related files should be root owned and in the <tt class="docutils literal"><span class="pre">portage</span></tt> group |
383 | <div class="note"> |
650 | with the group write (and, for directories, execute) bits set. News files should |
384 | <p class="first admonition-title">Note</p> |
651 | be world readable.</p> |
385 | <p class="last">Future changes to Portage involving support for multiple repositories |
|
|
386 | may require one news list per repository. Assuming repositories have some |
|
|
387 | kind of unique identifier, this file could be named <tt class="docutils literal"><span class="pre">news-repoid.unread</span></tt>.</p> |
|
|
388 | </div> |
|
|
389 | <p>Notification that new relevant news items will be displayed via the |
652 | <p>Notification that new relevant news items will be displayed via the |
390 | <tt class="docutils literal"><span class="pre">emerge</span></tt> tool in a similar way to the existing "configuration files need |
653 | <tt class="docutils literal"><span class="pre">emerge</span></tt> tool in a similar way to the existing "configuration files need |
391 | updating" messages:</p> |
654 | updating" messages:</p> |
392 | <pre class="literal-block"> |
655 | <pre class="literal-block"> |
393 | * Important: there are 5 unread news items. |
656 | * Important: there are 5 unread news items. |
… | |
… | |
397 | <ul class="simple"> |
660 | <ul class="simple"> |
398 | <li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">sync</span></tt></li> |
661 | <li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">sync</span></tt></li> |
399 | <li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">--pretend</span></tt></li> |
662 | <li>After an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre">--pretend</span></tt></li> |
400 | <li>Before an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre"><target></span></tt> (which may also include a red warning message)</li> |
663 | <li>Before an <tt class="docutils literal"><span class="pre">emerge</span> <span class="pre"><target></span></tt> (which may also include a red warning message)</li> |
401 | </ul> |
664 | </ul> |
|
|
665 | <p>The package manager does not need to know how to launch the user's choice of |
|
|
666 | news client. This is consistent with the way configuration file updates are |
|
|
667 | handled.</p> |
402 | <p>The package manager may use a timestamp check file to avoid having to process |
668 | <p>The package manager may use a timestamp check file to avoid having to process |
403 | news items unnecessarily.</p> |
669 | news items unnecessarily.</p> |
404 | <p>The package manager must keep track of news items that have already been added |
670 | <p>The package manager must keep track of news items that have already been added |
405 | to the unread list to avoid repeatedly marking a deleted news item. This could |
671 | to the unread list to avoid repeatedly marking a deleted news item. This could |
406 | be handled via a <tt class="docutils literal"><span class="pre">news.skip</span></tt> file, but implementation is not specified by this |
672 | be handled via a <tt class="docutils literal"><span class="pre">news-${repoid}.skip</span></tt> file containing the IDs of news items |
407 | GLEP.</p> |
673 | that have already been added to a <tt class="docutils literal"><span class="pre">news-${repoid}.unread</span></tt> file, but this |
|
|
674 | method is not required by this GLEP.</p> |
408 | <p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to |
675 | <p>Users who really don't care about news items can use <tt class="docutils literal"><span class="pre">rsync_excludes</span></tt> to |
409 | filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p> |
676 | filter out the <tt class="docutils literal"><span class="pre">metadata/news/</span></tt> directory.</p> |
410 | </div> |
677 | </div> |
411 | </div> |
678 | </div> |
412 | <div class="section" id="news-item-clients"> |
679 | <div class="section"> |
413 | <h2><a class="toc-backref" href="#id35" name="news-item-clients">News Item Clients</a></h2> |
680 | <h2><a class="toc-backref" href="#id38" id="news-item-clients" name="news-item-clients">News Item Clients</a></h2> |
414 | <p>Once a news item is marked for reading, third party tools (or traditional core |
681 | <p>Once a news item is marked for reading, third party tools (or traditional core |
415 | Unix tools) can be used to display and view the news files.</p> |
682 | Unix tools) can be used to display and view the news files.</p> |
416 | <p>When a news item is read, its name should be removed from the <tt class="docutils literal"><span class="pre">news.unread</span></tt> |
683 | <p>When a news item is read, its name should be removed from the |
417 | file. News clients may add the name to a <tt class="docutils literal"><span class="pre">news.read</span></tt> file in the same |
684 | <tt class="docutils literal"><span class="pre">news-${repoid}.unread</span></tt> file. If a news client acts as an interactive reader |
|
|
685 | rather than a gateway, it should then add the name to a <tt class="docutils literal"><span class="pre">news-${repoid}.read</span></tt> |
418 | directory with the same file format.</p> |
686 | file in the same directory with the same file format.</p> |
419 | <p>An <tt class="docutils literal"><span class="pre">eselect</span></tt> <a class="footnote-reference" href="#eselect" id="id15" name="id15">[3]</a> module shall be created as the 'suggested' display |
687 | <p>An <tt class="docutils literal"><span class="pre">eselect</span></tt> <a class="footnote-reference" href="#eselect" id="id15" name="id15">[3]</a> module shall be created as the 'suggested' display |
420 | tool; other display tools (for example, a news to email forwarder, which would |
688 | tool; other display tools (for example, a news to email forwarder, which would |
421 | be ideal for users who sync on a <tt class="docutils literal"><span class="pre">cron</span></tt>) are left as options for those who |
689 | be ideal for users who sync on a <tt class="docutils literal"><span class="pre">cron</span></tt>) are left as options for those who |
422 | desire them.</p> |
690 | desire them.</p> |
423 | </div> |
691 | </div> |
424 | <div class="section" id="news-item-removal"> |
692 | <div class="section"> |
425 | <h2><a class="toc-backref" href="#id36" name="news-item-removal">News Item Removal</a></h2> |
693 | <h2><a class="toc-backref" href="#id39" id="news-item-removal" name="news-item-removal">News Item Removal</a></h2> |
426 | <p>News items can be removed (by removing the news file from the main tree) when |
694 | <p>News items can be removed (by removing the news file from the main tree) when |
427 | they are no longer relevant, if they are made obsolete by a future news item or |
695 | they are no longer relevant, if they are made obsolete by a future news item or |
428 | after a long period of time. This is the same as the method used for <tt class="docutils literal"><span class="pre">updates</span></tt> |
696 | after a long period of time. This is the same as the method used for <tt class="docutils literal"><span class="pre">updates</span></tt> |
429 | entries.</p> |
697 | entries.</p> |
430 | </div> |
698 | </div> |
431 | </div> |
699 | </div> |
432 | <div class="section" id="integration-with-existing-systems"> |
700 | <div class="section"> |
433 | <h1><a class="toc-backref" href="#id37" name="integration-with-existing-systems">Integration with Existing Systems</a></h1> |
701 | <h1><a class="toc-backref" href="#id40" id="integration-with-existing-systems" name="integration-with-existing-systems">Integration with Existing Systems</a></h1> |
434 | <p>It would be simple to convert these news items into the format used for news |
702 | <p>It would be simple to convert these news items into the format used for news |
435 | items on the Gentoo website or posts for the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list.</p> |
703 | items on the Gentoo website or posts for the <tt class="docutils literal"><span class="pre">gentoo-announce</span></tt> mailing list.</p> |
436 | <p>There is an existing automated tool <a class="footnote-reference" href="#forums-glsa" id="id16" name="id16">[4]</a> for posting GLSAs to the |
704 | <p>There is an existing automated tool <a class="footnote-reference" href="#forums-glsa" id="id16" name="id16">[4]</a> for posting GLSAs to the |
437 | forums. A similar tool can be used for these news items.</p> |
705 | forums. A similar tool can be used for these news items.</p> |
438 | </div> |
706 | </div> |
439 | <div class="section" id="backwards-compatibility"> |
707 | <div class="section"> |
440 | <h1><a class="toc-backref" href="#id38" name="backwards-compatibility">Backwards Compatibility</a></h1> |
708 | <h1><a class="toc-backref" href="#id41" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1> |
441 | <p>Backwards compatibility is not a concern here. Existing tools will simply ignore |
709 | <p>Backwards compatibility is not a concern here. Existing tools will simply ignore |
442 | the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p> |
710 | the <tt class="docutils literal"><span class="pre">news/</span></tt> directory.</p> |
443 | </div> |
711 | </div> |
444 | <div class="section" id="reference-implementation"> |
712 | <div class="section"> |
445 | <h1><a class="toc-backref" href="#id39" name="reference-implementation">Reference Implementation</a></h1> |
713 | <h1><a class="toc-backref" href="#id42" id="reference-implementation" name="reference-implementation">Reference Implementation</a></h1> |
446 | <div class="section" id="portage-code"> |
714 | <p>A reference implementation of the required package manager support can be found |
447 | <h2><a class="toc-backref" href="#id40" name="portage-code">Portage Code</a></h2> |
715 | in Paludis <a class="footnote-reference" href="#paludis" id="id17" name="id17">[15]</a>, along with a reference newsreader implemented as an |
448 | <p>TODO</p> |
716 | eselect module <a class="footnote-reference" href="#eselect-news" id="id18" name="id18">[16]</a>.</p> |
449 | </div> |
717 | </div> |
450 | <div class="section" id="simple-eselect-news-client"> |
|
|
451 | <h2><a class="toc-backref" href="#id41" name="simple-eselect-news-client">Simple <tt class="docutils literal docutils literal"><span class="pre">eselect</span></tt> News Client</a></h2> |
|
|
452 | <p>TODO Removed until the exact format details are figured out.</p> |
|
|
453 | </div> |
|
|
454 | <div class="section" id="simple-news-to-mail-forwarder"> |
|
|
455 | <h2><a class="toc-backref" href="#id42" name="simple-news-to-mail-forwarder">Simple News to Mail Forwarder</a></h2> |
|
|
456 | <p>TODO Removed until the exact format details are figured out.</p> |
|
|
457 | </div> |
|
|
458 | </div> |
|
|
459 | <div class="section" id="credits"> |
718 | <div class="section"> |
460 | <h1><a class="toc-backref" href="#id43" name="credits">Credits</a></h1> |
719 | <h1><a class="toc-backref" href="#id43" id="credits" name="credits">Credits</a></h1> |
461 | <p>The idea behind notifying users of news updates via Portage comes from Stuart |
720 | <p>The idea behind notifying users of news updates via Portage comes from Stuart |
462 | Herbert <a class="footnote-reference" href="#stuart-blog" id="id17" name="id17">[15]</a>.</p> |
721 | Herbert <a class="footnote-reference" href="#stuart-blog" id="id19" name="id19">[17]</a>.</p> |
463 | <p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, |
722 | <p>Thanks to Lance Albertson, Stephen Bennett, Donnie Berkholz, Grant Goodyear, |
464 | Brian Harring, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec Warner for |
723 | Brian Harring, Marius Mauch, Dan Meltzer, Jason Stubbs, Paul de Vrieze and Alec |
465 | input. Some of the ideas presented here are theirs, others go completely |
724 | Warner for input. Some of the ideas presented here are theirs, others go |
466 | against their suggestions.</p> |
725 | completely against their suggestions.</p> |
467 | </div> |
726 | </div> |
468 | <div class="section" id="example-files"> |
727 | <div class="section"> |
469 | <h1><a class="toc-backref" href="#id44" name="example-files">Example Files</a></h1> |
728 | <h1><a class="toc-backref" href="#id44" id="example-files" name="example-files">Example Files</a></h1> |
470 | <p>TODO Removed until the exact format details are figured out.</p> |
729 | <dl class="docutils"> |
|
|
730 | <dt><a class="reference" href="glep-0042-extras/example-news-item.txt">example-news-item.txt</a></dt> |
|
|
731 | <dd>An example news item.</dd> |
|
|
732 | </dl> |
471 | </div> |
733 | </div> |
472 | <div class="section" id="references"> |
734 | <div class="section"> |
473 | <h1><a class="toc-backref" href="#id45" name="references">References</a></h1> |
735 | <h1><a class="toc-backref" href="#id45" id="references" name="references">References</a></h1> |
474 | <table class="docutils footnote" frame="void" id="bug-11359" rules="none"> |
736 | <table class="docutils footnote" frame="void" id="bug-11359" rules="none"> |
475 | <colgroup><col class="label" /><col /></colgroup> |
737 | <colgroup><col class="label" /><col /></colgroup> |
476 | <tbody valign="top"> |
738 | <tbody valign="top"> |
477 | <tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359 |
739 | <tr><td class="label"><a class="fn-backref" href="#id1" name="bug-11359">[1]</a></td><td>Bugzilla Bug 11359 |
478 | "[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging", |
740 | "[NEW FEATURE] pkg_postinst/pkg_preinst ewarn/einfo logging", |
… | |
… | |
506 | <tbody valign="top"> |
768 | <tbody valign="top"> |
507 | <tr><td class="label"><a name="forums-apache2">[5]</a></td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id3">2</a>)</em> Forums thread "Gentoo Apache2 Config Change Idiocy", |
769 | <tr><td class="label"><a name="forums-apache2">[5]</a></td><td><em>(<a class="fn-backref" href="#id2">1</a>, <a class="fn-backref" href="#id3">2</a>)</em> Forums thread "Gentoo Apache2 Config Change Idiocy", |
508 | <a class="reference" href="http://forums.gentoo.org/viewtopic-t-384368.html">http://forums.gentoo.org/viewtopic-t-384368.html</a></td></tr> |
770 | <a class="reference" href="http://forums.gentoo.org/viewtopic-t-384368.html">http://forums.gentoo.org/viewtopic-t-384368.html</a></td></tr> |
509 | </tbody> |
771 | </tbody> |
510 | </table> |
772 | </table> |
511 | <table class="docutils footnote" frame="void" id="glep-1" rules="none"> |
|
|
512 | <colgroup><col class="label" /><col /></colgroup> |
|
|
513 | <tbody valign="top"> |
|
|
514 | <tr><td class="label"><a class="fn-backref" href="#id11" name="glep-1">[6]</a></td><td>GLEP 1: "GLEP Purpose and Guidelines", Grant Goodyear, |
|
|
515 | <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0001.html">http://www.gentoo.org/proj/en/glep/glep-0001.html</a></td></tr> |
|
|
516 | </tbody> |
|
|
517 | </table> |
|
|
518 | <table class="docutils footnote" frame="void" id="glep-22" rules="none"> |
773 | <table class="docutils footnote" frame="void" id="glep-22" rules="none"> |
519 | <colgroup><col class="label" /><col /></colgroup> |
774 | <colgroup><col class="label" /><col /></colgroup> |
520 | <tbody valign="top"> |
775 | <tbody valign="top"> |
521 | <tr><td class="label"><a class="fn-backref" href="#id12" name="glep-22">[7]</a></td><td>GLEP 22: "New "keyword" system to incorporate various |
776 | <tr><td class="label"><a class="fn-backref" href="#id12" name="glep-22">[6]</a></td><td>GLEP 22: "New "keyword" system to incorporate various |
522 | userlands/kernels/archs", Grant Goodyear, |
777 | userlands/kernels/archs", Grant Goodyear, |
523 | <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0022.html">http://www.gentoo.org/proj/en/glep/glep-0022.html</a></td></tr> |
778 | <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0022.html">http://www.gentoo.org/proj/en/glep/glep-0022.html</a></td></tr> |
524 | </tbody> |
779 | </tbody> |
525 | </table> |
780 | </table> |
526 | <table class="docutils footnote" frame="void" id="glep-31" rules="none"> |
781 | <table class="docutils footnote" frame="void" id="glep-31" rules="none"> |
527 | <colgroup><col class="label" /><col /></colgroup> |
782 | <colgroup><col class="label" /><col /></colgroup> |
528 | <tbody valign="top"> |
783 | <tbody valign="top"> |
529 | <tr><td class="label"><a class="fn-backref" href="#id9" name="glep-31">[8]</a></td><td>GLEP 31: "Character Sets for Portage Tree Items", Ciaran |
784 | <tr><td class="label"><a class="fn-backref" href="#id9" name="glep-31">[7]</a></td><td>GLEP 31: "Character Sets for Portage Tree Items", Ciaran |
530 | McCreesh, |
785 | McCreesh, |
531 | <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0031.html">http://www.gentoo.org/proj/en/glep/glep-0031.html</a></td></tr> |
786 | <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0031.html">http://www.gentoo.org/proj/en/glep/glep-0031.html</a></td></tr> |
532 | </tbody> |
787 | </tbody> |
533 | </table> |
788 | </table> |
534 | <table class="docutils footnote" frame="void" id="glep-34" rules="none"> |
789 | <table class="docutils footnote" frame="void" id="glep-34" rules="none"> |
535 | <colgroup><col class="label" /><col /></colgroup> |
790 | <colgroup><col class="label" /><col /></colgroup> |
536 | <tbody valign="top"> |
791 | <tbody valign="top"> |
537 | <tr><td class="label"><a class="fn-backref" href="#id6" name="glep-34">[9]</a></td><td>GLEP 34: "Per-Category metadata.xml Files", Ciaran McCreesh, |
792 | <tr><td class="label"><a class="fn-backref" href="#id6" name="glep-34">[8]</a></td><td>GLEP 34: "Per-Category metadata.xml Files", Ciaran McCreesh, |
538 | <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0034.html">http://www.gentoo.org/proj/en/glep/glep-0034.html</a></td></tr> |
793 | <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0034.html">http://www.gentoo.org/proj/en/glep/glep-0034.html</a></td></tr> |
539 | </tbody> |
794 | </tbody> |
540 | </table> |
795 | </table> |
541 | <table class="docutils footnote" frame="void" id="glep-36" rules="none"> |
796 | <table class="docutils footnote" frame="void" id="glep-36" rules="none"> |
542 | <colgroup><col class="label" /><col /></colgroup> |
797 | <colgroup><col class="label" /><col /></colgroup> |
543 | <tbody valign="top"> |
798 | <tbody valign="top"> |
544 | <tr><td class="label"><a class="fn-backref" href="#id4" name="glep-36">[10]</a></td><td>GLEP 36: "Subversion/CVS for Gentoo Hosted Projects", Aaron |
799 | <tr><td class="label"><a class="fn-backref" href="#id4" name="glep-36">[9]</a></td><td>GLEP 36: "Subversion/CVS for Gentoo Hosted Projects", Aaron |
545 | Walker, |
800 | Walker, |
546 | <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0036.html">http://www.gentoo.org/proj/en/glep/glep-0036.html</a></td></tr> |
801 | <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0036.html">http://www.gentoo.org/proj/en/glep/glep-0036.html</a></td></tr> |
|
|
802 | </tbody> |
|
|
803 | </table> |
|
|
804 | <table class="docutils footnote" frame="void" id="glep-45" rules="none"> |
|
|
805 | <colgroup><col class="label" /><col /></colgroup> |
|
|
806 | <tbody valign="top"> |
|
|
807 | <tr><td class="label"><a class="fn-backref" href="#id11" name="glep-45">[10]</a></td><td>GLEP 45: "GLEP date format", Henrik Brix Andersen, |
|
|
808 | <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0045.html">http://www.gentoo.org/proj/en/glep/glep-0045.html</a></td></tr> |
547 | </tbody> |
809 | </tbody> |
548 | </table> |
810 | </table> |
549 | <table class="docutils footnote" frame="void" id="iso-639" rules="none"> |
811 | <table class="docutils footnote" frame="void" id="iso-639" rules="none"> |
550 | <colgroup><col class="label" /><col /></colgroup> |
812 | <colgroup><col class="label" /><col /></colgroup> |
551 | <tbody valign="top"> |
813 | <tbody valign="top"> |
… | |
… | |
571 | <tbody valign="top"> |
833 | <tbody valign="top"> |
572 | <tr><td class="label"><a class="fn-backref" href="#id7" name="rfc-3629">[14]</a></td><td><a class="reference" href="http://www.faqs.org/rfcs/rfc3629.html">RFC 3629</a>: "UTF-8, a transformation format of ISO 10646" |
834 | <tr><td class="label"><a class="fn-backref" href="#id7" name="rfc-3629">[14]</a></td><td><a class="reference" href="http://www.faqs.org/rfcs/rfc3629.html">RFC 3629</a>: "UTF-8, a transformation format of ISO 10646" |
573 | <a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr> |
835 | <a class="reference" href="http://www.ietf.org/rfc/rfc3629.txt">http://www.ietf.org/rfc/rfc3629.txt</a></td></tr> |
574 | </tbody> |
836 | </tbody> |
575 | </table> |
837 | </table> |
|
|
838 | <table class="docutils footnote" frame="void" id="paludis" rules="none"> |
|
|
839 | <colgroup><col class="label" /><col /></colgroup> |
|
|
840 | <tbody valign="top"> |
|
|
841 | <tr><td class="label"><a class="fn-backref" href="#id17" name="paludis">[15]</a></td><td>Paludis homepage, <a class="reference" href="http://paludis.berlios.de">http://paludis.berlios.de</a></td></tr> |
|
|
842 | </tbody> |
|
|
843 | </table> |
|
|
844 | <table class="docutils footnote" frame="void" id="eselect-news" rules="none"> |
|
|
845 | <colgroup><col class="label" /><col /></colgroup> |
|
|
846 | <tbody valign="top"> |
|
|
847 | <tr><td class="label"><a class="fn-backref" href="#id18" name="eselect-news">[16]</a></td><td>news.eselect, <a class="reference" href="http://svn.berlios.de/svnroot/repos/paludis/trunk/eselect/news.eselect">http://svn.berlios.de/svnroot/repos/paludis/trunk/eselect/news.eselect</a></td></tr> |
|
|
848 | </tbody> |
|
|
849 | </table> |
576 | <table class="docutils footnote" frame="void" id="stuart-blog" rules="none"> |
850 | <table class="docutils footnote" frame="void" id="stuart-blog" rules="none"> |
577 | <colgroup><col class="label" /><col /></colgroup> |
851 | <colgroup><col class="label" /><col /></colgroup> |
578 | <tbody valign="top"> |
852 | <tbody valign="top"> |
579 | <tr><td class="label"><a class="fn-backref" href="#id17" name="stuart-blog">[15]</a></td><td>"Favouring an automatic news mechanism", Stuart Herbert, |
853 | <tr><td class="label"><a class="fn-backref" href="#id19" name="stuart-blog">[17]</a></td><td>"Favouring an automatic news mechanism", Stuart Herbert, |
580 | <a class="reference" href="http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism">http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism</a></td></tr> |
854 | <a class="reference" href="http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism">http://stu.gnqs.org/diary/gentoo.php/2005/10/28/favouring_an_automatic_news_mechanism</a></td></tr> |
581 | </tbody> |
855 | </tbody> |
582 | </table> |
856 | </table> |
583 | <table class="docutils footnote" frame="void" id="id18" rules="none"> |
857 | <table class="docutils footnote" frame="void" id="id20" rules="none"> |
584 | <colgroup><col class="label" /><col /></colgroup> |
858 | <colgroup><col class="label" /><col /></colgroup> |
585 | <tbody valign="top"> |
859 | <tbody valign="top"> |
586 | <tr><td class="label"><a class="fn-backref" href="#id19" name="id18">[16]</a></td><td><a class="reference" href="glep-0042-extras/example-news-item.txt">glep-0042-extras/example-news-item.txt</a></td></tr> |
860 | <tr><td class="label"><a class="fn-backref" href="#id21" name="id20">[18]</a></td><td><a class="reference" href="glep-0042-extras/example-news-item.txt">glep-0042-extras/example-news-item.txt</a></td></tr> |
587 | </tbody> |
861 | </tbody> |
588 | </table> |
862 | </table> |
589 | </div> |
863 | </div> |
590 | <div class="section" id="copyright"> |
864 | <div class="section"> |
591 | <h1><a class="toc-backref" href="#id46" name="copyright">Copyright</a></h1> |
865 | <h1><a class="toc-backref" href="#id46" id="copyright" name="copyright">Copyright</a></h1> |
592 | <p>This document has been placed in the public domain.</p> |
866 | <p>This document has been placed in the public domain.</p> |
593 | <!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : --> |
867 | <!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : --> |
594 | </div> |
868 | </div> |
595 | |
869 | |
596 | </div> |
870 | </div> |
597 | <div class="footer"> |
871 | <div class="footer"> |
598 | <hr class="footer" /> |
872 | <hr class="footer" /> |
599 | <a class="reference" href="glep-0042.txt">View document source</a>. |
873 | <a class="reference" href="glep-0042.txt">View document source</a>. |
600 | Generated on: 2005-12-11 01:37 UTC. |
874 | Generated on: 2006-10-10 20:23 UTC. |
601 | Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
875 | Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source. |
602 | |
876 | |
603 | </div> |
877 | </div> |
604 | </body> |
878 | </body> |
605 | </html> |
879 | </html> |