/[gentoo-x86]/skel.ebuild
Gentoo

Diff of /skel.ebuild

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

Revision 1.31 Revision 1.58
1# Copyright 1999-2004 Gentoo Foundation 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.31 2004/09/02 07:35:42 mr_bones_ 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 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
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/eclasses/ for more examples.
27 34
28# Short one-line description of this package. 35# Short one-line description of this package.
32HOMEPAGE="http://foo.bar.com/" 39HOMEPAGE="http://foo.bar.com/"
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.bar.com/${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". This is a required variable. If the ebuild doesn't
76# use any USE flags, set to "". 85# use any USE flags, set to "".
77IUSE="X gnome" 86IUSE="gnome X"
78 87
79# A space delimited list of portage features to restrict. man 5 ebuild 88# A space delimited list of portage features to restrict. man 5 ebuild
80# for details. Usually not needed. 89# for details. Usually not needed.
81#RESTRICT="nostrip" 90#RESTRICT="strip"
91
82 92
83# Build-time dependencies, such as 93# Build-time dependencies, such as
84# ssl? ( >=dev-libs/openssl-0.9.6b ) 94# ssl? ( >=dev-libs/openssl-0.9.6b )
85# >=dev-lang/perl-5.6.1-r1 95# >=dev-lang/perl-5.6.1-r1
86# 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
87# had installed on your system when you tested the package. Then 97# had installed on your system when you tested the package. Then
88# 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
89# a dependency. 99# a dependency.
90DEPEND="" 100#DEPEND=""
91 101
92# 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.
93#RDEPEND="" 103# The below is valid if the same run-time depends are required to compile.
104RDEPEND="${DEPEND}"
94 105
95# Source directory; the dir where the sources can be found (automatically 106# Source directory; the dir where the sources can be found (automatically
96# unpacked) inside ${WORKDIR}. The default value for S is ${WORKDIR}/${P} 107# 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 108# If you don't need to change it, leave the S= line out of the ebuild
98# to keep it tidy. 109# to keep it tidy.
99S=${WORKDIR}/${P} 110#S="${WORKDIR}/${P}"
100 111
101src_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() {
102 # 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 #
103 # You should use something similar to the following lines to 121 # You could use something similar to the following lines to
104 # configure your package before compilation. The "|| die" portion 122 # configure your package before compilation. The "|| die" portion
105 # 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.
106 # 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
107 # process. (Hint: Most commands are critical, that is, the build 125 # process. (Hint: Most commands are critical, that is, the build
108 # process should abort if they aren't successful.) 126 # process should abort if they aren't successful.)
109 ./configure \ 127 #./configure \
110 --host=${CHOST} \ 128 # --host=${CHOST} \
111 --prefix=/usr \ 129 # --prefix=/usr \
112 --infodir=/usr/share/info \ 130 # --infodir=/usr/share/info \
113 --mandir=/usr/share/man || die "./configure failed" 131 # --mandir=/usr/share/man || die "./configure failed"
114 # 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
115 # this package FHS 2.2-compliant. For more information, see 133 # this package FHS 2.2-compliant. For more information, see
116 # http://www.pathname.com/fhs/ 134 # http://www.pathname.com/fhs/
135#}
117 136
118 # 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
119 # portage shortcut to the above ./configure statement: 138# you only need to call it, if you need different behaviour.
120 # 139# For EAPI < 2 src_compile runs also commands currently present in
121 # econf || die 140# src_configure. Thus, if you're using an older EAPI, you need to copy them
122 # Note that econf will die on failure, but please use econf || die 141# to your src_compile and drop the src_configure function.
123 # for consistency. 142#src_compile() {
124
125 # emake (previously known as pmake) is a script that calls the 143 # emake (previously known as pmake) is a script that calls the
126 # standard GNU make with parallel building options for speedier 144 # standard GNU make with parallel building options for speedier
127 # builds (especially on SMP systems). Try emake first. It might 145 # builds (especially on SMP systems). Try emake first. It might
128 # not work for some packages, because some makefiles have bugs 146 # not work for some packages, because some makefiles have bugs
129 # related to parallelism, in these cases, use emake -j1 to limit 147 # related to parallelism, in these cases, use emake -j1 to limit
130 # make to a single process. The -j1 is a visual clue to others 148 # make to a single process. The -j1 is a visual clue to others
131 # that the makefiles have bugs that have been worked around. 149 # that the makefiles have bugs that have been worked around.
132 emake || die "emake failed"
133}
134 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.
135src_install() { 158#src_install() {
136 # You must *personally verify* that this trick doesn't install 159 # You must *personally verify* that this trick doesn't install
137 # anything outside of DESTDIR; do this by reading and 160 # anything outside of DESTDIR; do this by reading and
138 # understanding the install part of the Makefiles. 161 # understanding the install part of the Makefiles.
162 # This is the preferred way to install.
139 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
140 # For Makefiles that don't make proper use of DESTDIR, setting 169 # For Makefiles that don't make proper use of DESTDIR, setting
141 # prefix is often an alternative. However if you do this, then 170 # prefix is often an alternative. However if you do this, then
142 # you also need to specify mandir and infodir, since they were 171 # you also need to specify mandir and infodir, since they were
143 # passed to ./configure as absolute paths (overriding the prefix 172 # passed to ./configure as absolute paths (overriding the prefix
144 # setting). 173 # setting).
145 #make \ 174 #emake \
146 # prefix=${D}/usr \ 175 # prefix="${D}"/usr \
147 # mandir=${D}/usr/share/man \ 176 # mandir="${D}"/usr/share/man \
148 # infodir=${D}/usr/share/info \ 177 # infodir="${D}"/usr/share/info \
149 # libdir=${D}/usr/$(get_libdir) \ 178 # libdir="${D}"/usr/$(get_libdir) \
150 # install || die 179 # install || die
151 # Again, verify the Makefiles! We don't want anything falling 180 # Again, verify the Makefiles! We don't want anything falling
152 # outside of ${D}. 181 # outside of ${D}.
153 182
154 # The portage shortcut to the above command is simply: 183 # The portage shortcut to the above command is simply:
155 # 184 #
156 #einstall || die 185 #einstall || die
157 # Note that einstall will die on failure, but please use einstall || die 186#}
158 # for consistency.
159}

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

  ViewVC Help
Powered by ViewVC 1.1.20