/[gentoo-x86]/skel.ebuild
Gentoo

Diff of /skel.ebuild

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.1.24  
changed lines
  Added in v.1.58

  ViewVC Help
Powered by ViewVC 1.1.20