en/glep/glep-0043.html

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
  <title>GLEP 43 -- GLEP File Hosting</title>
  <link rel="stylesheet" href="tools/glep.css" type="text/css" />
</head>
<body bgcolor="white">
<table class="navigation" cellpadding="0" cellspacing="0"
       width="100%" border="0">
<tr><td class="navicon" width="150" height="35">
<a href="http://www.gentoo.org/" title="Gentoo Linux Home Page">
<img src="http://www.gentoo.org/images/gentoo-new.gif" alt="[Gentoo]"
 border="0" width="150" height="35" /></a></td>
<td class="textlinks" align="left">
[<b><a href="http://www.gentoo.org/">Gentoo Linux Home</a></b>]
[<b><a href="http://www.gentoo.org/proj/en/glep">GLEP Index</a></b>]
[<b><a href="http://www.gentoo.org/proj/en/glep/glep-0043.txt">GLEP Source</a></b>]
</td></tr></table>
<table class="rfc2822 docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">GLEP:</th><td class="field-body">43</td>
</tr>
<tr class="field"><th class="field-name">Title:</th><td class="field-body">GLEP File Hosting</td>
</tr>
<tr class="field"><th class="field-name">Version:</th><td class="field-body">1.2</td>
</tr>
<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>
</tr>
<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>
</tr>
<tr class="field"><th class="field-name">Status:</th><td class="field-body">Draft</td>
</tr>
<tr class="field"><th class="field-name">Type:</th><td class="field-body">Informational</td>
</tr>
<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>
</tr>
<tr class="field"><th class="field-name">Created:</th><td class="field-body">7-Nov-2005</td>
</tr>
<tr class="field"><th class="field-name">Post-History:</th><td class="field-body">7-Nov-2005</td>
</tr>
</tbody>
</table>
<hr />
<div class="contents topic">
<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
<ul class="simple">
<li><a class="reference" href="#abstract" id="id2" name="id2">Abstract</a></li>
<li><a class="reference" href="#status" id="id3" name="id3">Status</a></li>
<li><a class="reference" href="#motivation" id="id4" name="id4">Motivation</a></li>
<li><a class="reference" href="#specification" id="id5" name="id5">Specification</a><ul>
<li><a class="reference" href="#example" id="id6" name="id6">Example</a></li>
</ul>
</li>
<li><a class="reference" href="#backwards-compatibility" id="id7" name="id7">Backwards Compatibility</a></li>
<li><a class="reference" href="#references" id="id8" name="id8">References</a></li>
<li><a class="reference" href="#copyright" id="id9" name="id9">Copyright</a></li>
</ul>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id2" id="abstract" name="abstract">Abstract</a></h1>
<p>This GLEP proposes the creation of a reliable hosting location for data (e.g.
sample code) associated with GLEPs.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id3" id="status" name="status">Status</a></h1>
<p>This GLEP has been approved by the GLEP editor and marked Final on
13 Nov. 2005.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id4" id="motivation" name="motivation">Motivation</a></h1>
<p>Some GLEPs come with non-trivial example files or code which are part of the
specification. There are two methods which have been used to handle this
previously:</p>
<ul class="simple">
<li>Include the code inline in the GLEP using a code (<tt class="docutils literal"><span class="pre">::</span></tt>) segment. This is
less than ideal for larger code samples as it leads to considerable clutter.</li>
<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
particularly reliable -- developers may leave or accidentally restructure
their webspace, and a GLEP is intended to be a <em>permanent</em> specification.</li>
</ul>
<p>This GLEP proposes that GLEP authors be allowed to make use of the main Gentoo
webserver for hosting content relevant to their GLEP.</p>
<div class="important">
<p class="first admonition-title">Important</p>
<p class="last">The hosting proposed is for files related to the <strong>proposal</strong>
(e.g. example code which clarifies part of the specification), not a full
implementation of the proposal.</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id5" id="specification" name="specification">Specification</a></h1>
<p>Once a GLEP number has been allocated, developers (or the GLEP editors) may
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
GLEP's number) under the main GLEP directory. This directory may be used by
files which are part of the proposal.</p>
<p>Any hyperlinks to files inside this directory should use relative paths. This
prevents breakages in the case of directory structure changes.</p>
<p>GLEPs which use this directory may include an 'Example Files' heading with a
list of links to the associated files.</p>
<div class="section">
<h2><a class="toc-backref" href="#id6" id="example" name="example">Example</a></h2>
<p>Consider the following GLEP segment, which has been taken from a draft of
GLEP 42 <a class="footnote-reference" href="#glep-42" id="id1" name="id1">[1]</a>:</p>
<pre class="literal-block">
Example News Item
'''''''''''''''''

The following hypothetical news item could be used for an upgrade to the
``YourSQL`` database format which breaks forward compatibility. It should be
named ``2005-11/2005-11-01-yoursql-upgrades.en.txt``.

::

    # Lots and lots of lines of example news item
</pre>
<p>The news item in question is clearly part of the proposal, but including it
inline is messy. Under this proposal, the main GLEP segment would read:</p>
<pre class="literal-block">
Example News Item
'''''''''''''''''

`This hypothetical news item`__ could be used for an upgrade to the
``YourSQL`` database format which breaks forward compatibility. It would be
named ``2005-11/2005-11-01-yoursql-upgrades.en.txt``.

.. __: glep-0042-extras/example-news-item.txt
</pre>
<p>The example news item would then be placed in
<tt class="docutils literal"><span class="pre">glep-0042-extras/example-news-item.txt</span></tt>.</p>
<p>Similar changes would be made for the longer example code segments. The GLEP
could also gain a new section along the lines of:</p>
<pre class="literal-block">
Example Files
=============

`example-news-item.txt &lt;glep-0042-extras/example-news-item.txt&gt;`_
    An example news item.
`news-mailer.bash &lt;glep-0042-extras/news-mailer.bash&gt;`_
    A ``bash`` script which delivers news items via email.
</pre>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id7" id="backwards-compatibility" name="backwards-compatibility">Backwards Compatibility</a></h1>
<p>Not an issue.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id8" id="references" name="references">References</a></h1>
<table class="docutils footnote" frame="void" id="glep-42" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1" name="glep-42">[1]</a></td><td>GLEP 42: Critical news reporting, Ciaran McCreesh,
<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>
</tbody>
</table>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id9" id="copyright" name="copyright">Copyright</a></h1>
<p>This document has been placed in the public domain.</p>
<!-- vim: set tw=80 fileencoding=utf-8 spell spelllang=en et : -->
</div>

</div>
<div class="footer">
<hr class="footer" />
<a class="reference" href="glep-0043.txt">View document source</a>.
Generated on: 2007-10-13 13:39 UTC.
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.

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