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 EB9D715803E for ; Sat, 6 Jan 2024 17:02:07 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id AC1AF2BC038; Sat, 6 Jan 2024 17:02:03 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.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 6CE412BC018 for ; Sat, 6 Jan 2024 17:02:03 +0000 (UTC) From: Florian Schmaus To: gentoo-dev@lists.gentoo.org Cc: pacho@gentoo.org, Florian Schmaus Subject: [gentoo-dev] [PATCH 0/1] [RFC] greadme.eclass Date: Sat, 6 Jan 2024 18:01:47 +0100 Message-ID: <20240106170153.1581902-1-flow@gentoo.org> X-Mailer: git-send-email 2.41.0 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-Transfer-Encoding: 8bit X-Archives-Salt: 581b7b84-a796-40f7-bc37-073d9449d918 X-Archives-Hash: b1e165888d3ede6f015c939442c881db 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. 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. The following patch includes a new eclass named "greadme", that addresses those shortcomings of readme.gentoo-r1.eclass and hopefully can be seen as a general overhaul. This is a first draft of the eclass and therefore I'd like to ask for feedback. The greadme.eclass contains some TODO items at the end of its @DESCRIPTION. 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]. 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. Thanks for reviewing the eclass. Florian Schmaus (1): greadme.eclass: new eclass eclass/greadme.eclass | 281 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 281 insertions(+) create mode 100644 eclass/greadme.eclass -- 2.41.0