• [gentoo-dev] [PATCH v2 1/3] greadme.eclass: new eclass

    From Florian Schmaus@21:1/5 to All on Tue Jan 9 09:40:02 2024
    This new eclass is similar to readme.gentoo-r1.eclass. The main
    differences are as follows. Firstly, it also displays the doc file
    contents if they have changed. Secondly, it provides a convenient API to install the doc file via stdin.

    Furthermore, this eclass dos not store the doc file's contents in an environment variable, which helps to keep the environment size of
    ebuilds using the eclass small.

    Signed-off-by: Florian Schmaus <flow@gentoo.org>
    ---
    eclass/greadme.eclass | 307 ++++++++++++++++++++++++++++++++++++++++++
    1 file changed, 307 insertions(+)
    create mode 100644 eclass/greadme.eclass

    diff --git a/eclass/greadme.eclass b/eclass/greadme.eclass
    new file mode 100644
    index 000000000000..25e0210406c1
    --- /dev/null
    +++ b/eclass/greadme.eclass
    @@ -0,0 +1,307 @@
    +# Copyright 1999-2024 Gentoo Authors
    +# Distributed under the terms of the GNU General Public License v2
    +
    +# @ECLASS: greadme.eclass
    +# @MAINTAINER:
    +# Florian Schmaus <flow@gentoo.org>
    +# @AUTHOR:
    +# Author: Florian Schmaus <flow@gentoo.org>
    +# @SUPPORTED_EAPIS: 6 7 8
    +# @BLURB: install a doc file, that will be conditionally shown via elog messages
    +# @DESCRIPTION:
    +# An eclass for installing a README.gentoo doc file recording tips
    +# shown via elog messages. With this eclass, those elog messages will only be +# shown at first package installation or if the contents of the file have changed.
    +# Furthermore, a file for later reviewing will be installed under
    +
  • From Florian Schmaus@21:1/5 to All on Tue Jan 9 09:40:02 2024
    Signed-off-by: Florian Schmaus <flow@gentoo.org>
    ---
    eclass/0000-cover-letter.patch | 49 ++++
    eclass/0001-greadme.eclass-new-eclass.patch | 305 ++++++++++++++++++++
    eclass/unpacker.eclass | 7 +
    3 files changed, 361 insertions(+)
    create mode 100644 eclass/0000-cover-letter.patch
    create mode 100644 eclass/0001-greadme.eclass-new-eclass.patch

    diff --git a/eclass/0000-cover-letter.patch b/eclass/0000-cover-letter.patch new file mode 100644
    index 000000000000..2e162d419a44
    --- /dev/null
    +++ b/eclass/0000-cover-letter.patch
    @@ -0,0 +1,49 @@
    +From edff06160e33b361c9d6a7e273fc7808337c4518 Mon Sep 17 00:00:00 2001
    +From: Florian Schmaus <flow@gentoo.org>
    +Date: Sat, 6 Jan 2024 17:44:44 +0100
    +Subject: [PATCH 0/1] [RFC] greadme.eclass
    +
    +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.ecl