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

Diff of /eclass/eutils.eclass

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

Revision 1.387 Revision 1.407
1# Copyright 1999-2012 Gentoo Foundation 1# Copyright 1999-2012 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/eutils.eclass,v 1.387 2012/03/23 02:33:49 vapier Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.407 2012/10/11 16:50:53 mgorny Exp $
4 4
5# @ECLASS: eutils.eclass 5# @ECLASS: eutils.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# base-system@gentoo.org 7# base-system@gentoo.org
8# @BLURB: many extra (but common) functions that are used in ebuilds 8# @BLURB: many extra (but common) functions that are used in ebuilds
16# different from the overall eclass! 16# different from the overall eclass!
17 17
18if [[ ${___ECLASS_ONCE_EUTILS} != "recur -_+^+_- spank" ]] ; then 18if [[ ${___ECLASS_ONCE_EUTILS} != "recur -_+^+_- spank" ]] ; then
19___ECLASS_ONCE_EUTILS="recur -_+^+_- spank" 19___ECLASS_ONCE_EUTILS="recur -_+^+_- spank"
20 20
21inherit multilib user 21inherit multilib toolchain-funcs user
22
23DESCRIPTION="Based on the ${ECLASS} eclass"
24 22
25if has "${EAPI:-0}" 0 1 2; then 23if has "${EAPI:-0}" 0 1 2; then
26 24
27# @FUNCTION: epause 25# @FUNCTION: epause
28# @USAGE: [seconds] 26# @USAGE: [seconds]
228# @DESCRIPTION: 226# @DESCRIPTION:
229# Default extension for patches (do not prefix the period yourself). 227# Default extension for patches (do not prefix the period yourself).
230EPATCH_SUFFIX="patch.bz2" 228EPATCH_SUFFIX="patch.bz2"
231# @VARIABLE: EPATCH_OPTS 229# @VARIABLE: EPATCH_OPTS
232# @DESCRIPTION: 230# @DESCRIPTION:
233# Default options for patch: 231# Options to pass to patch. Meant for ebuild/package-specific tweaking
232# such as forcing the patch level (-p#) or fuzz (-F#) factor. Note that
233# for single patch tweaking, you can also pass flags directly to epatch.
234EPATCH_OPTS=""
235# @VARIABLE: EPATCH_COMMON_OPTS
236# @DESCRIPTION:
237# Common options to pass to `patch`. You probably should never need to
238# change these. If you do, please discuss it with base-system first to
239# be sure.
234# @CODE 240# @CODE
235# -g0 - keep RCS, ClearCase, Perforce and SCCS happy #24571 241# -g0 - keep RCS, ClearCase, Perforce and SCCS happy #24571
236# --no-backup-if-mismatch - do not leave .orig files behind 242# --no-backup-if-mismatch - do not leave .orig files behind
237# -E - automatically remove empty files 243# -E - automatically remove empty files
238# @CODE 244# @CODE
239EPATCH_OPTS="-g0 -E --no-backup-if-mismatch" 245EPATCH_COMMON_OPTS="-g0 -E --no-backup-if-mismatch"
240# @VARIABLE: EPATCH_EXCLUDE 246# @VARIABLE: EPATCH_EXCLUDE
241# @DESCRIPTION: 247# @DESCRIPTION:
242# List of patches not to apply. Note this is only file names, 248# List of patches not to apply. Note this is only file names,
243# and not the full path. Globs accepted. 249# and not the full path. Globs accepted.
244EPATCH_EXCLUDE="" 250EPATCH_EXCLUDE=""
255# Only require patches to match EPATCH_SUFFIX rather than the extended 261# Only require patches to match EPATCH_SUFFIX rather than the extended
256# arch naming style. 262# arch naming style.
257EPATCH_FORCE="no" 263EPATCH_FORCE="no"
258 264
259# @FUNCTION: epatch 265# @FUNCTION: epatch
260# @USAGE: [patches] [dirs of patches] 266# @USAGE: [options] [patches] [dirs of patches]
261# @DESCRIPTION: 267# @DESCRIPTION:
262# epatch is designed to greatly simplify the application of patches. It can 268# epatch is designed to greatly simplify the application of patches. It can
263# process patch files directly, or directories of patches. The patches may be 269# process patch files directly, or directories of patches. The patches may be
264# compressed (bzip/gzip/etc...) or plain text. You generally need not specify 270# compressed (bzip/gzip/etc...) or plain text. You generally need not specify
265# the -p option as epatch will automatically attempt -p0 to -p5 until things 271# the -p option as epatch will automatically attempt -p0 to -p5 until things
266# apply successfully. 272# apply successfully.
267# 273#
268# If you do not specify any options, then epatch will default to the directory 274# If you do not specify any patches/dirs, then epatch will default to the
269# specified by EPATCH_SOURCE. 275# directory specified by EPATCH_SOURCE.
276#
277# Any options specified that start with a dash will be passed down to patch
278# for this specific invocation. As soon as an arg w/out a dash is found, then
279# arg processing stops.
270# 280#
271# When processing directories, epatch will apply all patches that match: 281# When processing directories, epatch will apply all patches that match:
272# @CODE 282# @CODE
273# if ${EPATCH_FORCE} != "yes" 283# if ${EPATCH_FORCE} != "yes"
274# ??_${ARCH}_foo.${EPATCH_SUFFIX} 284# ??_${ARCH}_foo.${EPATCH_SUFFIX}
292 echo "${1//?/=}" 302 echo "${1//?/=}"
293 } 303 }
294 304
295 unset P4CONFIG P4PORT P4USER # keep perforce at bay #56402 305 unset P4CONFIG P4PORT P4USER # keep perforce at bay #56402
296 306
307 # First process options. We localize the EPATCH_OPTS setting
308 # from above so that we can pass it on in the loop below with
309 # any additional values the user has specified.
310 local EPATCH_OPTS=( ${EPATCH_OPTS[*]} )
311 while [[ $# -gt 0 ]] ; do
312 case $1 in
313 -*) EPATCH_OPTS+=( "$1" ) ;;
314 *) break ;;
315 esac
316 shift
317 done
318
297 # Let the rest of the code process one user arg at a time -- 319 # Let the rest of the code process one user arg at a time --
298 # each arg may expand into multiple patches, and each arg may 320 # each arg may expand into multiple patches, and each arg may
299 # need to start off with the default global EPATCH_xxx values 321 # need to start off with the default global EPATCH_xxx values
300 if [[ $# -gt 1 ]] ; then 322 if [[ $# -gt 1 ]] ; then
301 local m 323 local m
334 eerror " ${EPATCH_SOURCE}" 356 eerror " ${EPATCH_SOURCE}"
335 eerror " ( ${EPATCH_SOURCE##*/} )" 357 eerror " ( ${EPATCH_SOURCE##*/} )"
336 echo 358 echo
337 die "Cannot find \$EPATCH_SOURCE!" 359 die "Cannot find \$EPATCH_SOURCE!"
338 fi 360 fi
361
362 # Now that we know we're actually going to apply something, merge
363 # all of the patch options back in to a single variable for below.
364 EPATCH_OPTS="${EPATCH_COMMON_OPTS} ${EPATCH_OPTS[*]}"
339 365
340 local PIPE_CMD 366 local PIPE_CMD
341 case ${EPATCH_SUFFIX##*\.} in 367 case ${EPATCH_SUFFIX##*\.} in
342 xz) PIPE_CMD="xz -dc" ;; 368 xz) PIPE_CMD="xz -dc" ;;
343 lzma) PIPE_CMD="lzma -dc" ;; 369 lzma) PIPE_CMD="lzma -dc" ;;
523 549
524# @FUNCTION: epatch_user 550# @FUNCTION: epatch_user
525# @USAGE: 551# @USAGE:
526# @DESCRIPTION: 552# @DESCRIPTION:
527# Applies user-provided patches to the source tree. The patches are 553# Applies user-provided patches to the source tree. The patches are
528# taken from /etc/portage/patches/<CATEGORY>/<PF|P|PN>/, where the first 554# taken from /etc/portage/patches/<CATEGORY>/<PF|P|PN>[:SLOT]/, where the first
529# of these three directories to exist will be the one to use, ignoring 555# of these three directories to exist will be the one to use, ignoring
530# any more general directories which might exist as well. They must end 556# any more general directories which might exist as well. They must end
531# in ".patch" to be applied. 557# in ".patch" to be applied.
532# 558#
533# User patches are intended for quick testing of patches without ebuild 559# User patches are intended for quick testing of patches without ebuild
555 local applied="${T}/epatch_user.log" 581 local applied="${T}/epatch_user.log"
556 [[ -e ${applied} ]] && return 2 582 [[ -e ${applied} ]] && return 2
557 583
558 # don't clobber any EPATCH vars that the parent might want 584 # don't clobber any EPATCH vars that the parent might want
559 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches 585 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches
560 for check in ${CATEGORY}/{${P}-${PR},${P},${PN}}; do 586 for check in ${CATEGORY}/{${P}-${PR},${P},${PN}}{,:${SLOT}}; do
561 EPATCH_SOURCE=${base}/${CTARGET}/${check} 587 EPATCH_SOURCE=${base}/${CTARGET}/${check}
562 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${CHOST}/${check} 588 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${CHOST}/${check}
563 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${check} 589 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${check}
564 if [[ -d ${EPATCH_SOURCE} ]] ; then 590 if [[ -d ${EPATCH_SOURCE} ]] ; then
565 EPATCH_SOURCE=${EPATCH_SOURCE} \ 591 EPATCH_SOURCE=${EPATCH_SOURCE} \
628# Make a .desktop file. 654# Make a .desktop file.
629# 655#
630# @CODE 656# @CODE
631# binary: what command does the app run with ? 657# binary: what command does the app run with ?
632# name: the name that will show up in the menu 658# name: the name that will show up in the menu
633# icon: give your little like a pretty little icon ... 659# icon: the icon to use in the menu entry
634# this can be relative (to /usr/share/pixmaps) or 660# this can be relative (to /usr/share/pixmaps) or
635# a full path to an icon 661# a full path to an icon
636# type: what kind of application is this? 662# type: what kind of application is this?
637# for categories: 663# for categories:
638# http://standards.freedesktop.org/menu-spec/latest/apa.html 664# http://standards.freedesktop.org/menu-spec/latest/apa.html
914 insinto /usr/share/applications 940 insinto /usr/share/applications
915 newins "$@" 941 newins "$@"
916 ) 942 )
917} 943}
918 944
919# @FUNCTION: doicon 945# @FUNCTION: _iconins
920# @USAGE: <list of icons> 946# @INTERNAL
921# @DESCRIPTION: 947# @DESCRIPTION:
922# Install the list of icons into the icon directory (/usr/share/pixmaps). 948# function for use in doicon and newicon
923# This is useful in conjunction with creating desktop/menu files. 949_iconins() {
924doicon() {
925 ( 950 (
926 # wrap the env here so that the 'insinto' call 951 # wrap the env here so that the 'insinto' call
927 # doesn't corrupt the env of the caller 952 # doesn't corrupt the env of the caller
928 local i j ret 953 local funcname=$1; shift
954 local size dir
955 local context=apps
956 local theme=hicolor
957
958 while [[ $# -gt 0 ]] ; do
959 case $1 in
960 -s|--size)
961 if [[ ${2%%x*}x${2%%x*} == "$2" ]] ; then
962 size=${2%%x*}
963 else
964 size=${2}
965 fi
966 case ${size} in
967 16|22|24|32|36|48|64|72|96|128|192|256)
968 size=${size}x${size};;
969 scalable)
970 ;;
971 *)
972 eerror "${size} is an unsupported icon size!"
973 exit 1;;
974 esac
975 shift 2;;
976 -t|--theme)
977 theme=${2}
978 shift 2;;
979 -c|--context)
980 context=${2}
981 shift 2;;
982 *)
983 if [[ -z ${size} ]] ; then
929 insinto /usr/share/pixmaps 984 insinto /usr/share/pixmaps
930 for i in "$@" ; do
931 if [[ -f ${i} ]] ; then
932 doins "${i}"
933 ((ret+=$?))
934 elif [[ -d ${i} ]] ; then
935 for j in "${i}"/*.png ; do
936 doins "${j}"
937 ((ret+=$?))
938 done
939 else 985 else
940 ((++ret)) 986 insinto /usr/share/icons/${theme}/${size}/${context}
941 fi 987 fi
988
989 if [[ ${funcname} == doicon ]] ; then
990 if [[ -f $1 ]] ; then
991 doins "${1}"
992 elif [[ -d $1 ]] ; then
993 shopt -s nullglob
994 doins "${1}"/*.{png,svg}
995 shopt -u nullglob
996 else
997 eerror "${1} is not a valid file/directory!"
998 exit 1
999 fi
1000 else
1001 break
1002 fi
1003 shift 1;;
1004 esac
942 done 1005 done
943 exit ${ret} 1006 if [[ ${funcname} == newicon ]] ; then
944 ) 1007 newins "$@"
1008 fi
1009 ) || die
1010}
1011
1012# @FUNCTION: doicon
1013# @USAGE: [options] <icons>
1014# @DESCRIPTION:
1015# Install icon into the icon directory /usr/share/icons or into
1016# /usr/share/pixmaps if "--size" is not set.
1017# This is useful in conjunction with creating desktop/menu files.
1018#
1019# @CODE
1020# options:
1021# -s, --size
1022# !!! must specify to install into /usr/share/icons/... !!!
1023# size of the icon, like 48 or 48x48
1024# supported icon sizes are:
1025# 16 22 24 32 36 48 64 72 96 128 192 256 scalable
1026# -c, --context
1027# defaults to "apps"
1028# -t, --theme
1029# defaults to "hicolor"
1030#
1031# icons: list of icons
1032#
1033# example 1: doicon foobar.png fuqbar.svg suckbar.png
1034# results in: insinto /usr/share/pixmaps
1035# doins foobar.png fuqbar.svg suckbar.png
1036#
1037# example 2: doicon -s 48 foobar.png fuqbar.png blobbar.png
1038# results in: insinto /usr/share/icons/hicolor/48x48/apps
1039# doins foobar.png fuqbar.png blobbar.png
1040# @CODE
1041doicon() {
1042 _iconins ${FUNCNAME} "$@"
945} 1043}
946 1044
947# @FUNCTION: newicon 1045# @FUNCTION: newicon
948# @USAGE: <icon> <newname> 1046# @USAGE: [options] <icon> <newname>
949# @DESCRIPTION: 1047# @DESCRIPTION:
950# Like all other new* functions, install the specified icon as newname. 1048# Like doicon, install the specified icon as newname.
1049#
1050# @CODE
1051# example 1: newicon foobar.png NEWNAME.png
1052# results in: insinto /usr/share/pixmaps
1053# newins foobar.png NEWNAME.png
1054#
1055# example 2: newicon -s 48 foobar.png NEWNAME.png
1056# results in: insinto /usr/share/icons/hicolor/48x48/apps
1057# newins foobar.png NEWNAME.png
1058# @CODE
951newicon() { 1059newicon() {
952 ( 1060 _iconins ${FUNCNAME} "$@"
953 # wrap the env here so that the 'insinto' call
954 # doesn't corrupt the env of the caller
955 insinto /usr/share/pixmaps
956 newins "$@"
957 )
958} 1061}
959 1062
960# @FUNCTION: strip-linguas 1063# @FUNCTION: strip-linguas
961# @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>] 1064# @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
962# @DESCRIPTION: 1065# @DESCRIPTION:
1000 else 1103 else
1001 nols="${nols} ${f}" 1104 nols="${nols} ${f}"
1002 fi 1105 fi
1003 done 1106 done
1004 [[ -n ${nols} ]] \ 1107 [[ -n ${nols} ]] \
1005 && ewarn "Sorry, but ${PN} does not support the LINGUAS:" ${nols} 1108 && einfo "Sorry, but ${PN} does not support the LINGUAS:" ${nols}
1006 export LINGUAS=${newls:1} 1109 export LINGUAS=${newls:1}
1007} 1110}
1008 1111
1009# @FUNCTION: preserve_old_lib 1112# @FUNCTION: preserve_old_lib
1010# @USAGE: <libs to preserve> [more libs] 1113# @USAGE: <libs to preserve> [more libs]
1058 ewarn "the libraries are not being removed. You need to run revdep-rebuild" 1161 ewarn "the libraries are not being removed. You need to run revdep-rebuild"
1059 ewarn "in order to remove these old dependencies. If you do not have this" 1162 ewarn "in order to remove these old dependencies. If you do not have this"
1060 ewarn "helper program, simply emerge the 'gentoolkit' package." 1163 ewarn "helper program, simply emerge the 'gentoolkit' package."
1061 ewarn 1164 ewarn
1062 fi 1165 fi
1063 # temp hack for #348634 #357225
1064 [[ ${PN} == "mpfr" ]] && lib=${lib##*/}
1065 ewarn " # revdep-rebuild --library '${lib}'" 1166 ewarn " # revdep-rebuild --library '${lib}' && rm '${lib}'"
1066 done 1167 done
1067 if [[ ${notice} -eq 1 ]] ; then
1068 ewarn
1069 ewarn "Once you've finished running revdep-rebuild, it should be safe to"
1070 ewarn "delete the old libraries. Here is a copy & paste for the lazy:"
1071 for lib in "$@" ; do
1072 ewarn " # rm '${lib}'"
1073 done
1074 fi
1075} 1168}
1076 1169
1077# @FUNCTION: built_with_use 1170# @FUNCTION: built_with_use
1078# @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags> 1171# @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1079# @DESCRIPTION: 1172# @DESCRIPTION:
1276} 1369}
1277 1370
1278# @FUNCTION: usex 1371# @FUNCTION: usex
1279# @USAGE: <USE flag> [true output] [false output] [true suffix] [false suffix] 1372# @USAGE: <USE flag> [true output] [false output] [true suffix] [false suffix]
1280# @DESCRIPTION: 1373# @DESCRIPTION:
1374# Proxy to declare usex for package managers or EAPIs that do not provide it
1375# and use the package manager implementation when available (i.e. EAPI >= 5).
1281# If USE flag is set, echo [true output][true suffix] (defaults to "yes"), 1376# If USE flag is set, echo [true output][true suffix] (defaults to "yes"),
1282# otherwise echo [false output][false suffix] (defaults to "no"). 1377# otherwise echo [false output][false suffix] (defaults to "no").
1378if has "${EAPI:-0}" 0 1 2 3 4; then
1283usex() { use "$1" && echo "${2-yes}$4" || echo "${3-no}$5" ; } #382963 1379 usex() { use "$1" && echo "${2-yes}$4" || echo "${3-no}$5" ; } #382963
1380fi
1381
1382# @FUNCTION: prune_libtool_files
1383# @USAGE: [--all]
1384# @DESCRIPTION:
1385# Locate unnecessary libtool files (.la) and libtool static archives
1386# (.a) and remove them from installation image.
1387#
1388# By default, .la files are removed whenever the static linkage can
1389# either be performed using pkg-config or doesn't introduce additional
1390# flags.
1391#
1392# If '--all' argument is passed, all .la files are removed. This is
1393# usually useful when the package installs plugins and does not use .la
1394# files for loading them.
1395#
1396# The .a files are only removed whenever corresponding .la files state
1397# that they should not be linked to, i.e. whenever these files
1398# correspond to plugins.
1399#
1400# Note: if your package installs both static libraries and .pc files,
1401# you need to add pkg-config to your DEPEND.
1402prune_libtool_files() {
1403 debug-print-function ${FUNCNAME} "$@"
1404
1405 local removing_all opt
1406 for opt; do
1407 case "${opt}" in
1408 --all)
1409 removing_all=1
1410 ;;
1411 *)
1412 die "Invalid argument to ${FUNCNAME}(): ${opt}"
1413 esac
1414 done
1415
1416 local f
1417 local queue=()
1418 while IFS= read -r -d '' f; do # for all .la files
1419 local archivefile=${f/%.la/.a}
1420
1421 [[ ${f} != ${archivefile} ]] || die 'regex sanity check failed'
1422
1423 # Remove static libs we're not supposed to link against.
1424 if grep -q '^shouldnotlink=yes$' "${f}"; then
1425 if [[ -f ${archivefile} ]]; then
1426 einfo "Removing unnecessary ${archivefile#${D%/}} (static plugin)"
1427 queue+=( "${archivefile}" )
1428 fi
1429
1430 # The .la file may be used by a module loader, so avoid removing it
1431 # unless explicitly requested.
1432 [[ ${removing_all} ]] || continue
1433 fi
1434
1435 # Remove .la files when:
1436 # - user explicitly wants us to remove all .la files,
1437 # - respective static archive doesn't exist,
1438 # - they are covered by a .pc file already,
1439 # - they don't provide any new information (no libs & no flags).
1440 local reason pkgconfig_scanned
1441 if [[ ${removing_all} ]]; then
1442 reason='requested'
1443 elif [[ ! -f ${archivefile} ]]; then
1444 reason='no static archive'
1445 elif [[ ! $(sed -nre \
1446 "s/^(dependency_libs|inherited_linker_flags)='(.*)'$/\2/p" \
1447 "${f}") ]]; then
1448 reason='no libs & flags'
1449 else
1450 if [[ ! ${pkgconfig_scanned} ]]; then
1451 # Create a list of all .pc-covered libs.
1452 local pc_libs=()
1453 if [[ ! ${removing_all} ]]; then
1454 local f
1455 local tf=${T}/prune-lt-files.pc
1456 local pkgconf=$(tc-getPKG_CONFIG)
1457
1458 while IFS= read -r -d '' f; do # for all .pc files
1459 local arg
1460
1461 sed -e '/^Requires:/d' "${f}" > "${tf}"
1462 for arg in $("${pkgconf}" --libs "${tf}"); do
1463 [[ ${arg} == -l* ]] && pc_libs+=( lib${arg#-l}.la )
1464 done
1465 done < <(find "${D}" -type f -name '*.pc' -print0)
1466
1467 rm -f "${tf}"
1468 fi
1469
1470 pkgconfig_scanned=1
1471 fi
1472
1473 has "${f##*/}" "${pc_libs[@]}" && reason='covered by .pc'
1474 fi
1475
1476 if [[ ${reason} ]]; then
1477 einfo "Removing unnecessary ${f#${D%/}} (${reason})"
1478 queue+=( "${f}" )
1479 fi
1480 done < <(find "${D}" -xtype f -name '*.la' -print0)
1481
1482 if [[ ${queue[@]} ]]; then
1483 rm -f "${queue[@]}"
1484 fi
1485}
1284 1486
1285check_license() { die "you no longer need this as portage supports ACCEPT_LICENSE itself"; } 1487check_license() { die "you no longer need this as portage supports ACCEPT_LICENSE itself"; }
1286 1488
1287fi 1489fi

Legend:
Removed from v.1.387  
changed lines
  Added in v.1.407

  ViewVC Help
Powered by ViewVC 1.1.20