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