From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) by finch.gentoo.org (Postfix) with ESMTP id ADBD713875C for ; Wed, 30 Jan 2013 08:23:28 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 225B621C01C; Wed, 30 Jan 2013 08:23:24 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 1407C21C003 for ; Wed, 30 Jan 2013 08:23:23 +0000 (UTC) Received: from sera-20.lan (9-54.105-92.cust.bluewin.ch [92.105.54.9]) (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits)) (No client certificate requested) (Authenticated sender: sera) by smtp.gentoo.org (Postfix) with ESMTPSA id 73E6733DBCF for ; Wed, 30 Jan 2013 08:23:21 +0000 (UTC) Date: Wed, 30 Jan 2013 09:27:00 +0100 From: Ralph Sennhauser To: gentoo-dev@lists.gentoo.org Subject: Re: readme.gentoo.eclass: use echo -e instead of plain echo (Was: Re: [gentoo-dev] readme.gentoo.eclass: Add a DISABLE_AUTOFORMATTING variable= Message-ID: <20130130092700.1acdce88@sera-20.lan> In-Reply-To: <1359496046.2927.55.camel@belkin4> References: <1359295221.2927.24.camel@belkin4> <201301271305.54346.vapier@gentoo.org> <1359310887.2927.39.camel@belkin4> <201301272337.06614.vapier@gentoo.org> <1359401406.2927.49.camel@belkin4> <1359496046.2927.55.camel@belkin4> Organization: Gentoo Linux X-Mailer: Claws Mail 3.9.0 (GTK+ 2.24.12; x86_64-pc-linux-gnu) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@lists.gentoo.org Reply-to: gentoo-dev@lists.gentoo.org Mime-Version: 1.0 Content-Type: multipart/signed; micalg=PGP-SHA1; boundary="Sig_/3sh.tRvikGgAWYEH93BzJlj"; protocol="application/pgp-signature" X-Archives-Salt: 6d97e48d-629b-4d79-bd9c-baaf350bc30b X-Archives-Hash: a753e2382abe12327b1a51dade34d3b3 --Sig_/3sh.tRvikGgAWYEH93BzJlj Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: quoted-printable On Tue, 29 Jan 2013 22:47:26 +0100 Pacho Ramos wrote: > Also, autoformatting will help to prevent every package setting > messages with different lines length (in some cases really long lines > that I finally reported some bugs in the past to get them fitting in > "standard" 80 characters per line).=20 I agree with you, there should be consistency as far as reasonable. Formatting certainly is a valid means. Some sort of tags could be used if formatting isn't desired. Ie similar to eclass-manpages. The eclass blurb: readme.gentoo - An eclass for installing a README.gentoo doc file recording tips I know it started out as CONFIGURATION, but README.gentoo is generic enough to contain other package specific info a user or upstream developer might be interested in. What I have in mind right now are patches. This could look like the following in an ebuild: README_GENTOO_PATCHES=3D( "${FILESDIR}"/*.patch ) epatch "${README_GENTOO_PATCHES[@]}" Then the eclass generates for each patch in README_GENTOO_PATCHES a note within a standard section containing patch name, author, subject line. This needs something similar enough to a git format patch to magically work though, but might be a nice addition and would help the goal of consistency. Also git-format-patch like patches are anyway preferable to dangling patches with maybe a bug number in the ebuild at best. --Sig_/3sh.tRvikGgAWYEH93BzJlj Content-Type: application/pgp-signature; name=signature.asc Content-Disposition: attachment; filename=signature.asc -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.19 (GNU/Linux) iQEcBAEBAgAGBQJRCNlqAAoJELjwI6Q8XPdajuIIALRbgMCaRNIenHeYCgxLQlIJ 88Ez+fc0uoE2TFHZNlB6Hj85lAsiX90jgkAeAr/u5RDvWyze5HdM/xkk256n2+lw f849fWa9pJYR5QLV6FdrH2lDluZnNpwSQyNUa5MGthqK3s+403Sjz0U7Ld8lkfqV i1Q9StDAEqwGedHaTaVc8dnumcMIiLqWgTHkuZWGSXrTppqQlJk3CqxwX2aEm6YJ fMDfUa8uGoq+RFZQyEdgXoCf2al1SjKKyLjXOGi6m5uiuQAL0wpV2aGo9xSK8Zna 9EJpS3/1BptyH6V16yL6hFQHIXpmDggzhZwvuGqCQn6kF1jyZ1VZUZ8iPi72opw= =j+C+ -----END PGP SIGNATURE----- --Sig_/3sh.tRvikGgAWYEH93BzJlj--