/[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.2 - (show annotations) (download) (as text)
Sun Nov 13 17:16:50 2005 UTC (9 years, 1 month ago) by g2boojum
Branch: MAIN
Changes since 1.1: +21 -15 lines
File MIME type: text/html
Mark GLEP 43 approved and final

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.3.9: http://docutils.sourceforge.net/" />
12 <title>GLEP 43 -- GLEP File Hosting</title>
13 <link rel="stylesheet" href="tools/glep.css" type="text/css" />
14 </head>
15 <body bgcolor="white">
16 <table class="navigation" cellpadding="0" cellspacing="0"
17 width="100%" border="0">
18 <tr><td class="navicon" width="150" height="35">
19 <a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
20 <img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
21 border="0" width="150" height="35" /></a></td>
22 <td class="textlinks" align="left">
23 [<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>]
25 [<b><a href="./glep-0043.txt">GLEP Source</a></b>]
26 </td></tr></table>
27 <table class="rfc2822 docutils field-list" frame="void" rules="none">
28 <col class="field-name" />
29 <col class="field-body" />
30 <tbody valign="top">
31 <tr class="field"><th class="field-name">GLEP:</th><td class="field-body">43</td>
32 </tr>
33 <tr class="field"><th class="field-name">Title:</th><td class="field-body">GLEP File Hosting</td>
34 </tr>
35 <tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td>
36 </tr>
37 <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>
38 </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-0043.txt?cvsroot=gentoo">2005/11/13 17:16:16</a></td>
40 </tr>
41 <tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
42 </tr>
43 <tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td>
44 </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>
46 </tr>
47 <tr class="field"><th class="field-name">Created:</th><td class="field-body">7-Nov-2005</td>
48 </tr>
49 <tr class="field"><th class="field-name">Post-History:</th><td class="field-body">7-Nov-2005</td>
50 </tr>
51 </tbody>
52 </table>
53 <hr />
54 <div class="contents topic" id="contents">
55 <p class="topic-title first"><a name="contents">Contents</a></p>
56 <ul class="simple">
57 <li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li>
58 <li><a class="reference" href="#status" id="id3" name="id3">Status</a></li>
59 <li><a class="reference" href="#motivation" id="id4" name="id4">Motivation</a></li>
60 <li><a class="reference" href="#specification" id="id5" name="id5">Specification</a><ul>
61 <li><a class="reference" href="#example" id="id6" name="id6">Example</a></li>
62 </ul>
63 </li>
64 <li><a class="reference" href="#backwards-compatibility" id="id7" name="id7">Backwards Compatibility</a></li>
65 <li><a class="reference" href="#references" id="id8" name="id8">References</a></li>
66 <li><a class="reference" href="#copyright" id="id9" name="id9">Copyright</a></li>
67 </ul>
68 </div>
69 <div class="section" id="abstract">
70 <h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1>
71 <p>This GLEP proposes the creation of a reliable hosting location for data (e.g.
72 sample code) associated with GLEPs.</p>
73 </div>
74 <div class="section" id="status">
75 <h1><a class="toc-backref" href="#id3" name="status">Status</a></h1>
76 <p>This GLEP has been approved by the GLEP editor and marked Final on
77 13 Nov. 2005.</p>
78 </div>
79 <div class="section" id="motivation">
80 <h1><a class="toc-backref" href="#id4" name="motivation">Motivation</a></h1>
81 <p>Some GLEPs come with non-trivial example files or code which are part of the
82 specification. There are two methods which have been used to handle this
83 previously:</p>
84 <ul class="simple">
85 <li>Include the code inline in the GLEP using a code (<tt class="docutils literal"><span class="pre">::</span></tt>) segment. This is
86 less than ideal for larger code samples as it leads to considerable clutter.</li>
87 <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
88 particularly reliable -- developers may leave or accidentally restructure
89 their webspace, and a GLEP is intended to be a <em>permanent</em> specification.</li>
90 </ul>
91 <p>This GLEP proposes that GLEP authors be allowed to make use of the main Gentoo
92 webserver for hosting content relevant to their GLEP.</p>
93 <div class="important">
94 <p class="first admonition-title">Important</p>
95 <p class="last">The hosting proposed is for files related to the <strong>proposal</strong>
96 (e.g. example code which clarifies part of the specification), not a full
97 implementation of the proposal.</p>
98 </div>
99 </div>
100 <div class="section" id="specification">
101 <h1><a class="toc-backref" href="#id5" name="specification">Specification</a></h1>
102 <p>Once a GLEP number has been allocated, developers (or the GLEP editors) may
103 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
104 GLEP's number) under the main GLEP directory. This directory may be used by
105 files which are part of the proposal.</p>
106 <p>Any hyperlinks to files inside this directory should use relative paths. This
107 prevents breakages in the case of directory structure changes.</p>
108 <p>GLEPs which use this directory may include an 'Example Files' heading with a
109 list of links to the associated files.</p>
110 <div class="section" id="example">
111 <h2><a class="toc-backref" href="#id6" name="example">Example</a></h2>
112 <p>Consider the following GLEP segment, which has been taken from a draft of
113 GLEP 42 <a class="footnote-reference" href="#glep-42" id="id1" name="id1">[1]</a>:</p>
114 <pre class="literal-block">
115 Example News Item
116 '''''''''''''''''
117
118 The following hypothetical news item could be used for an upgrade to the
119 ``YourSQL`` database format which breaks forward compatibility. It should be
120 named ``2005-11/2005-11-01-yoursql-upgrades.en.txt``.
121
122 ::
123
124 # Lots and lots of lines of example news item
125 </pre>
126 <p>The news item in question is clearly part of the proposal, but including it
127 inline is messy. Under this proposal, the main GLEP segment would read:</p>
128 <pre class="literal-block">
129 Example News Item
130 '''''''''''''''''
131
132 `This hypothetical news item`__ could be used for an upgrade to the
133 ``YourSQL`` database format which breaks forward compatibility. It would be
134 named ``2005-11/2005-11-01-yoursql-upgrades.en.txt``.
135
136 .. __: glep-0042-extras/example-news-item.txt
137 </pre>
138 <p>The example news item would then be placed in
139 <tt class="docutils literal"><span class="pre">glep-0042-extras/example-news-item.txt</span></tt>.</p>
140 <p>Similar changes would be made for the longer example code segments. The GLEP
141 could also gain a new section along the lines of:</p>
142 <pre class="literal-block">
143 Example Files
144 =============
145
146 `example-news-item.txt &lt;glep-0042-extras/example-news-item.txt&gt;`_
147 An example news item.
148 `news-mailer.bash &lt;glep-0042-extras/news-mailer.bash&gt;`_
149 A ``bash`` script which delivers news items via email.
150 </pre>
151 </div>
152 </div>
153 <div class="section" id="backwards-compatibility">
154 <h1><a class="toc-backref" href="#id7" name="backwards-compatibility">Backwards Compatibility</a></h1>
155 <p>Not an issue.</p>
156 </div>
157 <div class="section" id="references">
158 <h1><a class="toc-backref" href="#id8" name="references">References</a></h1>
159 <table class="docutils footnote" frame="void" id="glep-42" rules="none">
160 <colgroup><col class="label" /><col /></colgroup>
161 <tbody valign="top">
162 <tr><td class="label"><a class="fn-backref" href="#id1" name="glep-42">[1]</a></td><td>GLEP 42: Critical news reporting, Ciaran McCreesh,
163 <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>
164 </tbody>
165 </table>
166 </div>
167 <div class="section" id="copyright">
168 <h1><a class="toc-backref" href="#id9" name="copyright">Copyright</a></h1>
169 <p>This document has been placed in the public domain.</p>
170 <!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
171 </div>
172
173 </div>
174 <div class="footer">
175 <hr class="footer" />
176 <a class="reference" href="glep-0043.txt">View document source</a>.
177 Generated on: 2005-11-13 17:16 UTC.
178 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.
179
180 </div>
181 </body>
182 </html>

  ViewVC Help
Powered by ViewVC 1.1.20