Gentoo Archives: gentoo-dev

From: Sam James <sam@g.o>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] [RFC] Moving <maintainer/> <name/>s outta metadata.xml, into a consistent mapping
Date: Thu, 07 Apr 2022 23:24:50
Message-Id: 9B0E1A82-6D2E-40D4-A3B8-2D7FEAFEF552@gentoo.org
In Reply to: Re: [gentoo-dev] [RFC] Moving s outta metadata.xml, into a consistent mapping by Matt Turner
1 > On 8 Apr 2022, at 00:07, Matt Turner <mattst88@g.o> wrote:
2 >
3 > On Thu, Apr 7, 2022 at 11:42 AM Michał Górny <mgorny@g.o> wrote:
4 >>
5 >> Hello,
6 >>
7 >> Right now we're keeping both email addresses (obligatory) and names
8 >> (optional) for downstream maintainers in metadata.xml. The way I see
9 >> it, there are three problems with that:
10 >>
11 >> 1. As noticed on IRC lately, a few devs haven't been listing their names
12 >> at all, resulting in these names being missing from packages.g.o.
13 >>
14 >> 2. Not all names are listed consistently. This is especially the case
15 >> for projects. When you want to group everything by maintainer, which
16 >> name should be used?
17 >>
18 >> 3. In the end, listing the same names all over the place is a lot of
19 >> redundancy.
20 >>
21 >>
22 >> I'd like to propose that we deprecate <name/> for downstream
23 >> maintainers, and instead work towards using an additional mapping from
24 >> maintainer email addresses to their names.
25 >>
26 >> a. For projects, we can simply use projects.xml. We already require
27 >> that all type="project" maintainers correspond to entries
28 >> in projects.xml, so we should be good here.
29 >>
30 >> b. For human maintainers, I think we can use metadata/AUTHORS. This is
31 >> pretty much killing two birds with one stone -- we could finally getting
32 >> the file more complete, and at the same time use it to provide names for
33 >> maintainers.
34 >>
35 >> While keeping names in metadata.xml has the advantage that they are
36 >> immediately available (provided that they are actually listed there),
37 >> I don't think this is really a show-stopper.
38 >
39 > Sounds like a good plan to me.
40
41 Yep. It also has a nice consequence of allowing AUTHORS to be used as a mailmap
42 for git (although git doesn't respect symlinks for mailmap, so we'd need to tell
43 people to set it with the config option, but still.)
44
45 The main value for me is in making AUTHORS more useful. If it has to exist,
46 we should use it properly.
47
48 But I love a bit of deduplication too.
49
50 Best,
51 sam

Attachments

File name MIME type
signature.asc application/pgp-signature