/[gentoo-x86]/eclass/depend.apache.eclass
Gentoo

Diff of /eclass/depend.apache.eclass

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

Revision 1.39 Revision 1.43
1# Copyright 1999-2007 Gentoo Foundation 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/eclass/depend.apache.eclass,v 1.39 2008/02/03 14:12:44 hollow Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.43 2008/02/06 23:45:13 hollow Exp $
4 4
5# @ECLASS: depend.apache.eclass 5# @ECLASS: depend.apache.eclass
6# @MAINTAINER: apache-devs@gentoo.org 6# @MAINTAINER: apache-devs@gentoo.org
7# @BLURB: Functions to allow ebuilds to depend on apache 7# @BLURB: Functions to allow ebuilds to depend on apache
8# @DESCRIPTION: 8# @DESCRIPTION:
9# This eclass handles depending on apache in a sane way and providing 9# This eclass handles depending on apache in a sane way and provides information
10# information about where certain interfaces are located. 10# about where certain binaries and configuration files are located.
11# 11#
12# @NOTE: If you use this, be sure you use the need_* call after you have defined 12# To make use of this eclass simply call one of the need/want_apache functions
13# described below. Make sure you use the need/want_apache call after you have
13# DEPEND and RDEPEND. Also note that you can not rely on the automatic 14# defined DEPEND and RDEPEND. Also note that you can not rely on the automatic
14# RDEPEND=DEPEND that portage does if you use this eclass. 15# RDEPEND=DEPEND that portage does if you use this eclass.
15# 16#
16# See bug 107127 for more information. 17# See Bug 107127 for more information.
18#
19# @EXAMPLE:
20#
21# Here is an example of an ebuild depending on apache:
22#
23# @CODE
24# DEPEND="virtual/Perl-CGI"
25# RDEPEND="${DEPEND}"
26# need_apache2
27# @CODE
28#
29# Another example which demonstrates non-standard IUSE options for optional
30# apache support:
31#
32# @CODE
33# DEPEND="server? ( virtual/Perl-CGI )"
34# RDEPEND="${DEPEND}"
35# want_apache2 server
36# @CODE
17 37
18inherit multilib 38inherit multilib
19 39
20# ============================================================================== 40# ==============================================================================
21# INTERNAL VARIABLES 41# INTERNAL VARIABLES
22# ============================================================================== 42# ==============================================================================
23 43
24# @ECLASS-VARIABLE: APACHE_VERSION 44# @ECLASS-VARIABLE: APACHE_VERSION
25# @DESCRIPTION: 45# @DESCRIPTION:
26# Stores the version of apache we are going to be ebuilding. This variable is 46# Stores the version of apache we are going to be ebuilding.
27# set by the need_apache functions. 47# This variable is set by the want/need_apache functions.
28 48
29# @ECLASS-VARIABLE: APXS 49# @ECLASS-VARIABLE: APXS
30# @DESCRIPTION: 50# @DESCRIPTION:
31# Paths to the apxs tool 51# Path to the apxs tool.
52# This variable is set by the want/need_apache functions.
32 53
54# @ECLASS-VARIABLE: APACHE_BIN
55# @DESCRIPTION:
56# Path to the apache binary.
57# This variable is set by the want/need_apache functions.
58
33# @ECLASS-VARIABLE: APACHECTL 59# @ECLASS-VARIABLE: APACHE_CTL
34# @DESCRIPTION: 60# @DESCRIPTION:
35# Path to the apachectl tool 61# Path to the apachectl tool.
62# This variable is set by the want/need_apache functions.
36 63
37# @ECLASS-VARIABLE: APACHE_BASEDIR 64# @ECLASS-VARIABLE: APACHE_BASEDIR
38# @DESCRIPTION: 65# @DESCRIPTION:
39# Path to the server root directory 66# Path to the server root directory.
67# This variable is set by the want/need_apache functions.
40 68
41# @ECLASS-VARIABLE: APACHE_CONFDIR 69# @ECLASS-VARIABLE: APACHE_CONFDIR
42# @DESCRIPTION: 70# @DESCRIPTION:
43# Path to the configuration file directory 71# Path to the configuration file directory.
72# This variable is set by the want/need_apache functions.
44 73
45# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR 74# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR
46# @DESCRIPTION: 75# @DESCRIPTION:
47# Path where module configuration files are kept 76# Path where module configuration files are kept.
77# This variable is set by the want/need_apache functions.
48 78
49# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR 79# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR
50# @DESCRIPTION: 80# @DESCRIPTION:
51# Path where virtual host configuration files are kept 81# Path where virtual host configuration files are kept.
82# This variable is set by the want/need_apache functions.
52 83
53# @ECLASS-VARIABLE: APACHE_MODULESDIR 84# @ECLASS-VARIABLE: APACHE_MODULESDIR
54# @DESCRIPTION: 85# @DESCRIPTION:
55# Path where we install modules 86# Path where we install modules.
87# This variable is set by the want/need_apache functions.
56 88
57# @ECLASS-VARIABLE: APACHE_DEPEND 89# @ECLASS-VARIABLE: APACHE_DEPEND
58# @DESCRIPTION: 90# @DESCRIPTION:
59# Dependencies for Apache 91# Dependencies for Apache
60APACHE_DEPEND="www-servers/apache" 92APACHE_DEPEND="www-servers/apache"
80 # into the dependency cache (DEPEND/RDEPEND/etc) 112 # into the dependency cache (DEPEND/RDEPEND/etc)
81 APACHE_VERSION="2" 113 APACHE_VERSION="2"
82 APXS="/usr/sbin/apxs2" 114 APXS="/usr/sbin/apxs2"
83 APACHE_BIN="/usr/sbin/apache2" 115 APACHE_BIN="/usr/sbin/apache2"
84 APACHE_CTL="/usr/sbin/apache2ctl" 116 APACHE_CTL="/usr/sbin/apache2ctl"
85 # legacy alias 117 APACHE_INCLUDEDIR="/usr/include/apache2"
86 APACHECTL="${APACHE_CTL}"
87 APACHE_BASEDIR="/usr/$(get_libdir)/apache2" 118 APACHE_BASEDIR="/usr/$(get_libdir)/apache2"
88 APACHE_CONFDIR="/etc/apache2" 119 APACHE_CONFDIR="/etc/apache2"
89 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d" 120 APACHE_MODULES_CONFDIR="${APACHE_CONFDIR}/modules.d"
90 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d" 121 APACHE_VHOSTS_CONFDIR="${APACHE_CONFDIR}/vhosts.d"
91 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules" 122 APACHE_MODULESDIR="${APACHE_BASEDIR}/modules"
99# ============================================================================== 130# ==============================================================================
100# PUBLIC FUNCTIONS 131# PUBLIC FUNCTIONS
101# ============================================================================== 132# ==============================================================================
102 133
103# @FUNCTION: want_apache 134# @FUNCTION: want_apache
135# @USAGE: [myiuse]
136# @DESCRIPTION:
137# An ebuild calls this to get the dependency information for optional apache
138# support. If the myiuse parameter is not given it defaults to apache2.
139want_apache() {
140 debug-print-function $FUNCNAME $*
141 want_apache2 "$@"
142}
143
144# @FUNCTION: want_apache2
145# @USAGE: [myiuse]
104# @DESCRIPTION: 146# @DESCRIPTION:
105# An ebuild calls this to get the dependency information for optional apache-2.x 147# An ebuild calls this to get the dependency information for optional apache-2.x
106# support. 148# support. If the myiuse parameter is not given it defaults to apache2.
107want_apache2() { 149want_apache2() {
108 debug-print-function $FUNCNAME $* 150 debug-print-function $FUNCNAME $*
109 151
110 local myiuse=${1:-apache2} 152 local myiuse=${1:-apache2}
111 IUSE="${IUSE} ${myiuse}" 153 IUSE="${IUSE} ${myiuse}"
117 else 159 else
118 _init_no_apache 160 _init_no_apache
119 fi 161 fi
120} 162}
121 163
122# @FUNCTION: want_apache 164# @FUNCTION: want_apache2_2
165# @USAGE: [myiuse]
123# @DESCRIPTION: 166# @DESCRIPTION:
124# An ebuild calls this to get the dependency information for optional 167# An ebuild calls this to get the dependency information for optional
125# apache-2.2.x support. 168# apache-2.2.x support. If the myiuse parameter is not given it defaults to
169# apache2.
126want_apache2_2() { 170want_apache2_2() {
127 debug-print-function $FUNCNAME $* 171 debug-print-function $FUNCNAME $*
128 172
129 local myiuse=${1:-apache2} 173 local myiuse=${1:-apache2}
130 IUSE="${IUSE} ${myiuse}" 174 IUSE="${IUSE} ${myiuse}"
136 else 180 else
137 _init_no_apache 181 _init_no_apache
138 fi 182 fi
139} 183}
140 184
141# @FUNCTION: want_apache 185# @FUNCTION: need_apache
142# @DESCRIPTION: 186# @DESCRIPTION:
143# An ebuild calls this to get the dependency information for optional apache 187# An ebuild calls this to get the dependency information for apache.
144# support.
145want_apache() { 188need_apache() {
146 debug-print-function $FUNCNAME $* 189 debug-print-function $FUNCNAME $*
147 want_apache2 "$@" 190 need_apache2
148} 191}
149 192
150# @FUNCTION: need_apache2 193# @FUNCTION: need_apache2
151# @DESCRIPTION: 194# @DESCRIPTION:
152# Works like need_apache, but its used by modules that only support 195# An ebuild calls this to get the dependency information for apache-2.x.
153# apache 2.x and do not work with other versions.
154need_apache2() { 196need_apache2() {
155 debug-print-function $FUNCNAME $* 197 debug-print-function $FUNCNAME $*
156 198
157 DEPEND="${DEPEND} ${APACHE2_DEPEND}" 199 DEPEND="${DEPEND} ${APACHE2_DEPEND}"
158 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}" 200 RDEPEND="${RDEPEND} ${APACHE2_DEPEND}"
159 _init_apache2 201 _init_apache2
160} 202}
161 203
162# @FUNCTION: need_apache2_2 204# @FUNCTION: need_apache2_2
163# @DESCRIPTION: 205# @DESCRIPTION:
164# Works like need_apache, but its used by modules that only support 206# An ebuild calls this to get the dependency information for apache-2.2.x.
165# apache 2.2.x and do not work with other versions.
166need_apache2_2() { 207need_apache2_2() {
167 debug-print-function $FUNCNAME $* 208 debug-print-function $FUNCNAME $*
168 209
169 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}" 210 DEPEND="${DEPEND} ${APACHE2_2_DEPEND}"
170 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}" 211 RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}"
171 _init_apache2 212 _init_apache2
172} 213}
173 214
174# @FUNCTION: need_apache 215# @FUNCTION: has_apache_threads
216# @USAGE: [myflag]
175# @DESCRIPTION: 217# @DESCRIPTION:
176# An ebuild calls this to get the dependency information for apache. An 218# An ebuild calls this to make sure thread-safety is enabled if apache has been
177# ebuild should use this in order for future changes to the build infrastructure 219# built with a threaded MPM. If the myflag parameter is not given it defaults to
178# to happen seamlessly. All an ebuild needs to do is include the line 220# threads.
179# need_apache somewhere. 221has_apache_threads() {
180need_apache() {
181 debug-print-function $FUNCNAME $* 222 debug-print-function $FUNCNAME $*
182 need_apache2 223
224 if ! built_with_use www-servers/apache threads ; then
225 return
226 fi
227
228 local myflag="${1:-threads}"
229
230 if ! use ${myflag} ; then
231 echo
232 eerror "You need to enable USE flag '${myflag}' to build a thread-safe version"
233 eerror "of ${CATEGORY}/${PN} for use with www-servers/apache"
234 die "Need missing USE flag '${myflag}'"
235 fi
183} 236}
237
238# @FUNCTION: has_apache_threads_in
239# @USAGE: <myforeign> [myflag]
240# @DESCRIPTION:
241# An ebuild calls this to make sure thread-safety is enabled in a foreign
242# package if apache has been built with a threaded MPM. If the myflag parameter
243# is not given it defaults to threads.
244has_apache_threads_in() {
245 debug-print-function $FUNCNAME $*
246
247 if ! built_with_use www-servers/apache threads ; then
248 return
249 fi
250
251 local myforeign="$1"
252 local myflag="${2:-threads}"
253
254 if ! built_with_use ${myforeign} ${myflag} ; then
255 echo
256 eerror "You need to enable USE flag '${myflag}' in ${myforeign} to"
257 eerror "build a thread-safe version of ${CATEGORY}/${PN} for use"
258 eerror "with www-servers/apache"
259 die "Need missing USE flag '${myflag}' in ${myforeign}"
260 fi
261}

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

  ViewVC Help
Powered by ViewVC 1.1.20