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 1EXx0I-0007wX-KO for garchives@archives.gentoo.org; Fri, 04 Nov 2005 08:32:55 +0000 Received: from robin.gentoo.org (localhost [127.0.0.1]) by robin.gentoo.org (8.13.5/8.13.5) with SMTP id jA48VTwa017147; Fri, 4 Nov 2005 08:31:29 GMT Received: from smtpauth01.mail.atl.earthlink.net (smtpauth01.mail.atl.earthlink.net [209.86.89.61]) by robin.gentoo.org (8.13.5/8.13.5) with ESMTP id jA48Rrla022795 for ; Fri, 4 Nov 2005 08:27:54 GMT Received: from [63.201.15.195] (helo=sarge.electronerdia.net) by smtpauth01.mail.atl.earthlink.net with asmtp (Exim 4.34) id 1EXwvR-0005Pe-9q for gentoo-dev@lists.gentoo.org; Fri, 04 Nov 2005 03:27:53 -0500 Received: from sheila.electronerdia.net (sheila.electronerdia.net [192.168.1.32]) by sarge.electronerdia.net (Postfix) with ESMTP id 7154CFF1FA for ; Fri, 4 Nov 2005 00:30:33 -0800 (PST) From: John Myers To: gentoo-dev@lists.gentoo.org Subject: Re: [gentoo-dev] GLEP ??: Critical News Reporting User-Agent: KMail/1.8.3 References: <20051101015125.1cc45eb4@snowdrop.home> <20051104020844.GB29252@dst.grantgoodyear.org> <436AF548.8070406@ieee.org> In-Reply-To: <436AF548.8070406@ieee.org> 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 Date: Fri, 4 Nov 2005 00:32:20 -0800 Content-Type: multipart/signed; boundary="nextPart3110512.QSZfTOWhEu"; protocol="application/pgp-signature"; micalg=pgp-sha1 Content-Transfer-Encoding: 7bit Message-Id: <200511040032.25592.electronerd@monolith3d.com> X-ELNK-Trace: 8839a2c17b2169aa1aa676d7e74259b7b3291a7d08dfec7969aa5be776bda217bf2977a2c91f5577350badd9bab72f9c350badd9bab72f9c350badd9bab72f9c X-Originating-IP: 63.201.15.195 X-Archives-Salt: df2ea9ce-7ea5-492f-81a9-3451ba268ae9 X-Archives-Hash: 1b205051b3e6e4dd5eb7bb8f35a6ca9e --nextPart3110512.QSZfTOWhEu Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Content-Disposition: inline [[ACK! I sent this out from the wrong address before. Hope you don't get it= =20 twice!]] On Thursday 03 November 2005 21:44, Nathan L. Adams wrote: > No, I happen to understand the that point. Emerge outputting a short > summary is great. But the GLEP should cover the "hey mr. end user, the > central repository for errata/full fledged migration guides is here: > [insert url]" as well. [snip] > I happen to think that the assumption that the errata are going to be > small is a bad one. I think if errata is neccessary in the first place > then its going to be something larger than a screen's worth of console > output and worth the supposed trouble of GuideXML. So why not approach > it from the GuideXML end first, and extract the summary from that? Here's an idea for a compromise solution. Sorry it's so messy: The errata entries would consist of two files per language: =2D An emerge news file, identical to the format ciaranm proposed. This file would give a very general notice of the issue, such as that=20 given as an example in the GLEP, as well as containing the=20 machine-readable commands for portage to control display. This file's name would end in .news..txt =2D A GuideXML-formatted errata document. This would be the actual migration guide, such as the contents of the http://www.gentoo.org/doc/en/yoursql-upgrading.xml referenced by the example. This file's name would end in .guide..xml =2D The leading part of the filename would be as in ciaranm's GLEP Once it is time for the errata item to be published (after review, etc.), t= he=20 files would be placed in a standard location, where an automated process=20 would pick them up. The news files would be transferred to the Portage tree= =20 for emerge to pick up, and simultaneously published to a central errata=20 website, e.g. http://errata.gentoo.org/. On the errata website, *all* errat= a=20 notices would be published to its front page, unless specified differently = by=20 each individual user (perhaps a feature storing filters in a cookie). Each= =20 entry in the list would contain at least the publication date, the title of= =20 the news item as a link to a news item page, and the title of the guideXML= =20 document as a link to the document.=20 Errata items would be accessible in a uniform namespace with names derived= =20 from their source filenames. For example: 2005-11/2005-11-01-mysql-4.0-4.1-upgrade.news.en.txt 2005-11/2005-11-01-mysql-4.0-4.1-upgrade.guide.en.xml might become: http://errata.gentoo.org/2005-11-01-mysql-4.0-4.1-upgrade/en/ http://errata.gentoo.org/2005-11-01-mysql-4.0-4.1-upgrade/en/guide.xml =20 =46or user convenience, URLs with language codes the text is not yet transl= ated=20 to, as well as URLs without a language code, should be redirected to the=20 English version. Errata items may be published in other areas for wider exposure, but should= =20 always contain a link back to the main source. The news item page would contain a copy of the news text typeset in a=20 fixed-width font, and with links made clickable, as well as a prominent lin= k=20 to the GuideXML document. The title of the page should be the title of the= =20 news item, and the title of the link to the GuideXML page should be the tit= le=20 of the GuideXML document. Questions? Comments?=20 --nextPart3110512.QSZfTOWhEu Content-Type: application/pgp-signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.2-ecc0.1.6 (GNU/Linux) iD8DBQBDaxyZ61oU2vmzgqgRAuybAKDAoOPCNII55nvwANpSoqSAAcbvUwCgmCrZ GlnOZktnWOqvjev5pjkUVek= =ffp1 -----END PGP SIGNATURE----- --nextPart3110512.QSZfTOWhEu-- -- gentoo-dev@gentoo.org mailing list