/[gentoo]/xml/htdocs/proj/en/glep/glep-0043.html
Gentoo

Contents of /xml/htdocs/proj/en/glep/glep-0043.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.4 - (show annotations) (download) (as text)
Thu Jan 25 03:26:26 2007 UTC (7 years, 8 months ago) by antarus
Branch: MAIN
Changes since 1.3: +3 -3 lines
File MIME type: text/html
Fix headers in all current gleps

1 <?xml version="1.0" encoding="utf-8" ?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <!--
5 This HTML is auto-generated. DO NOT EDIT THIS FILE! If you are writing a new
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!
8 -->
9 <head>
10 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
11 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
12 <title>GLEP 43 -- GLEP File Hosting</title>
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.3 $
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>
257 </head>
258 <body bgcolor="white">
259 <table class="navigation" cellpadding="0" cellspacing="0"
260 width="100%" border="0">
261 <tr><td class="navicon" width="150" height="35">
262 <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
263 <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
264 border="0" width="150" height="35" /></a></td>
265 <td class="textlinks" align="left">
266 [<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
267 [<b><a href="http://www.gentoo.org/proj/en/glep/">GLEP Index</a></b>]
268 [<b><a href="http://www.gentoo.org/proj/en/glep/glep-0043.txt">GLEP Source</a></b>]
269 </td></tr></table>
270 <table class="rfc2822 docutils field-list" frame="void" rules="none">
271 <col class="field-name" />
272 <col class="field-body" />
273 <tbody valign="top">
274 <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">43</td>
275 </tr>
276 <tr class="field"><th class="field-name">Title:</th><td class="field-body">GLEP File Hosting</td>
277 </tr>
278 <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td>
279 </tr>
280 <tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh &lt;ciaranm&#32;&#97;t&#32;gentoo.org&gt;</td>
281 </tr>
282 <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-0043.txt?cvsroot=gentoo">2005/11/13 17:16:16</a></td>
283 </tr>
284 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
285 </tr>
286 <tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td>
287 </tr>
288 <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>
289 </tr>
290 <tr class="field"><th class="field-name">Created:</th><td class="field-body">7-Nov-2005</td>
291 </tr>
292 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">7-Nov-2005</td>
293 </tr>
294 </tbody>
295 </table>
296 <hr />
297 <div class="contents topic">
298 <p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
299 <ul class="simple">
300 <li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li>
301 <li><a class="reference" href="#status" id="id3" name="id3">Status</a></li>
302 <li><a class="reference" href="#motivation" id="id4" name="id4">Motivation</a></li>
303 <li><a class="reference" href="#specification" id="id5" name="id5">Specification</a><ul>
304 <li><a class="reference" href="#example" id="id6" name="id6">Example</a></li>
305 </ul>
306 </li>
307 <li><a class="reference" href="#backwards-compatibility" id="id7" name="id7">Backwards Compatibility</a></li>
308 <li><a class="reference" href="#references" id="id8" name="id8">References</a></li>
309 <li><a class="reference" href="#copyright" id="id9" name="id9">Copyright</a></li>
310 </ul>
311 </div>
312 <div class="section">
313 <h1><a class="toc-backref" href="#id2" id="abstract" name="abstract">Abstract</a></h1>
314 <p>This GLEP proposes the creation of a reliable hosting location for data (e.g.
315 sample code) associated with GLEPs.</p>
316 </div>
317 <div class="section">
318 <h1><a class="toc-backref" href="#id3" id="status" name="status">Status</a></h1>
319 <p>This GLEP has been approved by the GLEP editor and marked Final on
320 13 Nov. 2005.</p>
321 </div>
322 <div class="section">
323 <h1><a class="toc-backref" href="#id4" id="motivation" name="motivation">Motivation</a></h1>
324 <p>Some GLEPs come with non-trivial example files or code which are part of the
325 specification. There are two methods which have been used to handle this
326 previously:</p>
327 <ul class="simple">
328 <li>Include the code inline in the GLEP using a code (<tt class="docutils literal"><span class="pre">::</span></tt>) segment. This is
329 less than ideal for larger code samples as it leads to considerable clutter.</li>
330 <li>Place the files on a developer's webspace on <tt class="docutils literal"><span class="pre">dev.gentoo.org</span></tt>. This is not
331 particularly reliable -- developers may leave or accidentally restructure
332 their webspace, and a GLEP is intended to be a <em>permanent</em> specification.</li>
333 </ul>
334 <p>This GLEP proposes that GLEP authors be allowed to make use of the main Gentoo
335 webserver for hosting content relevant to their GLEP.</p>
336 <div class="important">
337 <p class="first admonition-title">Important</p>
338 <p class="last">The hosting proposed is for files related to the <strong>proposal</strong>
339 (e.g. example code which clarifies part of the specification), not a full
340 implementation of the proposal.</p>
341 </div>
342 </div>
343 <div class="section">
344 <h1><a class="toc-backref" href="#id5" id="specification" name="specification">Specification</a></h1>
345 <p>Once a GLEP number has been allocated, developers (or the GLEP editors) may
346 create a directory in CVS named <tt class="docutils literal"><span class="pre">glep-xxxx-extras/</span></tt> (where <tt class="docutils literal"><span class="pre">xxxx</span></tt> is the
347 GLEP's number) under the main GLEP directory. This directory may be used by
348 files which are part of the proposal.</p>
349 <p>Any hyperlinks to files inside this directory should use relative paths. This
350 prevents breakages in the case of directory structure changes.</p>
351 <p>GLEPs which use this directory may include an 'Example Files' heading with a
352 list of links to the associated files.</p>
353 <div class="section">
354 <h2><a class="toc-backref" href="#id6" id="example" name="example">Example</a></h2>
355 <p>Consider the following GLEP segment, which has been taken from a draft of
356 GLEP 42 <a class="footnote-reference" href="#glep-42" id="id1" name="id1">[1]</a>:</p>
357 <pre class="literal-block">
358 Example News Item
359 '''''''''''''''''
360
361 The following hypothetical news item could be used for an upgrade to the
362 ``YourSQL`` database format which breaks forward compatibility. It should be
363 named ``2005-11/2005-11-01-yoursql-upgrades.en.txt``.
364
365 ::
366
367 # Lots and lots of lines of example news item
368 </pre>
369 <p>The news item in question is clearly part of the proposal, but including it
370 inline is messy. Under this proposal, the main GLEP segment would read:</p>
371 <pre class="literal-block">
372 Example News Item
373 '''''''''''''''''
374
375 `This hypothetical news item`__ could be used for an upgrade to the
376 ``YourSQL`` database format which breaks forward compatibility. It would be
377 named ``2005-11/2005-11-01-yoursql-upgrades.en.txt``.
378
379 .. __: glep-0042-extras/example-news-item.txt
380 </pre>
381 <p>The example news item would then be placed in
382 <tt class="docutils literal"><span class="pre">glep-0042-extras/example-news-item.txt</span></tt>.</p>
383 <p>Similar changes would be made for the longer example code segments. The GLEP
384 could also gain a new section along the lines of:</p>
385 <pre class="literal-block">
386 Example Files
387 =============
388
389 `example-news-item.txt &lt;glep-0042-extras/example-news-item.txt&gt;`_
390 An example news item.
391 `news-mailer.bash &lt;glep-0042-extras/news-mailer.bash&gt;`_
392 A ``bash`` script which delivers news items via email.
393 </pre>
394 </div>
395 </div>
396 <div class="section">
397 <h1><a class="toc-backref" href="#id7" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
398 <p>Not an issue.</p>
399 </div>
400 <div class="section">
401 <h1><a class="toc-backref" href="#id8" id="references" name="references">References</a></h1>
402 <table class="docutils footnote" frame="void" id="glep-42" rules="none">
403 <colgroup><col class="label" /><col /></colgroup>
404 <tbody valign="top">
405 <tr><td class="label"><a class="fn-backref" href="#id1" name="glep-42">[1]</a></td><td>GLEP 42: Critical news reporting, Ciaran McCreesh,
406 <a class="reference" href="http://www.gentoo.org/proj/en/glep/glep-0042.html">http://www.gentoo.org/proj/en/glep/glep-0042.html</a></td></tr>
407 </tbody>
408 </table>
409 </div>
410 <div class="section">
411 <h1><a class="toc-backref" href="#id9" id="copyright" name="copyright">Copyright</a></h1>
412 <p>This document has been placed in the public domain.</p>
413 <!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
414 </div>
415
416 </div>
417 <div class="footer">
418 <hr class="footer" />
419 <a class="reference" href="glep-0043.txt">View document source</a>.
420 Generated on: 2006-10-10 20:23 UTC.
421 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.
422
423 </div>
424 </body>
425 </html>

  ViewVC Help
Powered by ViewVC 1.1.20