/[gentoo-x86]/skel.ebuild
Gentoo

Diff of /skel.ebuild

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

Revision 1.17 Revision 1.48
1# Copyright 1999-2002 Gentoo Technologies, Inc. 1# Copyright 1999-2008 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.17 2002/11/08 22:03:45 seemant Exp $ 3# $Header: /var/cvsroot/gentoo-x86/skel.ebuild,v 1.48 2008/03/13 23:05:53 spb 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 commited 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. 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:
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
24# License of the package. This must match the name of file(s) in 45# License of the package. This must match the name of file(s) in
25# /usr/portage/licenses/. For complex license combination see the developer 46# /usr/portage/licenses/. For complex license combination see the developer
26# docs on gentoo.org for details. 47# docs on gentoo.org for details.
27LICENSE="" 48LICENSE=""
28 49
29# The SLOT variable is used to tell Portage if it's OK to keep multiple 50# 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, 51# 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 52# 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 53# 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, 54# 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. 55# 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 56# emerge clean understands SLOTs, and will keep the most recent version
36# of each SLOT and remove everything else. 57# of each SLOT and remove everything else.
37# Note that normal applications should use SLOT="0" if possible, since 58# Note that normal applications should use SLOT="0" if possible, since
38# there should only be exactly one version installed at a time. 59# 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. 60# DO NOT USE SLOT=""! This tells Portage to disable SLOTs for this package.
40SLOT="0" 61SLOT="0"
41 62
42# Using KEYWORDS, we can record masking information *inside* an ebuild 63# Using KEYWORDS, we can record masking information *inside* an ebuild
43# instead of relying on an external package.mask file. Right now, you 64# 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 65# 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 66# all the architectures with which the ebuild works. All of the official
46# 4 official architecture names right now: "x86", "ppc", "sparc" and 67# architectures can be found in the keywords.desc file which is in
47# "sparc64". So, if you've confirmed that your ebuild works on x86 and ppc, 68# /usr/portage/profiles/. Usually you should just set this to "~x86". The ~
48# you'd specify: KEYWORDS="x86 ppc" 69# in front of the architecture indicates that the package is new and should be
49# For packages that are platform-independant (like Java, PHP or Perl 70# considered unstable until testing proves its stability. So, if you've
50# applications) specify all keywords. 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"
51# DO NOT USE KEYWORDS="*". This is deprecated and only for backward 77# DO NOT USE KEYWORDS="*". This is deprecated and only for backward
52# compatibility reasons. 78# compatibility reasons.
53KEYWORDS="x86" 79KEYWORDS="~x86"
54 80
55# Comprehensive list of any and all USE flags leveraged in the ebuild, 81# Comprehensive list of any and all USE flags leveraged in the ebuild,
56# with the exception of any ARCH specific flags, i.e. "ppc", "sparc", 82# with the exception of any ARCH specific flags, i.e. "ppc", "sparc",
57# "sparc64", "x86" and "alpha". This is a required variable. If the 83# "x86" and "alpha". This is a required variable. If the ebuild doesn't
58# ebuild doesn't use any USE flags, set to "". 84# use any USE flags, set to "".
59IUSE="X gnome" 85IUSE="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"
60 90
61# Build-time dependencies, such as 91# Build-time dependencies, such as
62# ssl? ( >=openssl-0.9.6b ) 92# ssl? ( >=dev-libs/openssl-0.9.6b )
63# >=perl-5.6.1-r1 93# >=dev-lang/perl-5.6.1-r1
64# It is advisable to use the >= syntax show above, to reflect what you 94# It is advisable to use the >= syntax show above, to reflect what you
65# had installed on your system when you tested the package. Then 95# had installed on your system when you tested the package. Then
66# other users hopefully won't be caught without the right version of 96# other users hopefully won't be caught without the right version of
67# a dependency. 97# a dependency.
68DEPEND="" 98DEPEND=""
69 99
70# Run-time dependencies, same as DEPEND if RDEPEND isn't defined: 100# Run-time dependencies. Must be defined to whatever this depends on to run.
71#RDEPEND="" 101# The below is valid if the same run-time depends are required to compile.
102RDEPEND="${DEPEND}"
72 103
73# Source directory; the dir where the sources can be found (automatically 104# Source directory; the dir where the sources can be found (automatically
74# unpacked) inside ${WORKDIR}. S will get a default setting of ${WORKDIR}/${P} 105# unpacked) inside ${WORKDIR}. The default value for S is ${WORKDIR}/${P}
75# if you omit this line. 106# If you don't need to change it, leave the S= line out of the ebuild
107# to keep it tidy.
76S="${WORKDIR}/${P}" 108#S="${WORKDIR}/${P}"
77 109
78src_compile() { 110src_compile() {
79 # Most open-source packages use GNU autoconf for configuration. 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 #
80 # You should use something similar to the following lines to 115 # You could use something similar to the following lines to
81 # configure your package before compilation. The "|| die" portion 116 # configure your package before compilation. The "|| die" portion
82 # at the end will stop the build process if the command fails. 117 # at the end will stop the build process if the command fails.
83 # You should use this at the end of critical commands in the build 118 # You should use this at the end of critical commands in the build
84 # process. (Hint: Most commands are critical, that is, the build 119 # process. (Hint: Most commands are critical, that is, the build
85 # process should abort if they aren't successful.) 120 # process should abort if they aren't successful.)
86 ./configure \ 121 #./configure \
87 --host=${CHOST} \ 122 # --host=${CHOST} \
88 --prefix=/usr \ 123 # --prefix=/usr \
89 --infodir=/usr/share/info \ 124 # --infodir=/usr/share/info \
90 --mandir=/usr/share/man || die "./configure failed" 125 # --mandir=/usr/share/man || die "./configure failed"
91 # Note the use of --infodir and --mandir, above. This is to make 126 # Note the use of --infodir and --mandir, above. This is to make
92 # this package FHS 2.2-compliant. For more information, see 127 # this package FHS 2.2-compliant. For more information, see
93 # http://www.pathname.com/fhs/ 128 # http://www.pathname.com/fhs/
94 129
95 # Also note that it is cleaner and easier to use econf, which is the
96 # portage shortcut to the above ./configure statement:
97 #
98 # econf
99
100 # emake (previously known as pmake) is a script that calls the 130 # emake (previously known as pmake) is a script that calls the
101 # standard GNU make with parallel building options for speedier 131 # standard GNU make with parallel building options for speedier
102 # builds (especially on SMP systems). Try emake first. It might 132 # builds (especially on SMP systems). Try emake first. It might
103 # not work for some packages, in which case you'll have to resort 133 # not work for some packages, because some makefiles have bugs
104 # to normal "make". 134 # related to parallelism, in these cases, use emake -j1 to limit
105 emake || die 135 # make to a single process. The -j1 is a visual clue to others
106 #make || die 136 # that the makefiles have bugs that have been worked around.
137 emake || die "emake failed"
107} 138}
108 139
109src_install() { 140src_install() {
110 # You must *personally verify* that this trick doesn't install 141 # You must *personally verify* that this trick doesn't install
111 # anything outside of DESTDIR; do this by reading and 142 # anything outside of DESTDIR; do this by reading and
112 # understanding the install part of the Makefiles. 143 # understanding the install part of the Makefiles.
113 make DESTDIR=${D} install || die 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
114 # For Makefiles that don't make proper use of DESTDIR, setting 151 # For Makefiles that don't make proper use of DESTDIR, setting
115 # prefix is often an alternative. However if you do this, then 152 # prefix is often an alternative. However if you do this, then
116 # you also need to specify mandir and infodir, since they were 153 # you also need to specify mandir and infodir, since they were
117 # passed to ./configure as absolute paths (overriding the prefix 154 # passed to ./configure as absolute paths (overriding the prefix
118 # setting). 155 # setting).
119 #make \ 156 #emake \
120 # prefix=${D}/usr \ 157 # prefix="${D}"/usr \
121 # mandir=${D}/usr/share/man \ 158 # mandir="${D}"/usr/share/man \
122 # infodir=${D}/usr/share/info \ 159 # infodir="${D}"/usr/share/info \
123 # install || die 160 # libdir="${D}"/usr/$(get_libdir) \
161 # install || die "emake install failed"
124 # Again, verify the Makefiles! We don't want anything falling 162 # Again, verify the Makefiles! We don't want anything falling
125 # outside of ${D}. 163 # outside of ${D}.
126 164
127 # The portage shortcut to the above command is simply: 165 # The portage shortcut to the above command is simply:
128 # 166 #
129 #einstall || die 167 #einstall || die "einstall failed"
130} 168}

Legend:
Removed from v.1.17  
changed lines
  Added in v.1.48

  ViewVC Help
Powered by ViewVC 1.1.20