/[gentoo-x86]/skel.ebuild
Gentoo

Diff of /skel.ebuild

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

Revision 1.22 Revision 1.39
1# Copyright 1999-2003 Gentoo Technologies, Inc. 1# Copyright 1999-2006 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.22 2003/07/18 19:54:38 vapier Exp $ 3# $Header: /var/cvsroot/gentoo-x86/skel.ebuild,v 1.39 2006/06/25 05:13:00 vapier 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# 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", "~sparc" 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,
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 67# 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 68# exists for. If the package was for an x86 binary package, then
56# KEYWORDS would be set like this: KEYWORDS="-* x86" 69# KEYWORDS would be set like this: KEYWORDS="-* x86"
57# DO NOT USE KEYWORDS="*". This is deprecated and only for backward 70# DO NOT USE KEYWORDS="*". This is deprecated and only for backward
58# compatibility reasons. 71# compatibility reasons.
59KEYWORDS="~x86" 72KEYWORDS="~x86"
60 73
61# 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,
62# 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",
63# "sparc", "x86" and "alpha". This is a required variable. If the 76# "x86" and "alpha". This is a required variable. If the ebuild doesn't
64# ebuild doesn't use any USE flags, set to "". 77# use any USE flags, set to "".
65IUSE="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"
66 83
67# Build-time dependencies, such as 84# Build-time dependencies, such as
68# ssl? ( >=openssl-0.9.6b ) 85# ssl? ( >=dev-libs/openssl-0.9.6b )
69# >=perl-5.6.1-r1 86# >=dev-lang/perl-5.6.1-r1
70# 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
71# had installed on your system when you tested the package. Then 88# had installed on your system when you tested the package. Then
72# 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
73# a dependency. 90# a dependency.
74DEPEND="" 91DEPEND=""
75 92
76# Run-time dependencies, same as DEPEND if RDEPEND isn't defined: 93# Run-time dependencies, same as DEPEND if RDEPEND isn't defined:
77#RDEPEND="" 94#RDEPEND=""
78 95
79# Source directory; the dir where the sources can be found (automatically 96# Source directory; the dir where the sources can be found (automatically
80# unpacked) inside ${WORKDIR}. S will get a default setting of ${WORKDIR}/${P} 97# unpacked) inside ${WORKDIR}. The default value for S is ${WORKDIR}/${P}
81# if you omit this line. 98# If you don't need to change it, leave the S= line out of the ebuild
99# to keep it tidy.
82S=${WORKDIR}/${P} 100S=${WORKDIR}/${P}
83 101
84src_compile() { 102src_compile() {
85 # Most open-source packages use GNU autoconf for configuration. 103 # Most open-source packages use GNU autoconf for configuration.
104 # The quickest (and preferred) way of running configure is:
105 econf || die "econf failed"
106 #
86 # You should use something similar to the following lines to 107 # You could use something similar to the following lines to
87 # configure your package before compilation. The "|| die" portion 108 # configure your package before compilation. The "|| die" portion
88 # at the end will stop the build process if the command fails. 109 # 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 110 # You should use this at the end of critical commands in the build
90 # process. (Hint: Most commands are critical, that is, the build 111 # process. (Hint: Most commands are critical, that is, the build
91 # process should abort if they aren't successful.) 112 # process should abort if they aren't successful.)
92 ./configure \ 113 #./configure \
93 --host=${CHOST} \ 114 # --host=${CHOST} \
94 --prefix=/usr \ 115 # --prefix=/usr \
95 --infodir=/usr/share/info \ 116 # --infodir=/usr/share/info \
96 --mandir=/usr/share/man || die "./configure failed" 117 # --mandir=/usr/share/man || die "./configure failed"
97 # Note the use of --infodir and --mandir, above. This is to make 118 # Note the use of --infodir and --mandir, above. This is to make
98 # this package FHS 2.2-compliant. For more information, see 119 # this package FHS 2.2-compliant. For more information, see
99 # http://www.pathname.com/fhs/ 120 # http://www.pathname.com/fhs/
100 121
101 # Also note that it is cleaner and easier to use econf, which is the
102 # portage shortcut to the above ./configure statement:
103 #
104 # econf || die
105 # Note that econf will die on failure, but plase use econf || die
106 # for consistency.
107
108 # emake (previously known as pmake) is a script that calls the 122 # emake (previously known as pmake) is a script that calls the
109 # standard GNU make with parallel building options for speedier 123 # standard GNU make with parallel building options for speedier
110 # builds (especially on SMP systems). Try emake first. It might 124 # builds (especially on SMP systems). Try emake first. It might
111 # not work for some packages, in which case you'll have to resort 125 # not work for some packages, because some makefiles have bugs
112 # to normal "make". 126 # related to parallelism, in these cases, use emake -j1 to limit
113 emake || die 127 # make to a single process. The -j1 is a visual clue to others
114 #make || die 128 # that the makefiles have bugs that have been worked around.
129 emake || die "emake failed"
115} 130}
116 131
117src_install() { 132src_install() {
118 # You must *personally verify* that this trick doesn't install 133 # You must *personally verify* that this trick doesn't install
119 # anything outside of DESTDIR; do this by reading and 134 # anything outside of DESTDIR; do this by reading and
120 # understanding the install part of the Makefiles. 135 # understanding the install part of the Makefiles.
121 make DESTDIR=${D} install || die 136 # This is the preferred way to install.
137 emake DESTDIR="${D}" install || die "emake install failed"
138
139 # When you hit a failure with emake, do not just use make. It is
140 # better to fix the Makefiles to allow proper parallelization.
141 # If you fail with that, use "emake -j1", it's still better than make.
142
122 # For Makefiles that don't make proper use of DESTDIR, setting 143 # For Makefiles that don't make proper use of DESTDIR, setting
123 # prefix is often an alternative. However if you do this, then 144 # prefix is often an alternative. However if you do this, then
124 # you also need to specify mandir and infodir, since they were 145 # you also need to specify mandir and infodir, since they were
125 # passed to ./configure as absolute paths (overriding the prefix 146 # passed to ./configure as absolute paths (overriding the prefix
126 # setting). 147 # setting).
127 #make \ 148 #emake \
128 # prefix=${D}/usr \ 149 # prefix="${D}"/usr \
129 # mandir=${D}/usr/share/man \ 150 # mandir="${D}"/usr/share/man \
130 # infodir=${D}/usr/share/info \ 151 # infodir="${D}"/usr/share/info \
131 # install || die 152 # libdir="${D}"/usr/$(get_libdir) \
153 # install || die "emake install failed"
132 # Again, verify the Makefiles! We don't want anything falling 154 # Again, verify the Makefiles! We don't want anything falling
133 # outside of ${D}. 155 # outside of ${D}.
134 156
135 # The portage shortcut to the above command is simply: 157 # The portage shortcut to the above command is simply:
136 # 158 #
137 #einstall || die 159 #einstall || die "einstall failed"
138 # Note that einstall will die on failure, but please use einstall || die
139 # for consistency.
140} 160}

Legend:
Removed from v.1.22  
changed lines
  Added in v.1.39

  ViewVC Help
Powered by ViewVC 1.1.20