From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 17381158004 for ; Wed, 10 Jan 2024 13:59:03 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 84D9FE2AEC; Wed, 10 Jan 2024 13:58:59 +0000 (UTC) Received: from smtp.gentoo.org (mail.gentoo.org [IPv6:2001:470:ea4a:1:5054:ff:fec7:86e4]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 2855FE2AE9 for ; Wed, 10 Jan 2024 13:58:59 +0000 (UTC) From: Ulrich Mueller To: Florian Schmaus Cc: Sam James , gentoo-dev@lists.gentoo.org, pacho@gentoo.org Subject: Re: [gentoo-dev] [PATCH 0/1] [RFC] greadme.eclass In-Reply-To: (Florian Schmaus's message of "Wed, 10 Jan 2024 14:23:11 +0100") References: <20240106170153.1581902-1-flow@gentoo.org> <87r0ipmos3.fsf@gentoo.org> Date: Wed, 10 Jan 2024 14:58:53 +0100 Message-ID: User-Agent: Gnus/5.13 (Gnus v5.13) 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 X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" X-Archives-Salt: 5a787de8-27ce-4d1c-b3c6-7844c2ca9c5c X-Archives-Hash: 6429e7977f981486e2c30ab3e84066ce --=-=-= Content-Type: text/plain >>>>> On Wed, 10 Jan 2024, Florian Schmaus wrote: > On 10/01/2024 12.04, Sam James wrote: >> 1) The name seems odd (why not readme.gentoo-r2)? >> 2) Why can't the existing eclass be improved? > Both points, the name of the eclass and the question if this should be > added to the existing eclass or as a new eclass, are absolutely *no* > hill I want to die on. > What I *really* care about is having the functionality that there is a > readme eclass that *also* shows the elog message if the README's > content changed (and not just on the first installation of the > package). Looks like readme.gentoo-r1 already gives you control over this: # If you want to show them always, please set FORCE_PRINT_ELOG to a non empty # value in your ebuild before this function is called. # This can be useful when, for example, DOC_CONTENTS is modified, then, you can # rely on specific REPLACING_VERSIONS handling in your ebuild to print messages # when people update from versions still providing old message. >> 4) The compression deal seems not worth bothering with. > Just to clarify: you are agreeing that excluding the readme doc from > being compressed is fine? Please respect the user's compression settings there. IMHO overriding them with docompress -x is a big no-no. > [...] > It exports phase functions, which readme.gentoo-r1 does not. Looking at the history, readme.gentoo[-r0] used to export phase functions: https://gitweb.gentoo.org/repo/gentoo.git/tree/eclass/readme.gentoo.eclass?id=1e7b2242de29ec60105df1ef31939aed85a8b0eb#n32 It turned out to be a bad design choice, so -r1 no longer does that. > The readme.gentoo-r1 eclass always shoves the full content of the > readme into an environment variable. Why is this a problem? Ulrich --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQFDBAEBCAAtFiEEtDnZ1O9xIP68rzDbUYgzUIhBXi4FAmWeop0PHHVsbUBnZW50 b28ub3JnAAoJEFGIM1CIQV4u94gH/iDSL87eiV9yKFDoQPfCXgmrmWboQ/llhJdd +1hWz2APO+/LKZ2XcrJTigpWenaLdJpnjRTyBhxvkGasuVwXgELlgqDmKFYcDecW L8f+ekJuErq/slpFu/3vNXIKivAnXF2B2LPzGyOZi2vvuk+6y8yPQxXZKlyg+mKh bYZS5lcfeqFYmdtdBJUDGqFkG4LnTeFVjSZBieeM4dsWTlquQSDWQJghGqErxwdv WlRG3Hcdg+YGSQMRgm4ee3xDGGhr9flz5jZSZiwJX+iDcBULvLEhEoy6G3j7VJ7H joqQKPwa/NtZNV8ScxbYg1N/AEX9JZkhTWU5xm8M1vxsYdNgFy4= =e7W1 -----END PGP SIGNATURE----- --=-=-=--