/[gentoo-x86]/skel.ebuild
Gentoo

Contents of /skel.ebuild

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.43 - (show annotations) (download)
Mon Nov 12 23:12:27 2007 UTC (6 years, 5 months ago) by betelgeuse
Branch: MAIN
Changes since 1.42: +7 -0 lines
Add notes about EAPI to skel.ebuild

1 # Copyright 1999-2007 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: $
4
5 # NOTE: The comments in this file are for instruction and documentation.
6 # They're not meant to appear with your final, production ebuild. Please
7 # remember to remove them before submitting or committing your ebuild. That
8 # doesn't mean you can't add your own comments though.
9
10 # The 'Header' on the third line should just be left alone. When your ebuild
11 # will be committed to cvs, the details on that line will be automatically
12 # generated to contain the correct data.
13
14 # The EAPI variable tells the ebuild format in use.
15 # Defaults to 0 if not specified. See current PMS draft for more details.
16 # Eclasses will test for this variable if they need to use EAPI > 0 features.
17 # Ebuilds should not define EAPI=1 unless they need to use features added
18 # in that version.
19 #EAPI=1
20
21 # inherit lists eclasses to inherit functions from. Almost all ebuilds should
22 # inherit eutils, as a large amount of important functionality has been
23 # moved there. For example, the $(get_libdir) mentioned below wont work
24 # without the following line:
25 inherit eutils
26 # A well-used example of an eclass function that needs eutils is epatch. If
27 # your source needs patches applied, it's suggested to put your patch in the
28 # 'files' directory and use:
29 #
30 # epatch ${FILESDIR}/patch-name-here
31 #
32 # eclasses tend to list descriptions of how to use their functions properly.
33 # take a look at /usr/portage/eclasses/ for more examples.
34
35 # Short one-line description of this package.
36 DESCRIPTION="This is a sample skeleton ebuild file"
37
38 # Homepage, not used by Portage directly but handy for developer reference
39 HOMEPAGE="http://foo.bar.com/"
40
41 # Point to any required sources; these will be automatically downloaded by
42 # Portage.
43 SRC_URI="ftp://foo.bar.com/${P}.tar.gz"
44
45 # License of the package. This must match the name of file(s) in
46 # /usr/portage/licenses/. For complex license combination see the developer
47 # docs on gentoo.org for details.
48 LICENSE=""
49
50 # The SLOT variable is used to tell Portage if it's OK to keep multiple
51 # versions of the same package installed at the same time. For example,
52 # if we have a libfoo-1.2.2 and libfoo-1.3.2 (which is not compatible
53 # with 1.2.2), it would be optimal to instruct Portage to not remove
54 # libfoo-1.2.2 if we decide to upgrade to libfoo-1.3.2. To do this,
55 # we specify SLOT="1.2" in libfoo-1.2.2 and SLOT="1.3" in libfoo-1.3.2.
56 # emerge clean understands SLOTs, and will keep the most recent version
57 # of each SLOT and remove everything else.
58 # Note that normal applications should use SLOT="0" if possible, since
59 # there should only be exactly one version installed at a time.
60 # DO NOT USE SLOT=""! This tells Portage to disable SLOTs for this package.
61 SLOT="0"
62
63 # Using KEYWORDS, we can record masking information *inside* an ebuild
64 # instead of relying on an external package.mask file. Right now, you should
65 # set the KEYWORDS variable for every ebuild so that it contains the names of
66 # all the architectures with which the ebuild works. All of the official
67 # architectures can be found in the keywords.desc file which is in
68 # /usr/portage/profiles/. Usually you should just set this to "~x86". The ~
69 # in front of the architecture indicates that the package is new and should be
70 # considered unstable until testing proves its stability. So, if you've
71 # confirmed that your ebuild works on x86 and ppc, you'd specify:
72 # KEYWORDS="~x86 ~ppc"
73 # Once packages go stable, the ~ prefix is removed.
74 # For binary packages, use -* and then list the archs the bin package
75 # exists for. If the package was for an x86 binary package, then
76 # KEYWORDS would be set like this: KEYWORDS="-* x86"
77 # DO NOT USE KEYWORDS="*". This is deprecated and only for backward
78 # compatibility reasons.
79 KEYWORDS="~x86"
80
81 # Comprehensive list of any and all USE flags leveraged in the ebuild,
82 # with the exception of any ARCH specific flags, i.e. "ppc", "sparc",
83 # "x86" and "alpha". This is a required variable. If the ebuild doesn't
84 # use any USE flags, set to "".
85 IUSE="gnome X"
86
87 # A space delimited list of portage features to restrict. man 5 ebuild
88 # for details. Usually not needed.
89 #RESTRICT="strip"
90
91 # Build-time dependencies, such as
92 # ssl? ( >=dev-libs/openssl-0.9.6b )
93 # >=dev-lang/perl-5.6.1-r1
94 # It is advisable to use the >= syntax show above, to reflect what you
95 # had installed on your system when you tested the package. Then
96 # other users hopefully won't be caught without the right version of
97 # a dependency.
98 DEPEND=""
99
100 # Run-time dependencies. Must be defined to whatever this depends on to run.
101 # The below is valid if the same run-time depends are required to compile.
102 RDEPEND="${DEPEND}"
103
104 # Source directory; the dir where the sources can be found (automatically
105 # unpacked) inside ${WORKDIR}. The default value for S is ${WORKDIR}/${P}
106 # If you don't need to change it, leave the S= line out of the ebuild
107 # to keep it tidy.
108 #S="${WORKDIR}/${P}"
109
110 src_compile() {
111 # Most open-source packages use GNU autoconf for configuration.
112 # The quickest (and preferred) way of running configure is:
113 econf || die "econf failed"
114 #
115 # You could use something similar to the following lines to
116 # configure your package before compilation. The "|| die" portion
117 # at the end will stop the build process if the command fails.
118 # You should use this at the end of critical commands in the build
119 # process. (Hint: Most commands are critical, that is, the build
120 # process should abort if they aren't successful.)
121 #./configure \
122 # --host=${CHOST} \
123 # --prefix=/usr \
124 # --infodir=/usr/share/info \
125 # --mandir=/usr/share/man || die "./configure failed"
126 # Note the use of --infodir and --mandir, above. This is to make
127 # this package FHS 2.2-compliant. For more information, see
128 # http://www.pathname.com/fhs/
129
130 # emake (previously known as pmake) is a script that calls the
131 # standard GNU make with parallel building options for speedier
132 # builds (especially on SMP systems). Try emake first. It might
133 # not work for some packages, because some makefiles have bugs
134 # related to parallelism, in these cases, use emake -j1 to limit
135 # make to a single process. The -j1 is a visual clue to others
136 # that the makefiles have bugs that have been worked around.
137 emake || die "emake failed"
138 }
139
140 src_install() {
141 # You must *personally verify* that this trick doesn't install
142 # anything outside of DESTDIR; do this by reading and
143 # understanding the install part of the Makefiles.
144 # This is the preferred way to install.
145 emake DESTDIR="${D}" install || die "emake install failed"
146
147 # When you hit a failure with emake, do not just use make. It is
148 # better to fix the Makefiles to allow proper parallelization.
149 # If you fail with that, use "emake -j1", it's still better than make.
150
151 # For Makefiles that don't make proper use of DESTDIR, setting
152 # prefix is often an alternative. However if you do this, then
153 # you also need to specify mandir and infodir, since they were
154 # passed to ./configure as absolute paths (overriding the prefix
155 # setting).
156 #emake \
157 # prefix="${D}"/usr \
158 # mandir="${D}"/usr/share/man \
159 # infodir="${D}"/usr/share/info \
160 # libdir="${D}"/usr/$(get_libdir) \
161 # install || die "emake install failed"
162 # Again, verify the Makefiles! We don't want anything falling
163 # outside of ${D}.
164
165 # The portage shortcut to the above command is simply:
166 #
167 #einstall || die "einstall failed"
168 }

  ViewVC Help
Powered by ViewVC 1.1.20