/[gentoo-x86]/skel.ebuild
Gentoo

Diff of /skel.ebuild

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

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

Legend:
Removed from v.1.19  
changed lines
  Added in v.1.42

  ViewVC Help
Powered by ViewVC 1.1.20