| 1 |
ciaranm |
1.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">$Revision: $</td>
|
| 36 |
|
|
</tr>
|
| 37 |
|
|
<tr class="field"><th class="field-name">Author:</th><td class="field-body">Ciaran McCreesh <ciaranm at gentoo.org></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">$Date: $</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="#motivation" id="id3" name="id3">Motivation</a></li>
|
| 59 |
|
|
<li><a class="reference" href="#specification" id="id4" name="id4">Specification</a><ul>
|
| 60 |
|
|
<li><a class="reference" href="#example" id="id5" name="id5">Example</a></li>
|
| 61 |
|
|
</ul>
|
| 62 |
|
|
</li>
|
| 63 |
|
|
<li><a class="reference" href="#backwards-compatibility" id="id6" name="id6">Backwards Compatibility</a></li>
|
| 64 |
|
|
<li><a class="reference" href="#references" id="id7" name="id7">References</a></li>
|
| 65 |
|
|
<li><a class="reference" href="#copyright" id="id8" name="id8">Copyright</a></li>
|
| 66 |
|
|
</ul>
|
| 67 |
|
|
</div>
|
| 68 |
|
|
<div class="section" id="abstract">
|
| 69 |
|
|
<h1><a class="toc-backref" href="#id2" name="abstract">Abstract</a></h1>
|
| 70 |
|
|
<p>This GLEP proposes the creation of a reliable hosting location for data (e.g.
|
| 71 |
|
|
sample code) associated with GLEPs.</p>
|
| 72 |
|
|
</div>
|
| 73 |
|
|
<div class="section" id="motivation">
|
| 74 |
|
|
<h1><a class="toc-backref" href="#id3" name="motivation">Motivation</a></h1>
|
| 75 |
|
|
<p>Some GLEPs come with non-trivial example files or code which are part of the
|
| 76 |
|
|
specification. There are two methods which have been used to handle this
|
| 77 |
|
|
previously:</p>
|
| 78 |
|
|
<ul class="simple">
|
| 79 |
|
|
<li>Include the code inline in the GLEP using a code (<tt class="docutils literal"><span class="pre">::</span></tt>) segment. This is
|
| 80 |
|
|
less than ideal for larger code samples as it leads to considerable clutter.</li>
|
| 81 |
|
|
<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
|
| 82 |
|
|
particularly reliable -- developers may leave or accidentally restructure
|
| 83 |
|
|
their webspace, and a GLEP is intended to be a <em>permanent</em> specification.</li>
|
| 84 |
|
|
</ul>
|
| 85 |
|
|
<p>This GLEP proposes that GLEP authors be allowed to make use of the main Gentoo
|
| 86 |
|
|
webserver for hosting content relevant to their GLEP.</p>
|
| 87 |
|
|
<div class="important">
|
| 88 |
|
|
<p class="first admonition-title">Important</p>
|
| 89 |
|
|
<p class="last">The hosting proposed is for files related to the <strong>proposal</strong>
|
| 90 |
|
|
(e.g. example code which clarifies part of the specification), not a full
|
| 91 |
|
|
implementation of the proposal.</p>
|
| 92 |
|
|
</div>
|
| 93 |
|
|
</div>
|
| 94 |
|
|
<div class="section" id="specification">
|
| 95 |
|
|
<h1><a class="toc-backref" href="#id4" name="specification">Specification</a></h1>
|
| 96 |
|
|
<p>Once a GLEP number has been allocated, developers (or the GLEP editors) may
|
| 97 |
|
|
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
|
| 98 |
|
|
GLEP's number) under the main GLEP directory. This directory may be used by
|
| 99 |
|
|
files which are part of the proposal.</p>
|
| 100 |
|
|
<p>Any hyperlinks to files inside this directory should use relative paths. This
|
| 101 |
|
|
prevents breakages in the case of directory structure changes.</p>
|
| 102 |
|
|
<p>GLEPs which use this directory may include an 'Example Files' heading with a
|
| 103 |
|
|
list of links to the associated files.</p>
|
| 104 |
|
|
<div class="section" id="example">
|
| 105 |
|
|
<h2><a class="toc-backref" href="#id5" name="example">Example</a></h2>
|
| 106 |
|
|
<p>Consider the following GLEP segment, which has been taken from a draft of
|
| 107 |
|
|
GLEP 42 <a class="footnote-reference" href="#glep-42" id="id1" name="id1">[1]</a>:</p>
|
| 108 |
|
|
<pre class="literal-block">
|
| 109 |
|
|
Example News Item
|
| 110 |
|
|
'''''''''''''''''
|
| 111 |
|
|
|
| 112 |
|
|
The following hypothetical news item could be used for an upgrade to the
|
| 113 |
|
|
``YourSQL`` database format which breaks forward compatibility. It should be
|
| 114 |
|
|
named ``2005-11/2005-11-01-yoursql-upgrades.en.txt``.
|
| 115 |
|
|
|
| 116 |
|
|
::
|
| 117 |
|
|
|
| 118 |
|
|
# Lots and lots of lines of example news item
|
| 119 |
|
|
</pre>
|
| 120 |
|
|
<p>The news item in question is clearly part of the proposal, but including it
|
| 121 |
|
|
inline is messy. Under this proposal, the main GLEP segment would read:</p>
|
| 122 |
|
|
<pre class="literal-block">
|
| 123 |
|
|
Example News Item
|
| 124 |
|
|
'''''''''''''''''
|
| 125 |
|
|
|
| 126 |
|
|
`This hypothetical news item`__ could be used for an upgrade to the
|
| 127 |
|
|
``YourSQL`` database format which breaks forward compatibility. It would be
|
| 128 |
|
|
named ``2005-11/2005-11-01-yoursql-upgrades.en.txt``.
|
| 129 |
|
|
|
| 130 |
|
|
.. __: glep-0042-extras/example-news-item.txt
|
| 131 |
|
|
</pre>
|
| 132 |
|
|
<p>The example news item would then be placed in
|
| 133 |
|
|
<tt class="docutils literal"><span class="pre">glep-0042-extras/example-news-item.txt</span></tt>.</p>
|
| 134 |
|
|
<p>Similar changes would be made for the longer example code segments. The GLEP
|
| 135 |
|
|
could also gain a new section along the lines of:</p>
|
| 136 |
|
|
<pre class="literal-block">
|
| 137 |
|
|
Example Files
|
| 138 |
|
|
=============
|
| 139 |
|
|
|
| 140 |
|
|
`example-news-item.txt <glep-0042-extras/example-news-item.txt>`_
|
| 141 |
|
|
An example news item.
|
| 142 |
|
|
`news-mailer.bash <glep-0042-extras/news-mailer.bash>`_
|
| 143 |
|
|
A ``bash`` script which delivers news items via email.
|
| 144 |
|
|
</pre>
|
| 145 |
|
|
</div>
|
| 146 |
|
|
</div>
|
| 147 |
|
|
<div class="section" id="backwards-compatibility">
|
| 148 |
|
|
<h1><a class="toc-backref" href="#id6" name="backwards-compatibility">Backwards Compatibility</a></h1>
|
| 149 |
|
|
<p>Not an issue.</p>
|
| 150 |
|
|
</div>
|
| 151 |
|
|
<div class="section" id="references">
|
| 152 |
|
|
<h1><a class="toc-backref" href="#id7" name="references">References</a></h1>
|
| 153 |
|
|
<table class="docutils footnote" frame="void" id="glep-42" rules="none">
|
| 154 |
|
|
<colgroup><col class="label" /><col /></colgroup>
|
| 155 |
|
|
<tbody valign="top">
|
| 156 |
|
|
<tr><td class="label"><a class="fn-backref" href="#id1" name="glep-42">[1]</a></td><td>GLEP 42: Critical news reporting, Ciaran McCreesh,
|
| 157 |
|
|
<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>
|
| 158 |
|
|
</tbody>
|
| 159 |
|
|
</table>
|
| 160 |
|
|
</div>
|
| 161 |
|
|
<div class="section" id="copyright">
|
| 162 |
|
|
<h1><a class="toc-backref" href="#id8" name="copyright">Copyright</a></h1>
|
| 163 |
|
|
<p>This document has been placed in the public domain.</p>
|
| 164 |
|
|
<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
|
| 165 |
|
|
</div>
|
| 166 |
|
|
|
| 167 |
|
|
</div>
|
| 168 |
|
|
<div class="footer">
|
| 169 |
|
|
<hr class="footer" />
|
| 170 |
|
|
<a class="reference" href="glep-0043.txt">View document source</a>.
|
| 171 |
|
|
Generated on: 2005-11-07 21:53 UTC.
|
| 172 |
|
|
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.
|
| 173 |
|
|
|
| 174 |
|
|
</div>
|
| 175 |
|
|
</body>
|
| 176 |
|
|
</html>
|
| 177 |
|
|
|
Parent Directory
| 
Revision Log
