/[gentoo-x86]/eclass/base.eclass
Gentoo

Diff of /eclass/base.eclass

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

Revision 1.34 Revision 1.53
1# Copyright 1999-2008 Gentoo Foundation 1# Copyright 1999-2008 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/eclass/base.eclass,v 1.34 2008/07/17 09:49:14 pva Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/base.eclass,v 1.53 2010/05/27 08:09:33 scarabeus Exp $
4 4
5# @ECLASS: base.eclass 5# @ECLASS: base.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# ??? 7# QA Team <qa@gentoo.org>
8# 8#
9# Original author Dan Armak <danarmak@gentoo.org> 9# Original author Dan Armak <danarmak@gentoo.org>
10# @BLURB: The base eclass defines some default functions and variables. 10# @BLURB: The base eclass defines some default functions and variables.
11# @DESCRIPTION: 11# @DESCRIPTION:
12# The base eclass defines some default functions and variables. Nearly 12# The base eclass defines some default functions and variables. Nearly
13# everything else inherits from here. 13# everything else inherits from here.
14 14
15
16inherit eutils 15inherit eutils
17 16
18DESCRIPTION="Based on the $ECLASS eclass" 17BASE_EXPF="src_unpack src_compile src_install"
18case "${EAPI:-0}" in
19 2|3|4) BASE_EXPF+=" src_prepare src_configure" ;;
20 *) ;;
21esac
22
23EXPORT_FUNCTIONS ${BASE_EXPF}
24
25# @ECLASS-VARIABLE: DOCS
26# @DESCRIPTION:
27# Array containing documents passed to dodoc command.
28#
29# DOCS=( "${S}/doc/document.txt" "${S}/doc/doc_folder/" )
30
31# @ECLASS-VARIABLE: HTML_DOCS
32# @DESCRIPTION:
33# Array containing documents passed to dohtml command.
34#
35# HTML_DOCS=( "${S}/doc/document.html" "${S}/doc/html_folder/" )
36
37# @ECLASS-VARIABLE: PATCHES
38# @DESCRIPTION:
39# PATCHES array variable containing all various patches to be applied.
40# This variable is expected to be defined in global scope of ebuild.
41# Make sure to specify the full path. This variable is utilised in
42# src_unpack/src_prepare phase based on EAPI.
43#
44# NOTE: if using patches folders with special file suffixes you have to
45# define one additional variable EPATCH_SUFFIX="something"
46#
47# PATCHES=( "${FILESDIR}/mypatch.patch" "${FILESDIR}/patches_folder/" )
48
19 49
20# @FUNCTION: base_src_unpack 50# @FUNCTION: base_src_unpack
21# @USAGE: [ unpack ] [ patch ] [ autopatch ] [ all ]
22# @DESCRIPTION: 51# @DESCRIPTION:
23# The base src_unpack function, which is exported. If no argument is given, 52# The base src_unpack function, which is exported.
24# "all" is assumed. 53# Calls also src_prepare with eapi older than 2.
25base_src_unpack() { 54base_src_unpack() {
55 debug-print-function $FUNCNAME "$@"
26 56
27 debug-print-function $FUNCNAME $* 57 pushd "${WORKDIR}" > /dev/null
28 [ -z "$1" ] && base_src_unpack all
29 58
30 cd "${WORKDIR}" 59 [[ -n "${A}" ]] && unpack ${A}
60 has src_prepare ${BASE_EXPF} || base_src_prepare
31 61
32 while [ "$1" ]; do 62 popd > /dev/null
63}
33 64
34 case $1 in 65# @FUNCTION: base_src_prepare
35 unpack) 66# @DESCRIPTION:
36 debug-print-section unpack 67# The base src_prepare function, which is exported
37 unpack ${A} 68# EAPI is greater or equal to 2. Here the PATCHES array is evaluated.
38 ;; 69base_src_prepare() {
39 patch) 70 debug-print-function $FUNCNAME "$@"
40 debug-print-section patch 71 debug-print "$FUNCNAME: PATCHES=$PATCHES"
41 cd "${S}" 72
42 epatch "${FILESDIR}/${P}-gentoo.diff" 73 local patches_failed=0
43 ;; 74
44 autopatch) 75 pushd "${S}" > /dev/null
45 debug-print-section autopatch 76 if [[ "$(declare -p PATCHES 2>/dev/null 2>&1)" == "declare -a"* ]]; then
46 debug-print "$FUNCNAME: autopatch: PATCHES=$PATCHES, PATCHES1=$PATCHES1"
47 cd "${S}"
48 if [[ ${#PATCHES[@]} -gt 1 ]]; then
49 for x in "${PATCHES[@]}"; do 77 for x in "${PATCHES[@]}"; do
50 debug-print "$FUNCNAME: autopatch: patching from ${x}" 78 debug-print "$FUNCNAME: applying patch from ${x}"
79 if [[ -d "${x}" ]]; then
80 # Use standardized names and locations with bulk patching
81 # Patch directory is ${WORKDIR}/patch
82 # See epatch() in eutils.eclass for more documentation
83 EPATCH_SUFFIX=${EPATCH_SUFFIX:=patch}
84
85 # in order to preserve normal EPATCH_SOURCE value that can
86 # be used other way than with base eclass store in local
87 # variable and restore later
88 oldval=${EPATCH_SOURCE}
89 EPATCH_SOURCE=${x}
90 EPATCH_FORCE=yes
91 epatch
92 EPATCH_SOURCE=${oldval}
93 elif [[ -f "${x}" ]]; then
51 epatch "${x}" 94 epatch "${x}"
52 done
53 else 95 else
54 for x in ${PATCHES} ${PATCHES1}; do 96 ewarn "QA: File or directory \"${x}\" does not exist."
55 debug-print "$FUNCNAME: autopatch: patching from ${x}" 97 ewarn "QA: Check your PATCHES array or add missing file/directory."
56 epatch "${x}" 98 patches_failed=1
57 done
58 fi 99 fi
59 ;; 100 done
60 all) 101 [[ ${patches_failed} -eq 1 ]] && die "Some patches failed. See above messages."
61 debug-print-section all 102 else
62 base_src_unpack unpack autopatch 103 for x in ${PATCHES}; do
63 ;; 104 debug-print "$FUNCNAME: patching from ${x}"
64 esac 105 epatch "${x}"
106 done
107 fi
65 108
66 shift 109 # Apply user patches
67 done 110 debug-print "$FUNCNAME: applying user patches"
111 epatch_user
68 112
113 popd > /dev/null
114}
115
116# @FUNCTION: base_src_configure
117# @DESCRIPTION:
118# The base src_configure function, which is exported when
119# EAPI is greater or equal to 2. Runs basic econf.
120base_src_configure() {
121 debug-print-function $FUNCNAME "$@"
122
123 # there is no pushd ${S} so we can override its place where to run
124 [[ -x ${ECONF_SOURCE:-.}/configure ]] && econf "$@"
69} 125}
70 126
71# @FUNCTION: base_src_compile 127# @FUNCTION: base_src_compile
72# @USAGE: [ configure ] [ make ] [ all ]
73# @DESCRIPTION: 128# @DESCRIPTION:
74# The base src_compile function, which is exported. If no argument is given, 129# The base src_compile function, calls src_configure with
75# "all" is asasumed. 130# EAPI older than 2.
76base_src_compile() { 131base_src_compile() {
132 debug-print-function $FUNCNAME "$@"
77 133
78 debug-print-function $FUNCNAME $* 134 has src_configure ${BASE_EXPF} || base_src_configure
79 [ -z "$1" ] && base_src_compile all 135 base_src_make "$@"
136}
80 137
81 cd "${S}" 138# @FUNCTION: base_src_make
139# @DESCRIPTION:
140# Actual function that runs emake command.
141base_src_make() {
142 debug-print-function $FUNCNAME "$@"
82 143
83 while [ "$1" ]; do 144 if [[ -f Makefile || -f GNUmakefile || -f makefile ]]; then
84
85 case $1 in
86 configure)
87 debug-print-section configure
88 econf || die "died running econf, $FUNCNAME:configure"
89 ;;
90 make)
91 debug-print-section make
92 emake || die "died running emake, $FUNCNAME:make" 145 emake "$@" || die "died running emake, $FUNCNAME"
93 ;; 146 fi
94 all)
95 debug-print-section all
96 base_src_compile configure make
97 ;;
98 esac
99
100 shift
101 done
102
103} 147}
104 148
105# @FUNCTION: base_src_install 149# @FUNCTION: base_src_install
106# @USAGE: [ make ] [ all ]
107# @DESCRIPTION: 150# @DESCRIPTION:
108# The base src_install function, which is exported. If no argument is given, 151# The base src_install function. Runs make install and
109# "all" is assumed. 152# installs documents and html documents from DOCS and HTML_DOCS
153# arrays.
110base_src_install() { 154base_src_install() {
155 debug-print-function $FUNCNAME "$@"
111 156
112 debug-print-function $FUNCNAME $*
113 [ -z "$1" ] && base_src_install all
114
115 cd "${S}"
116
117 while [ "$1" ]; do
118
119 case $1 in
120 make)
121 debug-print-section make
122 make DESTDIR="${D}" install || die "died running make install, $FUNCNAME:make" 157 emake DESTDIR="${D}" "$@" install || die "died running make install, $FUNCNAME"
123 ;; 158 base_src_install_docs
124 all)
125 debug-print-section all
126 base_src_install make
127 ;;
128 esac
129
130 shift
131 done
132
133} 159}
134 160
135EXPORT_FUNCTIONS src_unpack src_compile src_install 161# @FUNCTION: base_src_install_docs
162# @DESCRIPTION:
163# Actual function that install documentation from
164# DOCS and HTML_DOCS arrays.
165base_src_install_docs() {
166 debug-print-function $FUNCNAME "$@"
167
168 local x
169
170 pushd "${S}" > /dev/null
171
172 if [[ "$(declare -p DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
173 for x in "${DOCS[@]}"; do
174 debug-print "$FUNCNAME: docs: creating document from ${x}"
175 dodoc "${x}" || die "dodoc failed"
176 done
177 fi
178 if [[ "$(declare -p HTML_DOCS 2>/dev/null 2>&1)" == "declare -a"* ]]; then
179 for x in "${HTML_DOCS[@]}"; do
180 debug-print "$FUNCNAME: docs: creating html document from ${x}"
181 dohtml -r "${x}" || die "dohtml failed"
182 done
183 fi
184
185 popd > /dev/null
186}
Legend:
Removed from v.1.34  
changed lines
  Added in v.1.53
  ViewVC Help
Powered by ViewVC 1.1.13