From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from lists.gentoo.org ([140.105.134.102] helo=robin.gentoo.org) by nuthatch.gentoo.org with esmtp (Exim 4.50) id 1EZF7p-0005xE-Cf for garchives@archives.gentoo.org; Mon, 07 Nov 2005 22:06:01 +0000 Received: from robin.gentoo.org (localhost [127.0.0.1]) by robin.gentoo.org (8.13.5/8.13.5) with SMTP id jA7M03a0021317; Mon, 7 Nov 2005 22:00:03 GMT Received: from smtp.gentoo.org (smtp.gentoo.org [134.68.220.30]) by robin.gentoo.org (8.13.5/8.13.5) with ESMTP id jA7LuU9E025037 for ; Mon, 7 Nov 2005 21:56:30 GMT Received: from 82-41-57-20.cable.ubr08.edin.blueyonder.co.uk ([82.41.57.20] helo=snowdrop.home) by smtp.gentoo.org with esmtpa (Exim 4.43) id 1EZEyb-00005s-EG for gentoo-dev@lists.gentoo.org; Mon, 07 Nov 2005 21:56:30 +0000 Received: from localhost.home ([127.0.0.1] helo=snowdrop.home) by snowdrop.home with esmtp (Exim 4.54) id 1EZEyP-0003nr-8a for gentoo-dev@lists.gentoo.org; Mon, 07 Nov 2005 21:56:17 +0000 Date: Mon, 7 Nov 2005 21:56:13 +0000 From: Ciaran McCreesh To: gentoo-dev@lists.gentoo.org Subject: [gentoo-dev] GLEP 43: GLEP File Hosting Message-ID: <20051107215613.1e895d72@snowdrop.home> X-Mailer: Sylpheed-Claws 1.9.99-rc2 (GTK+ 2.6.10; i686-pc-linux-gnu) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@gentoo.org Reply-to: gentoo-dev@lists.gentoo.org Mime-Version: 1.0 Content-Type: multipart/signed; boundary="Signature_Mon__7_Nov_2005_21_56_13_+0000_g//r3cQK/u_H.N3P"; protocol="application/pgp-signature"; micalg=PGP-SHA1 X-Archives-Salt: 18abccd6-4e40-4e8d-be4d-e4618904b168 X-Archives-Hash: 7a80b9ffb89ed810ea4985e1985845e9 --Signature_Mon__7_Nov_2005_21_56_13_+0000_g//r3cQK/u_H.N3P Content-Type: multipart/mixed; boundary="Multipart_Mon__7_Nov_2005_21_56_13_+0000_zs1c.fPboQt/_FBW" --Multipart_Mon__7_Nov_2005_21_56_13_+0000_zs1c.fPboQt/_FBW Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: quoted-printable Content-Disposition: inline Ok, this is a change to the GLEP process, so it itself needs to be a GLEP... All it does is propose that GLEPs be allowed to stick example code in a subdirectory rather than having to inline things or shove them off on someone's devspace. Text version attached. An HTML version will be up on the main site whenever the web nodes next sync -- may be wise to read that instead if you aren't familiar with RST :: blocks. --=20 Ciaran McCreesh : Gentoo Developer (Anti-XML, anti-newbie conspiracy) Mail : ciaranm at gentoo.org Web : http://dev.gentoo.org/~ciaranm --Multipart_Mon__7_Nov_2005_21_56_13_+0000_zs1c.fPboQt/_FBW Content-Type: text/plain; name=glep-0043.txt Content-Transfer-Encoding: quoted-printable Content-Disposition: attachment; filename=glep-0043.txt GLEP: 43 Title: GLEP File Hosting Version: $Revision: 1.1 $ Author: Ciaran McCreesh Last-Modified: $Date: 2005/11/07 21:55:08 $ Status: Draft Type: Informational Content-Type: text/x-rst Created: 7-Nov-2005 Post-History: 7-Nov-2005 Abstract =3D=3D=3D=3D=3D=3D=3D=3D This GLEP proposes the creation of a reliable hosting location for data (e.= g. sample code) associated with GLEPs. Motivation =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D 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: * Include the code inline in the GLEP using a code (``::``) segment. This is less than ideal for larger code samples as it leads to considerable clutt= er. * Place the files on a developer's webspace on ``dev.gentoo.org``. This is = not particularly reliable -- developers may leave or accidentally restructure their webspace, and a GLEP is intended to be a *permanent* specification. This GLEP proposes that GLEP authors be allowed to make use of the main Gen= too webserver for hosting content relevant to their GLEP. .. Important:: The hosting proposed is for files related to the **proposal** (e.g. example code which clarifies part of the specification), not a full implementation of the proposal. Specification =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Once a GLEP number has been allocated, developers (or the GLEP editors) may create a directory in CVS named ``glep-xxxx-extras/`` (where ``xxxx`` is the GLEP's number) under the main GLEP directory. This directory may be used by files which are part of the proposal. Any hyperlinks to files inside this directory should use relative paths. Th= is prevents breakages in the case of directory structure changes. GLEPs which use this directory may include an 'Example Files' heading with a list of links to the associated files. Example ------- Consider the following GLEP segment, which has been taken from a draft of GLEP 42 [#glep-42]_: :: Example News Item ''''''''''''''''' The following hypothetical news item could be used for an upgrade to the ``YourSQL`` database format which breaks forward compatibility. It shou= ld be named ``2005-11/2005-11-01-yoursql-upgrades.en.txt``. :: # Lots and lots of lines of example news item 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: :: Example News Item ''''''''''''''''' `This hypothetical news item`__ could be used for an upgrade to the ``YourSQL`` database format which breaks forward compatibility. It woul= d be named ``2005-11/2005-11-01-yoursql-upgrades.en.txt``. .. __: glep-0042-extras/example-news-item.txt The example news item would then be placed in ``glep-0042-extras/example-news-item.txt``\. Similar changes would be made for the longer example code segments. The GLEP could also gain a new section along the lines of: :: Example Files =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D `example-news-item.txt `_ An example news item. `news-mailer.bash `_ A ``bash`` script which delivers news items via email. Backwards Compatibility =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Not an issue. References =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D .. [#glep-42] GLEP 42: Critical news reporting, Ciaran McCreesh, http://www.gentoo.org/proj/en/glep/glep-0042.html Copyright =3D=3D=3D=3D=3D=3D=3D=3D=3D This document has been placed in the public domain. .. vim: set tw=3D80 fileencoding=3Dutf-8 spell spelllang=3Den et : --Multipart_Mon__7_Nov_2005_21_56_13_+0000_zs1c.fPboQt/_FBW-- --Signature_Mon__7_Nov_2005_21_56_13_+0000_g//r3cQK/u_H.N3P Content-Type: application/pgp-signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.1 (GNU/Linux) iD8DBQFDb82A96zL6DUtXhERAg6rAKCPKDtUtJGyyzYdBSxnzHODeYDbxwCfXREz BwpsRsVwHKU/HKQvPsyYHiY= =K/V1 -----END PGP SIGNATURE----- --Signature_Mon__7_Nov_2005_21_56_13_+0000_g//r3cQK/u_H.N3P-- -- gentoo-dev@gentoo.org mailing list