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

Diff of /eclass/eutils.eclass

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

Revision 1.349 Revision 1.367
1# Copyright 1999-2009 Gentoo Foundation 1# Copyright 1999-2011 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.349 2010/08/19 21:32:26 vapier Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.367 2011/10/26 23:27:16 vapier 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
64fi 64fi
65 65
66# @FUNCTION: eqawarn 66# @FUNCTION: eqawarn
67# @USAGE: [message] 67# @USAGE: [message]
68# @DESCRIPTION: 68# @DESCRIPTION:
69# Proxy to einfo for package managers that don't provide eqawarn and use the PM 69# Proxy to ewarn for package managers that don't provide eqawarn and use the PM
70# implementation if available. 70# implementation if available. Reuses PORTAGE_ELOG_CLASSES as set by the dev
71# profile.
71if ! declare -F eqawarn >/dev/null ; then 72if ! declare -F eqawarn >/dev/null ; then
72 eqawarn() { 73 eqawarn() {
73 einfo "$@" 74 has qa ${PORTAGE_ELOG_CLASSES} && ewarn "$@"
74 } 75 }
75fi 76fi
76 77
77# @FUNCTION: ecvs_clean 78# @FUNCTION: ecvs_clean
78# @USAGE: [list of dirs] 79# @USAGE: [list of dirs]
200# If you do not specify any options, then epatch will default to the directory 201# If you do not specify any options, then epatch will default to the directory
201# specified by EPATCH_SOURCE. 202# specified by EPATCH_SOURCE.
202# 203#
203# When processing directories, epatch will apply all patches that match: 204# When processing directories, epatch will apply all patches that match:
204# @CODE 205# @CODE
205# ${EPATCH_FORCE} == "yes" 206# if ${EPATCH_FORCE} != "yes"
206# ??_${ARCH}_foo.${EPATCH_SUFFIX} 207# ??_${ARCH}_foo.${EPATCH_SUFFIX}
207# else 208# else
208# *.${EPATCH_SUFFIX} 209# *.${EPATCH_SUFFIX}
209# @CODE 210# @CODE
210# The leading ?? are typically numbers used to force consistent patch ordering. 211# The leading ?? are typically numbers used to force consistent patch ordering.
249 local EPATCH_SUFFIX=$1 250 local EPATCH_SUFFIX=$1
250 251
251 elif [[ -d $1 ]] ; then 252 elif [[ -d $1 ]] ; then
252 # Some people like to make dirs of patches w/out suffixes (vim) 253 # Some people like to make dirs of patches w/out suffixes (vim)
253 set -- "$1"/*${EPATCH_SUFFIX:+."${EPATCH_SUFFIX}"} 254 set -- "$1"/*${EPATCH_SUFFIX:+."${EPATCH_SUFFIX}"}
255
256 elif [[ -f ${EPATCH_SOURCE}/$1 ]] ; then
257 # Re-use EPATCH_SOURCE as a search dir
258 epatch "${EPATCH_SOURCE}/$1"
259 return $?
254 260
255 else 261 else
256 # sanity check ... if it isn't a dir or file, wtf man ? 262 # sanity check ... if it isn't a dir or file, wtf man ?
257 [[ $# -ne 0 ]] && EPATCH_SOURCE=$1 263 [[ $# -ne 0 ]] && EPATCH_SOURCE=$1
258 echo 264 echo
289 # ???_arch_foo.patch 295 # ???_arch_foo.patch
290 # Else, skip this input altogether 296 # Else, skip this input altogether
291 local a=${patchname#*_} # strip the ???_ 297 local a=${patchname#*_} # strip the ???_
292 a=${a%%_*} # strip the _foo.patch 298 a=${a%%_*} # strip the _foo.patch
293 if ! [[ ${SINGLE_PATCH} == "yes" || \ 299 if ! [[ ${SINGLE_PATCH} == "yes" || \
294 ${EPATCH_FORCE} == "yes" || \ 300 ${EPATCH_FORCE} == "yes" || \
295 ${a} == all || \ 301 ${a} == all || \
296 ${a} == ${ARCH} ]] 302 ${a} == ${ARCH} ]]
297 then 303 then
298 continue 304 continue
299 fi 305 fi
300 306
301 # Let people filter things dynamically 307 # Let people filter things dynamically
358 local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }') 364 local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }')
359 if [[ -n ${abs_paths} ]] ; then 365 if [[ -n ${abs_paths} ]] ; then
360 count=1 366 count=1
361 printf "NOTE: skipping -p0 due to absolute paths in patch:\n%s\n" "${abs_paths}" >> "${STDERR_TARGET}" 367 printf "NOTE: skipping -p0 due to absolute paths in patch:\n%s\n" "${abs_paths}" >> "${STDERR_TARGET}"
362 fi 368 fi
369 # Similar reason, but with relative paths.
370 local rel_paths=$(egrep -n '^[-+]{3} [^ ]*[.][.]/' "${PATCH_TARGET}")
371 if [[ -n ${rel_paths} ]] ; then
372 eqawarn "QA Notice: Your patch uses relative paths '../'."
373 eqawarn " In the future this will cause a failure."
374 eqawarn "${rel_paths}"
375 fi
363 376
364 # Dynamically detect the correct -p# ... i'm lazy, so shoot me :/ 377 # Dynamically detect the correct -p# ... i'm lazy, so shoot me :/
365 while [[ ${count} -lt 5 ]] ; do 378 while [[ ${count} -lt 5 ]] ; do
366 # Generate some useful debug info ... 379 # Generate some useful debug info ...
367 ( 380 (
368 _epatch_draw_line "***** ${patchname} *****" 381 _epatch_draw_line "***** ${patchname} *****"
369 echo 382 echo
370 echo "PATCH COMMAND: patch -p${count} ${EPATCH_OPTS} < '${PATCH_TARGET}'" 383 echo "PATCH COMMAND: patch -p${count} ${EPATCH_OPTS} < '${PATCH_TARGET}'"
371 echo 384 echo
372 _epatch_draw_line "***** ${patchname} *****" 385 _epatch_draw_line "***** ${patchname} *****"
386 patch -p${count} ${EPATCH_OPTS} --dry-run -f < "${PATCH_TARGET}" 2>&1
387 ret=$?
388 echo
389 echo "patch program exited with status ${ret}"
390 exit ${ret}
373 ) >> "${STDERR_TARGET}" 391 ) >> "${STDERR_TARGET}"
374 392
375 if (patch -p${count} ${EPATCH_OPTS} --dry-run -f < "${PATCH_TARGET}") >> "${STDERR_TARGET}" 2>&1 ; then 393 if [ $? -eq 0 ] ; then
376 ( 394 (
377 _epatch_draw_line "***** ${patchname} *****" 395 _epatch_draw_line "***** ${patchname} *****"
378 echo 396 echo
379 echo "ACTUALLY APPLYING ${patchname} ..." 397 echo "ACTUALLY APPLYING ${patchname} ..."
380 echo 398 echo
381 _epatch_draw_line "***** ${patchname} *****" 399 _epatch_draw_line "***** ${patchname} *****"
382 patch -p${count} ${EPATCH_OPTS} < "${PATCH_TARGET}" 2>&1 400 patch -p${count} ${EPATCH_OPTS} < "${PATCH_TARGET}" 2>&1
401 ret=$?
402 echo
403 echo "patch program exited with status ${ret}"
404 exit ${ret}
383 ) >> "${STDERR_TARGET}" 405 ) >> "${STDERR_TARGET}"
384 406
385 if [ $? -ne 0 ] ; then 407 if [ $? -ne 0 ] ; then
386 echo 408 echo
387 eerror "A dry-run of patch command succeeded, but actually" 409 eerror "A dry-run of patch command succeeded, but actually"
418 done 440 done
419 441
420 [[ ${SINGLE_PATCH} == "no" ]] && einfo "Done with patching" 442 [[ ${SINGLE_PATCH} == "no" ]] && einfo "Done with patching"
421 : # everything worked 443 : # everything worked
422} 444}
445
446# @FUNCTION: epatch_user
447# @USAGE:
448# @DESCRIPTION:
449# Applies user-provided patches to the source tree. The patches are
450# taken from /etc/portage/patches/<CATEGORY>/<PF|P|PN>/, where the first
451# of these three directories to exist will be the one to use, ignoring
452# any more general directories which might exist as well.
453#
454# User patches are intended for quick testing of patches without ebuild
455# modifications, as well as for permanent customizations a user might
456# desire. Obviously, there can be no official support for arbitrarily
457# patched ebuilds. So whenever a build log in a bug report mentions that
458# user patches were applied, the user should be asked to reproduce the
459# problem without these.
460#
461# Not all ebuilds do call this function, so placing patches in the
462# stated directory might or might not work, depending on the package and
463# the eclasses it inherits and uses. It is safe to call the function
464# repeatedly, so it is always possible to add a call at the ebuild
465# level. The first call is the time when the patches will be
466# applied.
467#
468# Ideally, this function should be called after gentoo-specific patches
469# have been applied, so that their code can be modified as well, but
470# before calls to e.g. eautoreconf, as the user patches might affect
471# autotool input files as well.
423epatch_user() { 472epatch_user() {
424 [[ $# -ne 0 ]] && die "epatch_user takes no options" 473 [[ $# -ne 0 ]] && die "epatch_user takes no options"
474
475 # Allow multiple calls to this function; ignore all but the first
476 local applied="${T}/epatch_user.applied"
477 [[ -e ${applied} ]] && return 2
425 478
426 # don't clobber any EPATCH vars that the parent might want 479 # don't clobber any EPATCH vars that the parent might want
427 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches 480 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches
428 for check in {${CATEGORY}/${PF},${CATEGORY}/${P},${CATEGORY}/${PN}}; do 481 for check in {${CATEGORY}/${PF},${CATEGORY}/${P},${CATEGORY}/${PN}}; do
429 EPATCH_SOURCE=${base}/${CTARGET}/${check} 482 EPATCH_SOURCE=${base}/${CTARGET}/${check}
433 EPATCH_SOURCE=${EPATCH_SOURCE} \ 486 EPATCH_SOURCE=${EPATCH_SOURCE} \
434 EPATCH_SUFFIX="patch" \ 487 EPATCH_SUFFIX="patch" \
435 EPATCH_FORCE="yes" \ 488 EPATCH_FORCE="yes" \
436 EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \ 489 EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \
437 epatch 490 epatch
491 echo "${EPATCH_SOURCE}" > "${applied}"
438 return 0 492 return 0
439 fi 493 fi
440 done 494 done
495 echo "none" > "${applied}"
441 return 1 496 return 1
442} 497}
443 498
444# @FUNCTION: emktemp 499# @FUNCTION: emktemp
445# @USAGE: [temp dir] 500# @USAGE: [temp dir]
490egetent() { 545egetent() {
491 case ${CHOST} in 546 case ${CHOST} in
492 *-darwin[678]) 547 *-darwin[678])
493 case "$2" in 548 case "$2" in
494 *[!0-9]*) # Non numeric 549 *[!0-9]*) # Non numeric
495 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }" 550 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2\$/) {print \$0;exit;} }"
496 ;; 551 ;;
497 *) # Numeric 552 *) # Numeric
498 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }" 553 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }"
499 ;; 554 ;;
500 esac 555 esac
862# A handy replacement for dos2unix, recode, fixdos, etc... This allows you 917# A handy replacement for dos2unix, recode, fixdos, etc... This allows you
863# to remove all of these text utilities from DEPEND variables because this 918# to remove all of these text utilities from DEPEND variables because this
864# is a script based solution. Just give it a list of files to convert and 919# is a script based solution. Just give it a list of files to convert and
865# they will all be changed from the DOS CRLF format to the UNIX LF format. 920# they will all be changed from the DOS CRLF format to the UNIX LF format.
866edos2unix() { 921edos2unix() {
867 echo "$@" | xargs sed -i 's/\r$//' 922 [[ $# -eq 0 ]] && return 0
923 sed -i 's/\r$//' -- "$@" || die
868} 924}
869 925
870# Make a desktop file ! 926# Make a desktop file !
871# Great for making those icons in kde/gnome startmenu ! 927# Great for making those icons in kde/gnome startmenu !
872# Amaze your friends ! Get the women ! Join today ! 928# Amaze your friends ! Get the women ! Join today !
1384 dd) exe="dd ibs=${skip} skip=1 if='${src}'";; 1440 dd) exe="dd ibs=${skip} skip=1 if='${src}'";;
1385 *) die "makeself cant handle exe '${exe}'" 1441 *) die "makeself cant handle exe '${exe}'"
1386 esac 1442 esac
1387 1443
1388 # lets grab the first few bytes of the file to figure out what kind of archive it is 1444 # lets grab the first few bytes of the file to figure out what kind of archive it is
1389 local tmpfile=$(emktemp) 1445 local filetype tmpfile=$(emktemp)
1390 eval ${exe} 2>/dev/null | head -c 512 > "${tmpfile}" 1446 eval ${exe} 2>/dev/null | head -c 512 > "${tmpfile}"
1391 local filetype=$(file -b "${tmpfile}") 1447 filetype=$(file -b "${tmpfile}") || die
1392 case ${filetype} in 1448 case ${filetype} in
1393 *tar\ archive*) 1449 *tar\ archive*)
1394 eval ${exe} | tar --no-same-owner -xf - 1450 eval ${exe} | tar --no-same-owner -xf -
1395 ;; 1451 ;;
1396 bzip2*) 1452 bzip2*)
1706 else 1762 else
1707 newls="" 1763 newls=""
1708 fi 1764 fi
1709 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do 1765 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1710 if [[ ${op} == "-i" ]] ; then 1766 if [[ ${op} == "-i" ]] ; then
1711 hasq ${f} ${ls} && newls="${newls} ${f}" 1767 has ${f} ${ls} && newls="${newls} ${f}"
1712 else 1768 else
1713 hasq ${f} ${ls} || newls="${newls} ${f}" 1769 has ${f} ${ls} || newls="${newls} ${f}"
1714 fi 1770 fi
1715 done 1771 done
1716 ls=${newls} 1772 ls=${newls}
1717 done 1773 done
1718 else 1774 else
1720 fi 1776 fi
1721 1777
1722 nols="" 1778 nols=""
1723 newls="" 1779 newls=""
1724 for f in ${LINGUAS} ; do 1780 for f in ${LINGUAS} ; do
1725 if hasq ${f} ${ls} ; then 1781 if has ${f} ${ls} ; then
1726 newls="${newls} ${f}" 1782 newls="${newls} ${f}"
1727 else 1783 else
1728 nols="${nols} ${f}" 1784 nols="${nols} ${f}"
1729 fi 1785 fi
1730 done 1786 done
1785 ewarn "the libraries are not being removed. You need to run revdep-rebuild" 1841 ewarn "the libraries are not being removed. You need to run revdep-rebuild"
1786 ewarn "in order to remove these old dependencies. If you do not have this" 1842 ewarn "in order to remove these old dependencies. If you do not have this"
1787 ewarn "helper program, simply emerge the 'gentoolkit' package." 1843 ewarn "helper program, simply emerge the 'gentoolkit' package."
1788 ewarn 1844 ewarn
1789 fi 1845 fi
1846 # temp hack for #348634 #357225
1847 [[ ${PN} == "mpfr" ]] && lib=${lib##*/}
1790 ewarn " # revdep-rebuild --library ${lib##*/}" 1848 ewarn " # revdep-rebuild --library '${lib}'"
1791 done 1849 done
1792 if [[ ${notice} -eq 1 ]] ; then 1850 if [[ ${notice} -eq 1 ]] ; then
1793 ewarn 1851 ewarn
1794 ewarn "Once you've finished running revdep-rebuild, it should be safe to" 1852 ewarn "Once you've finished running revdep-rebuild, it should be safe to"
1795 ewarn "delete the old libraries. Here is a copy & paste for the lazy:" 1853 ewarn "delete the old libraries. Here is a copy & paste for the lazy:"
1941 else 1999 else
1942 newbin "${tmpwrapper}" "${wrapper}" || die 2000 newbin "${tmpwrapper}" "${wrapper}" || die
1943 fi 2001 fi
1944} 2002}
1945 2003
1946# @FUNCTION: prepalldocs 2004# @FUNCTION: path_exists
1947# @USAGE: 2005# @USAGE: [-a|-o] <paths>
1948# @DESCRIPTION: 2006# @DESCRIPTION:
1949# Compress files in /usr/share/doc which are not already 2007# Check if the specified paths exist. Works for all types of paths
1950# compressed, excluding /usr/share/doc/${PF}/html. 2008# (files/dirs/etc...). The -a and -o flags control the requirements
1951# Uses the ecompressdir to do the compression. 2009# of the paths. They correspond to "and" and "or" logic. So the -a
1952# 2009-02-18 by betelgeuse: 2010# flag means all the paths must exist while the -o flag means at least
1953# Commented because ecompressdir is even more internal to 2011# one of the paths must exist. The default behavior is "and". If no
1954# Portage than prepalldocs (it's not even mentioned in man 5 2012# paths are specified, then the return value is "false".
1955# ebuild). Please submit a better version for review to gentoo-dev 2013path_exists() {
1956# if you want prepalldocs here. 2014 local opt=$1
1957#prepalldocs() { 2015 [[ ${opt} == -[ao] ]] && shift || opt="-a"
1958# if [[ -n $1 ]] ; then
1959# ewarn "prepalldocs: invalid usage; takes no arguments"
1960# fi
1961 2016
1962# cd "${D}" 2017 # no paths -> return false
1963# [[ -d usr/share/doc ]] || return 0 2018 # same behavior as: [[ -e "" ]]
2019 [[ $# -eq 0 ]] && return 1
1964 2020
1965# find usr/share/doc -exec gzip {} + 2021 local p r=0
1966# ecompressdir --ignore /usr/share/doc/${PF}/html 2022 for p in "$@" ; do
1967# ecompressdir --queue /usr/share/doc 2023 [[ -e ${p} ]]
1968#} 2024 : $(( r += $? ))
2025 done
2026
2027 case ${opt} in
2028 -a) return $(( r != 0 )) ;;
2029 -o) return $(( r == $# )) ;;
2030 esac
2031}
2032
2033# @FUNCTION: in_iuse
2034# @USAGE: <flag>
2035# @DESCRIPTION:
2036# Determines whether the given flag is in IUSE. Strips IUSE default prefixes
2037# as necessary.
2038#
2039# Note that this function should not be used in the global scope.
2040in_iuse() {
2041 debug-print-function ${FUNCNAME} "${@}"
2042 [[ ${#} -eq 1 ]] || die "Invalid args to ${FUNCNAME}()"
2043
2044 local flag=${1}
2045 local liuse=( ${IUSE} )
2046
2047 has "${flag}" "${liuse[@]#[+-]}"
2048}
2049
2050# @FUNCTION: use_if_iuse
2051# @USAGE: <flag>
2052# @DESCRIPTION:
2053# Return true if the given flag is in USE and IUSE.
2054#
2055# Note that this function should not be used in the global scope.
2056use_if_iuse() {
2057 in_iuse $1 || return 1
2058 use $1
2059}
2060
2061# @FUNCTION: usex
2062# @USAGE: <USE flag> [true output] [false output] [true suffix] [false suffix]
2063# @DESCRIPTION:
2064# If USE flag is set, echo [true output][true suffix] (defaults to "yes"),
2065# otherwise echo [false output][false suffix] (defaults to "no").
2066usex() { use "$1" && echo "${2-yes}$4" || echo "${3-no}$5" ; } #382963

Legend:
Removed from v.1.349  
changed lines
  Added in v.1.367

  ViewVC Help
Powered by ViewVC 1.1.20