Gentoo Archives: gentoo-dev

From: "Ulrich Müller" <ulm@g.o>
To: gentoo-dev@l.g.o
Subject: [gentoo-dev] [PATCH v2] skel.ebuild: Update comments for inherit, SLOT, KEYWORDS.
Date: Mon, 01 Jan 2018 11:22:18
Message-Id: 23114.6621.565531.866344@a1i15.kph.uni-mainz.de
In Reply to: [gentoo-dev] [PATCH] skel.ebuild: Update comments for inherit, SLOT, KEYWORDS. by "Ulrich Müller"
1 Change the example used for inherit. Also comment the inherit line,
2 since not every ebuild will use it.
3
4 Empty SLOT doesn't disable slots, but is outright illegal in all EAPIs.
5 Similar for KEYWORDS="*", which isn't "deprecated" but invalid.
6
7 Replace x86 by amd64 as an example, where appropriate.
8 ---
9
10 Changes in v2:
11 - inherit uses autotools rather than epatch as an example.
12 - x86 replaced by amd64 where appropriate.
13 - More accurate wording for IUSE.
14
15 skel.ebuild | 27 +++++++++++++--------------
16 1 file changed, 13 insertions(+), 14 deletions(-)
17
18 diff --git a/skel.ebuild b/skel.ebuild
19 index 591b58e8d367..129f61dcdb29 100644
20 --- a/skel.ebuild
21 +++ b/skel.ebuild
22 @@ -13,9 +13,9 @@
23 EAPI=6
24
25 # inherit lists eclasses to inherit functions from. For example, an ebuild
26 -# that needs the epatch function from eutils.eclass won't work without the
27 -# following line:
28 -inherit eutils
29 +# that needs the eautoreconf function from autotools.eclass won't work
30 +# without the following line:
31 +#inherit autotools
32 #
33 # eclasses tend to list descriptions of how to use their functions properly.
34 # take a look at /usr/portage/eclass/ for more examples.
35 @@ -46,7 +46,7 @@ LICENSE=""
36 # of each SLOT and remove everything else.
37 # Note that normal applications should use SLOT="0" if possible, since
38 # there should only be exactly one version installed at a time.
39 -# DO NOT USE SLOT=""! This tells Portage to disable SLOTs for this package.
40 +# Do not use SLOT="", because the SLOT variable must not be empty.
41 SLOT="0"
42
43 # Using KEYWORDS, we can record masking information *inside* an ebuild
44 @@ -54,22 +54,21 @@ SLOT="0"
45 # set the KEYWORDS variable for every ebuild so that it contains the names of
46 # all the architectures with which the ebuild works. All of the official
47 # architectures can be found in the arch.list file which is in
48 -# /usr/portage/profiles/. Usually you should just set this to "~x86". The ~
49 -# in front of the architecture indicates that the package is new and should be
50 -# considered unstable until testing proves its stability. So, if you've
51 -# confirmed that your ebuild works on x86 and ppc, you'd specify:
52 -# KEYWORDS="~x86 ~ppc"
53 +# /usr/portage/profiles/. Usually you should just set this to "~amd64".
54 +# The ~ in front of the architecture indicates that the package is new and
55 +# should be considered unstable until testing proves its stability. So, if
56 +# you've confirmed that your ebuild works on amd64 and ppc, you'd specify:
57 +# KEYWORDS="~amd64 ~ppc"
58 # Once packages go stable, the ~ prefix is removed.
59 # For binary packages, use -* and then list the archs the bin package
60 # exists for. If the package was for an x86 binary package, then
61 # KEYWORDS would be set like this: KEYWORDS="-* x86"
62 -# DO NOT USE KEYWORDS="*". This is deprecated and only for backward
63 -# compatibility reasons.
64 -KEYWORDS="~x86"
65 +# Do not use KEYWORDS="*"; this is not valid in an ebuild context.
66 +KEYWORDS="~amd64"
67
68 # Comprehensive list of any and all USE flags leveraged in the ebuild,
69 -# with the exception of any ARCH specific flags, i.e. "ppc", "sparc",
70 -# "x86" and "alpha". Not needed if the ebuild doesn't use any USE flags.
71 +# with some exceptions, e.g., ARCH specific flags like "amd64" or "ppc".
72 +# Not needed if the ebuild doesn't use any USE flags.
73 IUSE="gnome X"
74
75 # A space delimited list of portage features to restrict. man 5 ebuild
76 --
77 2.15.1