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 AC5D915803E for ; Sat, 6 Jan 2024 17:21:48 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 06E482BC037; Sat, 6 Jan 2024 17:21:45 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.gentoo.org [140.211.166.183]) (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 AE61D2BC019 for ; Sat, 6 Jan 2024 17:21:44 +0000 (UTC) Message-ID: <1bd554f569029d8d99d315fa2d965ca63e76dbb7.camel@gentoo.org> Subject: Re: [gentoo-dev] [PATCH 0/1] [RFC] greadme.eclass From: =?UTF-8?Q?Micha=C5=82_G=C3=B3rny?= To: gentoo-dev@lists.gentoo.org Cc: pacho@gentoo.org, Florian Schmaus Date: Sat, 06 Jan 2024 18:21:39 +0100 In-Reply-To: <20240106170153.1581902-1-flow@gentoo.org> References: <20240106170153.1581902-1-flow@gentoo.org> Organization: Gentoo Content-Type: multipart/signed; micalg="pgp-sha512"; protocol="application/pgp-signature"; boundary="=-i/Ax4qBFu/Z5GrDrxjDc" User-Agent: Evolution 3.50.3 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 X-Archives-Salt: acf2bc35-0f27-4bb8-89a8-0b219d041819 X-Archives-Hash: fc8f9d24ff2e1bd836e9936f7d6142cf --=-i/Ax4qBFu/Z5GrDrxjDc Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable On Sat, 2024-01-06 at 18:01 +0100, Florian Schmaus wrote: > I really like the functionality of readme.gentoo-r1.eclass, as it > allows to communicate Gentoo-specific information about a package to > the user. Especially as it improves the signal-to-noise ratio of > messages arriving to our users. >=20 > However, readme.gentoo-r1.eclass will only show this information on > new installs, but not if the information changed. This is a major > drawback. Furthermore, readme.gentoo-r1.eclass does not provide an API > to assemble the information via heredoc. Are you implying that readme.gentoo-r1 is unfixable and you need to start over, and have a third generation of eclasses to install a readme file? > The main item is doc compression. Right now, greadme.eclass defaults > to add the readme doc to the compression exclusion list via > "docompress -x". A mode where the readme doc is compressed, just as > readme.gentoo-r1.eclass does, can be activated by setting > _GREADME_COMPRESS. However, I believe this mode is fragile as it can > not be guaranteed that a binary for the used compression algorithms is > installed on the host [1]. Dangling reference here. In any case, documentation compression is a standard feature of the package manager. If it doesn't work for whatever reason, I'd rather see you focus on find a good solution rather than working it around via abusing `docompress -x`. It's basically a case of "standard feature X doesn't work for me sometimes, so I now randomly disable X via my eclass, and hope nobody notices". > I believe it is reasonable to simply install the readme doc > uncompressed, since they are typically only a few lines long. However, > if anyone can point out a way to achieve the desired functionality with > a compressed readme doc, then please let me know. The compression mechanism automatically detects when the file is too small to be worth compressing. See PORTAGE_DOCOMPRESS_SIZE_LIMIT. --=20 Best regards, Micha=C5=82 G=C3=B3rny --=-i/Ax4qBFu/Z5GrDrxjDc Content-Type: application/pgp-signature; name="signature.asc" Content-Description: This is a digitally signed message part -----BEGIN PGP SIGNATURE----- iQFGBAABCgAwFiEEx2qEUJQJjSjMiybFY5ra4jKeJA4FAmWZjCMSHG1nb3JueUBn ZW50b28ub3JnAAoJEGOa2uIyniQOTPEIAIWZcwy1SLlra1ugLDRLhxihB2kp4JoF JEHGh7j3HbJs1FpthxwQ0EwtRPeLDvi9uJIKijLBoLJfcQ4Jh/L936yzSomWF2fo RmDEMFanccasWgdCOYgdibs0/l1wijfzWk4p6EXY8r6tLuTeyPd8zcoUrrhXpY1Z iUqmEbMLthTFH6jBJo1Awgt2QOGZWydSB0/q4tgKLLFn1karGZY1mIFAvubppbPz 6aR1CFw7PSsDriX9WvfBZ4oF8mcn9KghCkr0qqLrVIAPwhTT/BeNL132pzkZ/GSB cnmtvphXOOXWyjt1CoHsyPj4Ycr9eaT/wgyuCA3T3Th1UHXpjLyhncg= =GG69 -----END PGP SIGNATURE----- --=-i/Ax4qBFu/Z5GrDrxjDc--