1 |
vapier 08/06/01 01:43:07 |
2 |
|
3 |
Modified: autotools.eclass |
4 |
Log: |
5 |
add eclass documentation by mren #210546 |
6 |
|
7 |
Revision Changes Path |
8 |
1.76 eclass/autotools.eclass |
9 |
|
10 |
file : http://sources.gentoo.org/viewcvs.py/gentoo-x86/eclass/autotools.eclass?rev=1.76&view=markup |
11 |
plain: http://sources.gentoo.org/viewcvs.py/gentoo-x86/eclass/autotools.eclass?rev=1.76&content-type=text/plain |
12 |
diff : http://sources.gentoo.org/viewcvs.py/gentoo-x86/eclass/autotools.eclass?r1=1.75&r2=1.76 |
13 |
|
14 |
Index: autotools.eclass |
15 |
=================================================================== |
16 |
RCS file: /var/cvsroot/gentoo-x86/eclass/autotools.eclass,v |
17 |
retrieving revision 1.75 |
18 |
retrieving revision 1.76 |
19 |
diff -u -r1.75 -r1.76 |
20 |
--- autotools.eclass 24 Apr 2008 03:15:43 -0000 1.75 |
21 |
+++ autotools.eclass 1 Jun 2008 01:43:06 -0000 1.76 |
22 |
@@ -1,17 +1,27 @@ |
23 |
# Copyright 1999-2008 Gentoo Foundation |
24 |
# Distributed under the terms of the GNU General Public License v2 |
25 |
-# $Header: /var/cvsroot/gentoo-x86/eclass/autotools.eclass,v 1.75 2008/04/24 03:15:43 vapier Exp $ |
26 |
-# |
27 |
-# Maintainer: base-system@g.o |
28 |
-# |
29 |
-# This eclass is for handling autotooled software packages that |
30 |
-# needs to regenerate their build scripts. |
31 |
+# $Header: /var/cvsroot/gentoo-x86/eclass/autotools.eclass,v 1.76 2008/06/01 01:43:06 vapier Exp $ |
32 |
+ |
33 |
+# @ECLASS: autotools.eclass |
34 |
+# @MAINTAINER: |
35 |
+# base-system@g.o |
36 |
+# @BLURB: Regenerates auto* build scripts |
37 |
+# @DESCRIPTION: |
38 |
+# This eclass is for safely handling autotooled software packages that need to |
39 |
+# regenerate their build scripts. All functions will abort in case of errors. |
40 |
# |
41 |
# NB: If you add anything, please comment it! |
42 |
|
43 |
inherit eutils libtool |
44 |
|
45 |
+# @ECLASS-VARIABLE: WANT_AUTOCONF |
46 |
+# @DESCRIPTION: |
47 |
+# The major version of autoconf your package needs |
48 |
[[ -z ${WANT_AUTOCONF} ]] && WANT_AUTOCONF="latest" |
49 |
+ |
50 |
+# @ECLASS-VARIABLE: WANT_AUTOMAKE |
51 |
+# @DESCRIPTION: |
52 |
+# The major version of automake your package needs |
53 |
[[ -z ${WANT_AUTOMAKE} ]] && WANT_AUTOMAKE="latest" |
54 |
|
55 |
_automake_atom="sys-devel/automake" |
56 |
@@ -42,37 +52,33 @@ |
57 |
RDEPEND="" |
58 |
unset _automake_atom _autoconf_atom |
59 |
|
60 |
-# Variables: |
61 |
-# |
62 |
-# AT_M4DIR - Additional director(y|ies) aclocal should search |
63 |
-# AM_OPTS - Additional options to pass to automake during |
64 |
-# eautoreconf call. |
65 |
-# AT_NOELIBTOOLIZE - Don't run elibtoolize command if set to 'yes', |
66 |
-# useful when elibtoolize needs to be ran with |
67 |
-# particular options |
68 |
- |
69 |
-# Functions: |
70 |
-# |
71 |
-# eautoreconf() - Should do a full autoreconf - normally what most people |
72 |
-# will be interested in. Also should handle additional |
73 |
-# directories specified by AC_CONFIG_SUBDIRS. |
74 |
-# eaclocal() - Runs aclocal. Respects AT_M4DIR for additional directories |
75 |
-# to search for macro's. |
76 |
-# _elibtoolize() - Runs libtoolize. Note the '_' prefix .. to not collide |
77 |
-# with elibtoolize() from libtool.eclass |
78 |
-# eautoconf - Runs autoconf. |
79 |
-# eautoheader - Runs autoheader. |
80 |
-# eautomake - Runs automake |
81 |
-# |
82 |
+# @ECLASS-VARIABLE: AM_OPTS |
83 |
+# @DESCRIPTION: |
84 |
+# Additional options to pass to automake during |
85 |
+# eautoreconf call. |
86 |
+ |
87 |
+# @ECLASS-VARIABLE: AT_NOELIBTOOLIZE |
88 |
+# @DESCRIPTION: |
89 |
+# Don't run elibtoolize command if set to 'yes', |
90 |
+# useful when elibtoolize needs to be ran with |
91 |
+# particular options |
92 |
|
93 |
# XXX: M4DIR should be deprecated |
94 |
+# @ECLASS-VARIABLE: AT_M4DIR |
95 |
+# @DESCRIPTION: |
96 |
+# Additional director(y|ies) aclocal should search |
97 |
AT_M4DIR=${AT_M4DIR:-${M4DIR}} |
98 |
AT_GNUCONF_UPDATE="no" |
99 |
|
100 |
|
101 |
+# @FUNCTION: eautoreconf |
102 |
+# @DESCRIPTION: |
103 |
# This function mimes the behavior of autoreconf, but uses the different |
104 |
# eauto* functions to run the tools. It doesn't accept parameters, but |
105 |
# the directory with include files can be specified with AT_M4DIR variable. |
106 |
+# |
107 |
+# Should do a full autoreconf - normally what most people will be interested in. |
108 |
+# Also should handle additional directories specified by AC_CONFIG_SUBDIRS. |
109 |
eautoreconf() { |
110 |
local pwd=$(pwd) x auxdir |
111 |
|
112 |
@@ -110,10 +116,13 @@ |
113 |
return 0 |
114 |
} |
115 |
|
116 |
+# @FUNCTION: eaclocal |
117 |
+# @DESCRIPTION: |
118 |
# These functions runs the autotools using autotools_run_tool with the |
119 |
# specified parametes. The name of the tool run is the same of the function |
120 |
# without e prefix. |
121 |
# They also force installing the support files for safety. |
122 |
+# Respects AT_M4DIR for additional directories to search for macro's. |
123 |
eaclocal() { |
124 |
local aclocal_opts |
125 |
|
126 |
@@ -143,6 +152,10 @@ |
127 |
autotools_run_tool aclocal "$@" ${aclocal_opts} |
128 |
} |
129 |
|
130 |
+# @FUNCTION: _elibtoolize |
131 |
+# @DESCRIPTION: |
132 |
+# Runs libtoolize. Note the '_' prefix .. to not collide with elibtoolize() from |
133 |
+# libtool.eclass. |
134 |
_elibtoolize() { |
135 |
local opts |
136 |
local lttest |
137 |
@@ -161,12 +174,18 @@ |
138 |
eaclocal |
139 |
} |
140 |
|
141 |
+# @FUNCTION: eautoheader |
142 |
+# @DESCRIPTION: |
143 |
+# Runs autoheader. |
144 |
eautoheader() { |
145 |
# Check if we should run autoheader |
146 |
[[ -n $(autotools_check_macro "AC_CONFIG_HEADERS") ]] || return 0 |
147 |
NO_FAIL=1 autotools_run_tool autoheader "$@" |
148 |
} |
149 |
|
150 |
+# @FUNCTION: eautoconf |
151 |
+# @DESCRIPTION: |
152 |
+# Runs autoconf. |
153 |
eautoconf() { |
154 |
if [[ ! -f configure.ac && ! -f configure.in ]] ; then |
155 |
echo |
156 |
@@ -178,6 +197,9 @@ |
157 |
autotools_run_tool autoconf "$@" |
158 |
} |
159 |
|
160 |
+# @FUNCTION: eautomake |
161 |
+# @DESCRIPTION: |
162 |
+# Runs automake. |
163 |
eautomake() { |
164 |
local extra_opts |
165 |
local makefile_name |
166 |
|
167 |
|
168 |
|
169 |
-- |
170 |
gentoo-commits@l.g.o mailing list |