1 |
hollow 08/02/06 08:33:48 |
2 |
|
3 |
Modified: depend.apache.eclass |
4 |
Log: |
5 |
update depend.apache.eclass documentation |
6 |
|
7 |
Revision Changes Path |
8 |
1.40 eclass/depend.apache.eclass |
9 |
|
10 |
file : http://sources.gentoo.org/viewcvs.py/gentoo-x86/eclass/depend.apache.eclass?rev=1.40&view=markup |
11 |
plain: http://sources.gentoo.org/viewcvs.py/gentoo-x86/eclass/depend.apache.eclass?rev=1.40&content-type=text/plain |
12 |
diff : http://sources.gentoo.org/viewcvs.py/gentoo-x86/eclass/depend.apache.eclass?r1=1.39&r2=1.40 |
13 |
|
14 |
Index: depend.apache.eclass |
15 |
=================================================================== |
16 |
RCS file: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v |
17 |
retrieving revision 1.39 |
18 |
retrieving revision 1.40 |
19 |
diff -u -r1.39 -r1.40 |
20 |
--- depend.apache.eclass 3 Feb 2008 14:12:44 -0000 1.39 |
21 |
+++ depend.apache.eclass 6 Feb 2008 08:33:47 -0000 1.40 |
22 |
@@ -1,19 +1,39 @@ |
23 |
# Copyright 1999-2007 Gentoo Foundation |
24 |
# Distributed under the terms of the GNU General Public License v2 |
25 |
-# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.39 2008/02/03 14:12:44 hollow Exp $ |
26 |
+# $Header: /var/cvsroot/gentoo-x86/eclass/depend.apache.eclass,v 1.40 2008/02/06 08:33:47 hollow Exp $ |
27 |
|
28 |
# @ECLASS: depend.apache.eclass |
29 |
# @MAINTAINER: apache-devs@g.o |
30 |
# @BLURB: Functions to allow ebuilds to depend on apache |
31 |
# @DESCRIPTION: |
32 |
-# This eclass handles depending on apache in a sane way and providing |
33 |
-# information about where certain interfaces are located. |
34 |
+# This eclass handles depending on apache in a sane way and provides information |
35 |
+# about where certain binaries and configuration files are located. |
36 |
# |
37 |
-# @NOTE: If you use this, be sure you use the need_* call after you have defined |
38 |
-# DEPEND and RDEPEND. Also note that you can not rely on the automatic |
39 |
+# To make use of this eclass simply call one of the need/want_apache functions |
40 |
+# described below. Make sure you use the need/want_apache call after you have |
41 |
+# defined DEPEND and RDEPEND. Also note that you can not rely on the automatic |
42 |
# RDEPEND=DEPEND that portage does if you use this eclass. |
43 |
# |
44 |
-# See bug 107127 for more information. |
45 |
+# See Bug 107127 for more information. |
46 |
+# |
47 |
+# @EXAMPLE: |
48 |
+# |
49 |
+# Here is an example of an ebuild depending on apache: |
50 |
+# |
51 |
+# @CODE |
52 |
+# DEPEND="virtual/Perl-CGI" |
53 |
+# RDEPEND="${DEPEND}" |
54 |
+# need_apache2 |
55 |
+# @CODE |
56 |
+# |
57 |
+# Another example which demonstrates non-standard IUSE options for optional |
58 |
+# apache support: |
59 |
+# |
60 |
+# @CODE |
61 |
+# DEPEND="server? ( virtual/Perl-CGI )" |
62 |
+# RDEPEND="${DEPEND}" |
63 |
+# want_apache2 server |
64 |
+# @CODE |
65 |
|
66 |
inherit multilib |
67 |
|
68 |
@@ -23,36 +43,48 @@ |
69 |
|
70 |
# @ECLASS-VARIABLE: APACHE_VERSION |
71 |
# @DESCRIPTION: |
72 |
-# Stores the version of apache we are going to be ebuilding. This variable is |
73 |
-# set by the need_apache functions. |
74 |
+# Stores the version of apache we are going to be ebuilding. |
75 |
+# This variable is set by the want/need_apache functions. |
76 |
|
77 |
# @ECLASS-VARIABLE: APXS |
78 |
# @DESCRIPTION: |
79 |
-# Paths to the apxs tool |
80 |
+# Paths to the apxs tool. |
81 |
+# This variable is set by the want/need_apache functions. |
82 |
+ |
83 |
+# @ECLASS-VARIABLE: APACHE_BIN |
84 |
+# @DESCRIPTION: |
85 |
+# Path to the apache binary. |
86 |
+# This variable is set by the want/need_apache functions. |
87 |
|
88 |
-# @ECLASS-VARIABLE: APACHECTL |
89 |
+# @ECLASS-VARIABLE: APACHE_CTL |
90 |
# @DESCRIPTION: |
91 |
-# Path to the apachectl tool |
92 |
+# Path to the apachectl tool. |
93 |
+# This variable is set by the want/need_apache functions. |
94 |
|
95 |
# @ECLASS-VARIABLE: APACHE_BASEDIR |
96 |
# @DESCRIPTION: |
97 |
-# Path to the server root directory |
98 |
+# Path to the server root directory. |
99 |
+# This variable is set by the want/need_apache functions. |
100 |
|
101 |
# @ECLASS-VARIABLE: APACHE_CONFDIR |
102 |
# @DESCRIPTION: |
103 |
-# Path to the configuration file directory |
104 |
+# Path to the configuration file directory. |
105 |
+# This variable is set by the want/need_apache functions. |
106 |
|
107 |
# @ECLASS-VARIABLE: APACHE_MODULES_CONFDIR |
108 |
# @DESCRIPTION: |
109 |
-# Path where module configuration files are kept |
110 |
+# Path where module configuration files are kept. |
111 |
+# This variable is set by the want/need_apache functions. |
112 |
|
113 |
# @ECLASS-VARIABLE: APACHE_VHOSTS_CONFDIR |
114 |
# @DESCRIPTION: |
115 |
-# Path where virtual host configuration files are kept |
116 |
+# Path where virtual host configuration files are kept. |
117 |
+# This variable is set by the want/need_apache functions. |
118 |
|
119 |
# @ECLASS-VARIABLE: APACHE_MODULESDIR |
120 |
# @DESCRIPTION: |
121 |
-# Path where we install modules |
122 |
+# Path where we install modules. |
123 |
+# This variable is set by the want/need_apache functions. |
124 |
|
125 |
# @ECLASS-VARIABLE: APACHE_DEPEND |
126 |
# @DESCRIPTION: |
127 |
@@ -101,9 +133,20 @@ |
128 |
# ============================================================================== |
129 |
|
130 |
# @FUNCTION: want_apache |
131 |
+# @USAGE: [myiuse] |
132 |
+# @DESCRIPTION: |
133 |
+# An ebuild calls this to get the dependency information for optional apache |
134 |
+# support. If the myiuse parameter is not given it defaults to apache2. |
135 |
+want_apache() { |
136 |
+ debug-print-function $FUNCNAME $* |
137 |
+ want_apache2 "$@" |
138 |
+} |
139 |
+ |
140 |
+# @FUNCTION: want_apache2 |
141 |
+# @USAGE: [myiuse] |
142 |
# @DESCRIPTION: |
143 |
# An ebuild calls this to get the dependency information for optional apache-2.x |
144 |
-# support. |
145 |
+# support. If the myiuse parameter is not given it defaults to apache2. |
146 |
want_apache2() { |
147 |
debug-print-function $FUNCNAME $* |
148 |
|
149 |
@@ -119,10 +162,12 @@ |
150 |
fi |
151 |
} |
152 |
|
153 |
-# @FUNCTION: want_apache |
154 |
+# @FUNCTION: want_apache2_2 |
155 |
+# @USAGE: [myiuse] |
156 |
# @DESCRIPTION: |
157 |
# An ebuild calls this to get the dependency information for optional |
158 |
-# apache-2.2.x support. |
159 |
+# apache-2.2.x support. If the myiuse parameter is not given it defaults to |
160 |
+# apache2. |
161 |
want_apache2_2() { |
162 |
debug-print-function $FUNCNAME $* |
163 |
|
164 |
@@ -138,19 +183,17 @@ |
165 |
fi |
166 |
} |
167 |
|
168 |
-# @FUNCTION: want_apache |
169 |
+# @FUNCTION: need_apache |
170 |
# @DESCRIPTION: |
171 |
-# An ebuild calls this to get the dependency information for optional apache |
172 |
-# support. |
173 |
-want_apache() { |
174 |
+# An ebuild calls this to get the dependency information for apache. |
175 |
+need_apache() { |
176 |
debug-print-function $FUNCNAME $* |
177 |
- want_apache2 "$@" |
178 |
+ need_apache2 |
179 |
} |
180 |
|
181 |
# @FUNCTION: need_apache2 |
182 |
# @DESCRIPTION: |
183 |
-# Works like need_apache, but its used by modules that only support |
184 |
-# apache 2.x and do not work with other versions. |
185 |
+# An ebuild calls this to get the dependency information for apache-2.x. |
186 |
need_apache2() { |
187 |
debug-print-function $FUNCNAME $* |
188 |
|
189 |
@@ -161,8 +204,7 @@ |
190 |
|
191 |
# @FUNCTION: need_apache2_2 |
192 |
# @DESCRIPTION: |
193 |
-# Works like need_apache, but its used by modules that only support |
194 |
-# apache 2.2.x and do not work with other versions. |
195 |
+# An ebuild calls this to get the dependency information for apache-2.2.x. |
196 |
need_apache2_2() { |
197 |
debug-print-function $FUNCNAME $* |
198 |
|
199 |
@@ -170,14 +212,3 @@ |
200 |
RDEPEND="${RDEPEND} ${APACHE2_2_DEPEND}" |
201 |
_init_apache2 |
202 |
} |
203 |
- |
204 |
-# @FUNCTION: need_apache |
205 |
-# @DESCRIPTION: |
206 |
-# An ebuild calls this to get the dependency information for apache. An |
207 |
-# ebuild should use this in order for future changes to the build infrastructure |
208 |
-# to happen seamlessly. All an ebuild needs to do is include the line |
209 |
-# need_apache somewhere. |
210 |
-need_apache() { |
211 |
- debug-print-function $FUNCNAME $* |
212 |
- need_apache2 |
213 |
-} |
214 |
|
215 |
|
216 |
|
217 |
-- |
218 |
gentoo-commits@l.g.o mailing list |