/[gentoo-x86]/skel.ebuild
Gentoo

Diff of /skel.ebuild

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

Revision 1.1.1.1 Revision 1.66
1# Copyright 1999-2005 Gentoo Foundation 1# Copyright 1999-2012 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.1.1.1 2005/11/30 09:36:18 chriswhite Exp $ 3# $Header: /var/cvsroot/gentoo-x86/skel.ebuild,v 1.66 2012/11/30 10:26:57 scarabeus 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 13
14# The EAPI variable tells the ebuild format in use.
15# Defaults to 0 if not specified.
16# It is suggested that you use 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=5
20
14# inherit lists eclasses to inherit functions from. Almost all ebuilds should 21# inherit lists eclasses to inherit functions from. Almost all ebuilds should
15# inherit eutils, as a large amount of important functionality has been 22# inherit eutils, as a large amount of important functionality has been
16# moved there. For example, the $(get_libdir) mentioned below wont work 23# moved there. For example, the epatch call mentioned below wont work
17# without the following line: 24# without the following line:
18inherit eutils 25inherit eutils
19# A well-used example of an eclass function that needs eutils is epatch. If 26# A well-used example of an eclass function that needs eutils is epatch. If
20# your source needs patches applied, it's suggested to put your patch in the 27# your source needs patches applied, it's suggested to put your patch in the
21# 'files' directory and use: 28# 'files' directory and use:
22# 29#
23# epatch ${FILESDIR}/patch-name-here 30# epatch "${FILESDIR}"/patch-name-here
24# 31#
25# eclasses tend to list descriptions of how to use their functions properly. 32# eclasses tend to list descriptions of how to use their functions properly.
26# take a look at /usr/portage/eclasses/ for more examples. 33# take a look at /usr/portage/eclass/ for more examples.
27 34
28# Short one-line description of this package. 35# Short one-line description of this package.
29DESCRIPTION="This is a sample skeleton ebuild file" 36DESCRIPTION="This is a sample skeleton ebuild file"
30 37
31# Homepage, not used by Portage directly but handy for developer reference 38# Homepage, not used by Portage directly but handy for developer reference
32HOMEPAGE="http://foo.bar.com/" 39HOMEPAGE="http://foo.example.org/"
33 40
34# Point to any required sources; these will be automatically downloaded by 41# Point to any required sources; these will be automatically downloaded by
35# Portage. 42# Portage.
36SRC_URI="ftp://foo.bar.com/${P}.tar.gz" 43SRC_URI="ftp://foo.example.org/${P}.tar.gz"
44
37 45
38# 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
39# /usr/portage/licenses/. For complex license combination see the developer 47# /usr/portage/licenses/. For complex license combination see the developer
40# docs on gentoo.org for details. 48# docs on gentoo.org for details.
41LICENSE="" 49LICENSE=""
52# there should only be exactly one version installed at a time. 60# there should only be exactly one version installed at a time.
53# 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.
54SLOT="0" 62SLOT="0"
55 63
56# Using KEYWORDS, we can record masking information *inside* an ebuild 64# Using KEYWORDS, we can record masking information *inside* an ebuild
57# 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
58# 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
59# the names of all the architectures with which the ebuild works. All of 67# all the architectures with which the ebuild works. All of the official
60# the official architectures can be found in the keywords.desc file which 68# architectures can be found in the arch.list file which is in
61# is in /usr/portage/profiles/. Usually you should just set this to "~x86". 69# /usr/portage/profiles/. Usually you should just set this to "~x86". The ~
62# The ~ in front of the architecture indicates that the package is new and 70# in front of the architecture indicates that the package is new and should be
63# should be considered unstable until testing proves its stability. Once 71# considered unstable until testing proves its stability. So, if you've
64# packages go stable the ~ prefix is removed. So, if you've confirmed that 72# confirmed that your ebuild works on x86 and ppc, you'd specify:
65# your ebuild works on x86 and ppc, you'd specify: KEYWORDS="~x86 ~ppc" 73# KEYWORDS="~x86 ~ppc"
74# Once packages go stable, the ~ prefix is removed.
66# 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
67# 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
68# KEYWORDS would be set like this: KEYWORDS="-* x86" 77# KEYWORDS would be set like this: KEYWORDS="-* x86"
69# DO NOT USE KEYWORDS="*". This is deprecated and only for backward 78# DO NOT USE KEYWORDS="*". This is deprecated and only for backward
70# compatibility reasons. 79# compatibility reasons.
71KEYWORDS="~x86" 80KEYWORDS="~x86"
72 81
73# 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,
74# 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",
75# "x86" and "alpha". This is a required variable. If the ebuild doesn't 84# "x86" and "alpha". Not needed if the ebuild doesn't use any USE flags.
76# use any USE flags, set to "".
77IUSE="X gnome" 85IUSE="gnome X"
78 86
79# A space delimited list of portage features to restrict. man 5 ebuild 87# A space delimited list of portage features to restrict. man 5 ebuild
80# for details. Usually not needed. 88# for details. Usually not needed.
81#RESTRICT="nostrip" 89#RESTRICT="strip"
90
82 91
83# Build-time dependencies, such as 92# Build-time dependencies, such as
84# ssl? ( >=dev-libs/openssl-0.9.6b ) 93# ssl? ( >=dev-libs/openssl-0.9.6b )
85# >=dev-lang/perl-5.6.1-r1 94# >=dev-lang/perl-5.6.1-r1
86# It is advisable to use the >= syntax show above, to reflect what you 95# It is advisable to use the >= syntax show above, to reflect what you
87# had installed on your system when you tested the package. Then 96# had installed on your system when you tested the package. Then
88# other users hopefully won't be caught without the right version of 97# other users hopefully won't be caught without the right version of
89# a dependency. 98# a dependency.
90DEPEND="" 99#DEPEND=""
91 100
92# Run-time dependencies, same as DEPEND if RDEPEND isn't defined: 101# Run-time dependencies. Must be defined to whatever this depends on to run.
93#RDEPEND="" 102# The below is valid if the same run-time depends are required to compile.
103RDEPEND="${DEPEND}"
94 104
95# Source directory; the dir where the sources can be found (automatically 105# Source directory; the dir where the sources can be found (automatically
96# unpacked) inside ${WORKDIR}. The default value for S is ${WORKDIR}/${P} 106# unpacked) inside ${WORKDIR}. The default value for S is ${WORKDIR}/${P}
97# If you don't need to change it, leave the S= line out of the ebuild 107# If you don't need to change it, leave the S= line out of the ebuild
98# to keep it tidy. 108# to keep it tidy.
99S=${WORKDIR}/${P} 109#S=${WORKDIR}/${P}
100 110
101src_compile() { 111
112# The following src_configure function is implemented as default by portage, so
113# you only need to call it if you need a different behaviour.
114# This function is available only in EAPI 2 and later.
115#src_configure() {
102 # Most open-source packages use GNU autoconf for configuration. 116 # Most open-source packages use GNU autoconf for configuration.
103 # The quickest (and preferred) way of running configure is: 117 # The default, quickest (and preferred) way of running configure is:
104 econf || die "econf failed" 118 #econf
105 # 119 #
106 # You could use something similar to the following lines to 120 # You could use something similar to the following lines to
107 # configure your package before compilation. The "|| die" portion 121 # configure your package before compilation. The "|| die" portion
108 # at the end will stop the build process if the command fails. 122 # at the end will stop the build process if the command fails.
109 # You should use this at the end of critical commands in the build 123 # You should use this at the end of critical commands in the build
111 # process should abort if they aren't successful.) 125 # process should abort if they aren't successful.)
112 #./configure \ 126 #./configure \
113 # --host=${CHOST} \ 127 # --host=${CHOST} \
114 # --prefix=/usr \ 128 # --prefix=/usr \
115 # --infodir=/usr/share/info \ 129 # --infodir=/usr/share/info \
116 # --mandir=/usr/share/man || die "./configure failed" 130 # --mandir=/usr/share/man || die
117 # Note the use of --infodir and --mandir, above. This is to make 131 # Note the use of --infodir and --mandir, above. This is to make
118 # this package FHS 2.2-compliant. For more information, see 132 # this package FHS 2.2-compliant. For more information, see
119 # http://www.pathname.com/fhs/ 133 # http://www.pathname.com/fhs/
134#}
120 135
136# The following src_compile function is implemented as default by portage, so
137# you only need to call it, if you need different behaviour.
138# For EAPI < 2 src_compile runs also commands currently present in
139# src_configure. Thus, if you're using an older EAPI, you need to copy them
140# to your src_compile and drop the src_configure function.
141#src_compile() {
121 # emake (previously known as pmake) is a script that calls the 142 # emake (previously known as pmake) is a script that calls the
122 # standard GNU make with parallel building options for speedier 143 # standard GNU make with parallel building options for speedier
123 # builds (especially on SMP systems). Try emake first. It might 144 # builds (especially on SMP systems). Try emake first. It might
124 # not work for some packages, because some makefiles have bugs 145 # not work for some packages, because some makefiles have bugs
125 # related to parallelism, in these cases, use emake -j1 to limit 146 # related to parallelism, in these cases, use emake -j1 to limit
126 # make to a single process. The -j1 is a visual clue to others 147 # make to a single process. The -j1 is a visual clue to others
127 # that the makefiles have bugs that have been worked around. 148 # that the makefiles have bugs that have been worked around.
128 emake || die "emake failed"
129}
130 149
150 #emake || die
151#}
152
153# The following src_install function is implemented as default by portage, so
154# you only need to call it, if you need different behaviour.
155# For EAPI < 4 src_install is just returing true, so you need to always specify
156# this function in older EAPIs.
131src_install() { 157#src_install() {
132 # You must *personally verify* that this trick doesn't install 158 # You must *personally verify* that this trick doesn't install
133 # anything outside of DESTDIR; do this by reading and 159 # anything outside of DESTDIR; do this by reading and
134 # understanding the install part of the Makefiles. 160 # understanding the install part of the Makefiles.
135 # This is the preferred way to install. 161 # This is the preferred way to install.
136 make DESTDIR=${D} install || die 162 #emake DESTDIR="${D}" install || die
163
164 # When you hit a failure with emake, do not just use make. It is
165 # better to fix the Makefiles to allow proper parallelization.
166 # If you fail with that, use "emake -j1", it's still better than make.
137 167
138 # For Makefiles that don't make proper use of DESTDIR, setting 168 # For Makefiles that don't make proper use of DESTDIR, setting
139 # prefix is often an alternative. However if you do this, then 169 # prefix is often an alternative. However if you do this, then
140 # you also need to specify mandir and infodir, since they were 170 # you also need to specify mandir and infodir, since they were
141 # passed to ./configure as absolute paths (overriding the prefix 171 # passed to ./configure as absolute paths (overriding the prefix
142 # setting). 172 # setting).
143 #make \ 173 #emake \
144 # prefix=${D}/usr \ 174 # prefix="${D}"/usr \
145 # mandir=${D}/usr/share/man \ 175 # mandir="${D}"/usr/share/man \
146 # infodir=${D}/usr/share/info \ 176 # infodir="${D}"/usr/share/info \
147 # libdir=${D}/usr/$(get_libdir) \ 177 # libdir="${D}"/usr/$(get_libdir) \
148 # install || die 178 # install || die
149 # Again, verify the Makefiles! We don't want anything falling 179 # Again, verify the Makefiles! We don't want anything falling
150 # outside of ${D}. 180 # outside of ${D}.
151 181
152 # The portage shortcut to the above command is simply: 182 # The portage shortcut to the above command is simply:
153 # 183 #
154 #einstall || die 184 #einstall || die
155} 185#}

Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.66

  ViewVC Help
Powered by ViewVC 1.1.20