1 # Copyright 1999-2019 Gentoo Authors
2 # Distributed under the terms of the GNU General Public License v2
4 # @ECLASS: gnome2.eclass
7 # @SUPPORTED_EAPIS: 4 5 6
8 # @BLURB: Provides phases for Gnome/Gtk+ based packages.
10 # Exports portage base functions used by ebuilds written for packages using the
11 # GNOME framework. For additional functions, see gnome2-utils.eclass.
13 # @ECLASS-VARIABLE: GNOME2_EAUTORECONF
16 # Run eautoreconf instead of only elibtoolize
17 GNOME2_EAUTORECONF=${GNOME2_EAUTORECONF:-""}
19 [[ ${GNOME2_EAUTORECONF} == 'yes' ]] && inherit autotools
20 inherit eutils libtool gnome.org gnome2-utils xdg
24 EXPORT_FUNCTIONS src_unpack src_prepare src_configure src_compile src_install pkg_preinst pkg_postinst pkg_postrm
27 EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install pkg_preinst pkg_postinst pkg_postrm
29 *) die "EAPI=${EAPI} is not supported" ;;
32 # @ECLASS-VARIABLE: DOCS
35 # String containing documents passed to dodoc command for eapi4.
36 # In eapi5 we rely on einstalldocs (from eutils.eclass) and for newer EAPIs we
39 # @ECLASS-VARIABLE: ELTCONF
42 # Extra options passed to elibtoolize
43 ELTCONF=${ELTCONF:-""}
45 # @ECLASS-VARIABLE: G2CONF
48 # Extra configure opts passed to econf.
49 # Deprecated, pass extra arguments to gnome2_src_configure.
50 # Banned in eapi6 and newer.
51 if has ${EAPI:-0} 4 5; then
55 # @ECLASS-VARIABLE: GCONF_DEBUG
58 # Whether to handle debug or not.
59 # Some gnome applications support various levels of debugging (yes, no, minimum,
60 # etc), but using --disable-debug also removes g_assert which makes debugging
61 # harder. This variable should be set to yes for such packages for the eclass
62 # to handle it properly. It will enable minimal debug with USE=-debug.
63 # Note that this is most commonly found in configure.ac as GNOME_DEBUG_CHECK.
65 # Banned since eapi6 as upstream is moving away from this obsolete macro in favor
66 # of autoconf-archive macros, that do not expose this issue (bug #270919)
67 if has ${EAPI:-0} 4 5; then
68 if [[ ${GCONF_DEBUG} != "no" ]]; then
73 # @ECLASS-VARIABLE: GNOME2_ECLASS_GIO_MODULES
76 # Array containing glib GIO modules
78 # @ECLASS-VARIABLE: GNOME2_LA_PUNT
80 # For eapi4 it sets if we should delete ALL or none of the .la files
81 # For eapi5 and newer it relies on prune_libtool_files (from eutils.eclass)
82 # for this. Available values for GNOME2_LA_PUNT:
83 # - "no": will not clean any .la files
84 # - "yes": will run prune_libtool_files --modules
85 # - If it is not set, it will run prune_libtool_files
86 if has ${EAPI:-0} 4; then
87 GNOME2_LA_PUNT=${GNOME2_LA_PUNT:-"no"}
89 GNOME2_LA_PUNT=${GNOME2_LA_PUNT:-""}
92 # @FUNCTION: gnome2_src_unpack
94 # Stub function for old EAPI.
96 if has ${EAPI:-0} 4 5; then
100 die "gnome2_src_unpack is banned from eapi6"
104 # @FUNCTION: gnome2_src_prepare
106 # Prepare environment for build, fix build of scrollkeeper documentation,
108 gnome2_src_prepare() {
111 # Prevent assorted access violations and test failures
112 gnome2_environment_reset
114 # Prevent scrollkeeper access violations
115 # We stop to run it from eapi6 as scrollkeeper helpers from
116 # rarian are not running anything and, then, access violations
118 has ${EAPI:-0} 4 5 && gnome2_omf_fix
120 # Disable all deprecation warnings
121 gnome2_disable_deprecation_warning
123 # Run libtoolize or eautoreconf, bug #591584
124 # https://bugzilla.gnome.org/show_bug.cgi?id=655517
125 if [[ ${GNOME2_EAUTORECONF} == 'yes' ]]; then
128 elibtoolize ${ELTCONF}
132 # @FUNCTION: gnome2_src_configure
134 # Gnome specific configure handling
135 gnome2_src_configure() {
136 # Deprecated for a long time now and banned since eapi6, see Gnome team policies
137 if [[ -n ${G2CONF} ]] ; then
138 if has ${EAPI:-0} 4 5; then
139 eqawarn "G2CONF set, please review documentation at https://wiki.gentoo.org/wiki/Project:GNOME/Gnome_Team_Ebuild_Policies#G2CONF_and_src_configure"
141 die "G2CONF set, please review documentation at https://wiki.gentoo.org/wiki/Project:GNOME/Gnome_Team_Ebuild_Policies#G2CONF_and_src_configure"
147 if has ${EAPI:-0} 4 5; then
148 if [[ ${GCONF_DEBUG} != 'no' ]] ; then
150 g2conf+=( --enable-debug=yes )
154 if [[ -n ${GCONF_DEBUG} ]] ; then
155 die "GCONF_DEBUG is banned since eapi6 in favor of each ebuild taking care of the proper handling of debug configure option"
159 # Starting with EAPI=5, we consider packages installing gtk-doc to be
160 # handled by adding DEPEND="dev-util/gtk-doc-am" which provides tools to
161 # relink URLs in documentation to already installed documentation.
162 # This decision also greatly helps with constantly broken doc generation.
163 # Remember to drop 'doc' USE flag from your package if it was only used to
165 # Preserve old behavior for older EAPI.
166 if grep -q "enable-gtk-doc" "${ECONF_SOURCE:-.}"/configure ; then
167 if has ${EAPI:-0} 4 && in_iuse doc ; then
168 g2conf+=( $(use_enable doc gtk-doc) )
170 g2conf+=( --disable-gtk-doc )
174 # Pass --disable-maintainer-mode when needed
175 if grep -q "^[[:space:]]*AM_MAINTAINER_MODE(\[enable\])" \
176 "${ECONF_SOURCE:-.}"/configure.*; then
177 g2conf+=( --disable-maintainer-mode )
180 # Pass --disable-scrollkeeper when possible
181 if grep -q "disable-scrollkeeper" "${ECONF_SOURCE:-.}"/configure; then
182 g2conf+=( --disable-scrollkeeper )
185 # Pass --disable-silent-rules when possible (not needed since eapi5), bug #429308
186 if has ${EAPI:-0} 4; then
187 if grep -q "disable-silent-rules" "${ECONF_SOURCE:-.}"/configure; then
188 g2conf+=( --disable-silent-rules )
192 # Pass --disable-schemas-install when possible
193 if grep -q "disable-schemas-install" "${ECONF_SOURCE:-.}"/configure; then
194 g2conf+=( --disable-schemas-install )
197 # Pass --disable-schemas-compile when possible
198 if grep -q "disable-schemas-compile" "${ECONF_SOURCE:-.}"/configure; then
199 g2conf+=( --disable-schemas-compile )
202 # Pass --disable-update-mimedb when possible
203 if grep -q "disable-update-mimedb" "${ECONF_SOURCE:-.}"/configure; then
204 g2conf+=( --disable-update-mimedb )
207 # Pass --enable-compile-warnings=minimum as we don't want -Werror* flags, bug #471336
208 if grep -q "enable-compile-warnings" "${ECONF_SOURCE:-.}"/configure; then
209 g2conf+=( --enable-compile-warnings=minimum )
212 # Pass --docdir with proper directory, bug #482646 (not needed since eapi6)
213 if has ${EAPI:-0} 4 5; then
214 if grep -q "^ *--docdir=" "${ECONF_SOURCE:-.}"/configure; then
215 g2conf+=( --docdir="${EPREFIX}"/usr/share/doc/${PF} )
219 # Avoid sandbox violations caused by gnome-vfs (bug #128289 and #345659)
220 if has ${EAPI:-0} 4 5; then
221 addwrite "$(unset HOME; echo ~)/.gnome2"
223 addpredict "$(unset HOME; echo ~)/.gnome2"
226 if has ${EAPI:-0} 4 5; then
227 econf ${g2conf[@]} ${G2CONF} "$@"
229 econf ${g2conf[@]} "$@"
233 # @FUNCTION: gnome2_src_compile
235 # Only default src_compile for now
236 gnome2_src_compile() {
237 if has ${EAPI:-0} 4 5; then
244 # @FUNCTION: gnome2_src_install
246 # Gnome specific install. Handles typical GConf and scrollkeeper setup
247 # in packages and removal of .la files if requested
248 gnome2_src_install() {
249 # we must delay gconf schema installation due to sandbox
250 export GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL="1"
252 local sk_tmp_dir="/var/lib/scrollkeeper"
253 # scrollkeeper-update from rarian doesn't do anything. Then, since eapi6
254 # we stop taking care of it
256 # if this is not present, scrollkeeper-update may segfault and
257 # create bogus directories in /var/lib/
258 if has ${EAPI:-0} 4 5; then
259 dodir "${sk_tmp_dir}" || die "dodir failed"
260 emake DESTDIR="${D}" "scrollkeeper_localstate_dir=${ED}${sk_tmp_dir} " "$@" install || die "install failed"
265 unset GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL
267 # Handle documentation as 'default' for eapi5, bug #373131
268 # Since eapi6 this is handled by default on its own plus MAINTAINERS and HACKING
269 # files that are really common in gnome packages (bug #573390)
270 if has ${EAPI:-0} 4; then
271 # Manual document installation
272 if [[ -n "${DOCS}" ]]; then
273 dodoc ${DOCS} || die "dodoc failed"
275 elif has ${EAPI:-0} 5; then
279 for d in HACKING MAINTAINERS; do
280 [[ -s "${d}" ]] && dodoc "${d}"
284 # Do not keep /var/lib/scrollkeeper because:
285 # 1. The scrollkeeper database is regenerated at pkg_postinst()
286 # 2. ${ED}/var/lib/scrollkeeper contains only indexes for the current pkg
287 # thus it makes no sense if pkg_postinst ISN'T run for some reason.
288 rm -rf "${ED}${sk_tmp_dir}"
289 rmdir "${ED}/var/lib" 2>/dev/null
290 rmdir "${ED}/var" 2>/dev/null
292 # Make sure this one doesn't get in the portage db
293 rm -fr "${ED}/usr/share/applications/mimeinfo.cache"
295 # Delete all .la files
296 if has ${EAPI:-0} 4; then
297 if [[ "${GNOME2_LA_PUNT}" != "no" ]]; then
298 ebegin "Removing .la files"
299 if ! use_if_iuse static-libs ; then
300 find "${D}" -name '*.la' -exec rm -f {} + || die "la file removal failed"
305 case "${GNOME2_LA_PUNT}" in
306 yes) prune_libtool_files --modules;;
308 *) prune_libtool_files;;
313 # @FUNCTION: gnome2_pkg_preinst
315 # Finds Icons, GConf and GSettings schemas for later handling in pkg_postinst
316 gnome2_pkg_preinst() {
318 gnome2_gconf_savelist
319 gnome2_schemas_savelist
320 gnome2_scrollkeeper_savelist
321 gnome2_gdk_pixbuf_savelist
325 GNOME2_ECLASS_GIO_MODULES=()
326 while IFS= read -r -d '' f; do
327 GNOME2_ECLASS_GIO_MODULES+=( ${f} )
328 done < <(cd "${D}" && find usr/$(get_libdir)/gio/modules -type f -print0 2>/dev/null)
330 export GNOME2_ECLASS_GIO_MODULES
333 # @FUNCTION: gnome2_pkg_postinst
335 # Handle scrollkeeper, GConf, GSettings, Icons, desktop and mime
337 gnome2_pkg_postinst() {
340 if [[ -n ${GNOME2_ECLASS_GLIB_SCHEMAS} ]]; then
341 gnome2_schemas_update
343 gnome2_scrollkeeper_update
344 gnome2_gdk_pixbuf_update
346 if [[ ${#GNOME2_ECLASS_GIO_MODULES[@]} -gt 0 ]]; then
347 gnome2_giomodule_cache_update
351 # # FIXME Handle GConf schemas removal
352 #gnome2_pkg_prerm() {
353 # gnome2_gconf_uninstall
356 # @FUNCTION: gnome2_pkg_postrm
358 # Handle scrollkeeper, GSettings, Icons, desktop and mime database updates.
359 gnome2_pkg_postrm() {
361 if [[ -n ${GNOME2_ECLASS_GLIB_SCHEMAS} ]]; then
362 gnome2_schemas_update
364 gnome2_scrollkeeper_update
366 if [[ ${#GNOME2_ECLASS_GIO_MODULES[@]} -gt 0 ]]; then
367 gnome2_giomodule_cache_update