From: Florian Schmaus <flow@gentoo.org>
To: Ulrich Mueller <ulm@gentoo.org>, gentoo-dev@lists.gentoo.org
Cc: Sam James <sam@gentoo.org>, pacho@gentoo.org
Subject: Re: [gentoo-dev] [PATCH 0/1] [RFC] greadme.eclass
Date: Wed, 10 Jan 2024 15:30:28 +0100 [thread overview]
Message-ID: <93425f77-7995-4040-9b4f-243216dcf42b@gentoo.org> (raw)
In-Reply-To: <ujzoh47du@gentoo.org>
[-- Attachment #1.1.1: Type: text/plain, Size: 2473 bytes --]
On 10/01/2024 14.58, Ulrich Mueller wrote:
>>>>>> 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.
It is easy to forget setting FORCE_PRINT_ELOG, just as it is easy to
forget to unset it again.
An automatism is always preferable over a manual solution.
>>> 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.
Then why does "docompress -x" exist at all?
There seems to be a big win-win if we override the compression settingin
this case.
>> 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.
Interesting find.
It is not obvious to me why the eclass exporting phase function should
is a bad design choice.
@pacho: could you shed some light into this?
>> The readme.gentoo-r1 eclass always shoves the full content of the
>> readme into an environment variable.
>
> Why is this a problem?
Nobody described that as a problem. Not adding stuff into the
environment is simply nice to have.
- Flow
[-- Attachment #1.1.2: OpenPGP public key --]
[-- Type: application/pgp-keys, Size: 17273 bytes --]
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 618 bytes --]
next prev parent reply other threads:[~2024-01-10 14:30 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-06 17:01 [gentoo-dev] [PATCH 0/1] [RFC] greadme.eclass Florian Schmaus
2024-01-06 17:01 ` [gentoo-dev] [PATCH 1/1] greadme.eclass: new eclass Florian Schmaus
2024-01-06 17:21 ` [gentoo-dev] [PATCH 0/1] [RFC] greadme.eclass Michał Górny
2024-01-09 8:30 ` Florian Schmaus
2024-01-09 8:39 ` [gentoo-dev] [PATCH v2 1/3] greadme.eclass: new eclass Florian Schmaus
2024-01-09 8:39 ` [gentoo-dev] [PATCH v2 2/3] add UNPACKER_NO_BANNER variable Florian Schmaus
2024-01-09 8:45 ` [gentoo-dev] " Florian Schmaus
2024-01-09 8:39 ` [gentoo-dev] [PATCH v2 3/3] greadme.eclass: set UNPACKER_NO_BANNER Florian Schmaus
2024-01-09 11:23 ` [gentoo-dev] [PATCH v2 1/3] greadme.eclass: new eclass David Seifert
2024-01-09 11:30 ` Florian Schmaus
2024-06-02 13:57 ` [gentoo-dev] [PATCH 0/4] Improve readme.gentoo-r1.eclass Florian Schmaus
2024-06-02 13:57 ` [gentoo-dev] [PATCH 1/4] readme.gentoo-r1.eclass: display readme if content changed (or fresh install) Florian Schmaus
2024-06-02 15:34 ` Ulrich Mueller
2024-06-02 15:48 ` Eli Schwartz
2024-06-02 16:28 ` Ulrich Mueller
2024-06-02 17:48 ` Florian Schmaus
2024-06-02 17:51 ` Eli Schwartz
2024-06-02 18:24 ` Ulrich Mueller
2024-06-04 15:15 ` Florian Schmaus
2024-06-04 17:45 ` Ulrich Mueller
2024-06-04 18:28 ` Florian Schmaus
2024-06-04 18:33 ` Eli Schwartz
2024-06-04 18:40 ` Ulrich Mueller
2024-06-04 18:37 ` Ionen Wolkens
2024-06-04 18:59 ` Ionen Wolkens
2024-06-02 16:16 ` Florian Schmaus
2024-06-02 13:57 ` [gentoo-dev] [PATCH 2/4] readme.gentoo-r1.eclass: use _GREADME_TMP_FILE in existing code Florian Schmaus
2024-06-02 13:57 ` [gentoo-dev] [PATCH 3/4] readme.gentoo-r1.eclass: add readme.gentoo_stdin() Florian Schmaus
2024-06-02 13:57 ` [gentoo-dev] [PATCH 4/4] readme.gentoo-r1.eclass: add readme.gentoo_file() Florian Schmaus
2024-06-02 15:25 ` [gentoo-dev] [PATCH 0/4] Improve readme.gentoo-r1.eclass Ulrich Mueller
2024-06-02 16:12 ` Florian Schmaus
2024-06-02 16:40 ` Ulrich Mueller
2024-06-02 17:34 ` Florian Schmaus
2024-01-09 9:59 ` [gentoo-dev] [PATCH 0/1] [RFC] greadme.eclass Michał Górny
2024-01-09 10:39 ` Florian Schmaus
2024-01-09 10:43 ` Michał Górny
2024-01-09 10:47 ` Florian Schmaus
2024-01-10 11:04 ` Sam James
2024-01-10 13:23 ` Florian Schmaus
2024-01-10 13:58 ` Ulrich Mueller
2024-01-10 14:30 ` Florian Schmaus [this message]
2024-01-10 15:10 ` Ulrich Mueller
2024-01-10 15:54 ` Florian Schmaus
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=93425f77-7995-4040-9b4f-243216dcf42b@gentoo.org \
--to=flow@gentoo.org \
--cc=gentoo-dev@lists.gentoo.org \
--cc=pacho@gentoo.org \
--cc=sam@gentoo.org \
--cc=ulm@gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox