Gentoo Archives: gentoo-dev

From: Ulrich Mueller <ulm@g.o>
To: Joshua Kinard <kumba@g.o>
Cc: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] About the 'eapi' file in profile directories
Date: Sun, 01 Aug 2021 13:59:15
Message-Id: ufsvt466v@gentoo.org
In Reply to: Re: [gentoo-dev] About the 'eapi' file in profile directories by Joshua Kinard
1 >>>>> On Sun, 01 Aug 2021, Joshua Kinard wrote:
2
3 > Let's go one further, though, and also add a mention of eapi, borrowing some
4 > of the lingo from PMS, since the file is so prolific. See the attached
5 > patch and let me know how the language looks.
6
7 > diff --git a/profiles/eapi/text.xml b/profiles/eapi/text.xml
8 > new file mode 100644
9 > index 0000000..477ff24
10 > --- /dev/null
11 > +++ b/profiles/eapi/text.xml
12 > @@ -0,0 +1,18 @@
13 > +<?xml version="1.0"?>
14 > +<guide self="profiles/eapi/">
15 > +<chapter>
16 > +<title>Profiles <c>eapi</c> Files</title>
17 > +<body>
18 > +
19 > +<p>
20 > +An <c>eapi</c> file may be found in each profile directory. If present, this
21 > +file specifies the EAPI to use when handling the directory. Otherwise, EAPI 0
22 > +will be used instead. The contents of the file is a single line specifying the
23 > +numeric value of the supported EAPI. This file is not inherited by <c>parent</c>
24 > +nor in subdirectories.
25 > +</p>
26 > +
27 > +</body>
28 > +</chapter>
29 > +</guide>
30 > +
31
32 This doesn't really belong there, because the "Profiles" chapter in the
33 devmanual describes only the top-level profiles dir. So the wording from
34 https://projects.gentoo.org/pms/8/pms.html#x1-320004.4 would apply
35 (for the single profiles/eapi file):
36
37 | The profiles directory may contain an \t{eapi} file. This file, if it
38 | exists, must contain a single line with the name of an EAPI\@. This
39 | specifies the EAPI to use when handling the profiles directory; a
40 | package manager must not attempt to use any repository whose profiles
41 | directory requires an EAPI it does not support. If no \t{eapi} file is
42 | present, EAPI 0 shall be used.
43
44 That said (and hard to believe), the devmanual currently doesn't
45 describe the profile tree at all.
46
47 Ulrich

Attachments

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