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

Diff of /eclass/eutils.eclass

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

Revision 1.275 Revision 1.319
1# Copyright 1999-2006 Gentoo Foundation 1# Copyright 1999-2007 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.275 2007/02/17 00:17:39 vapier Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.319 2009/09/12 14:37:51 grobian Exp $
4
5# @ECLASS: eutils.eclass
6# @MAINTAINER:
7# base-system@gentoo.org
8# @BLURB: many extra (but common) functions that are used in ebuilds
9# @DESCRIPTION:
10# The eutils eclass contains a suite of functions that complement
11# the ones that ebuild.sh already contain. The idea is that the functions
12# are not required in all ebuilds but enough utilize them to have a common
13# home rather than having multiple ebuilds implementing the same thing.
4# 14#
5# This eclass is for general purpose functions that most ebuilds 15# Due to the nature of this eclass, some functions may have maintainers
6# have to implement themselves. 16# different from the overall eclass!
7#
8# NB: If you add anything, please comment it!
9#
10# Maintainer: see each individual function, base-system@gentoo.org as default
11 17
12inherit multilib portability 18inherit multilib portability
13 19
14DESCRIPTION="Based on the ${ECLASS} eclass" 20DESCRIPTION="Based on the ${ECLASS} eclass"
15 21
16# Wait for the supplied number of seconds. If no argument is supplied, defaults 22# @FUNCTION: epause
17# to five seconds. If the EPAUSE_IGNORE env var is set, don't wait. If we're not 23# @USAGE: [seconds]
18# outputting to a terminal, don't wait. For compatability purposes, the argument 24# @DESCRIPTION:
19# must be an integer greater than zero. 25# Sleep for the specified number of seconds (default of 5 seconds). Useful when
20# Bug 62950, Ciaran McCreesh <ciaranm@gentoo.org> (05 Sep 2004) 26# printing a message the user should probably be reading and often used in
27# conjunction with the ebeep function. If the EPAUSE_IGNORE env var is set,
28# don't wait at all.
21epause() { 29epause() {
22 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5} 30 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5}
23} 31}
24 32
25# Beep the specified number of times (defaults to five). If our output 33# @FUNCTION: ebeep
26# is not a terminal, don't beep. If the EBEEP_IGNORE env var is set, 34# @USAGE: [number of beeps]
35# @DESCRIPTION:
36# Issue the specified number of beeps (default of 5 beeps). Useful when
37# printing a message the user should probably be reading and often used in
38# conjunction with the epause function. If the EBEEP_IGNORE env var is set,
27# don't beep. 39# don't beep at all.
28# Bug 62950, Ciaran McCreesh <ciaranm@gentoo.org> (05 Sep 2004)
29ebeep() { 40ebeep() {
30 local n 41 local n
31 if [[ -z ${EBEEP_IGNORE} ]] ; then 42 if [[ -z ${EBEEP_IGNORE} ]] ; then
32 for ((n=1 ; n <= ${1:-5} ; n++)) ; do 43 for ((n=1 ; n <= ${1:-5} ; n++)) ; do
33 echo -ne "\a" 44 echo -ne "\a"
36 sleep 1 47 sleep 1
37 done 48 done
38 fi 49 fi
39} 50}
40 51
41# This function generate linker scripts in /usr/lib for dynamic 52# @FUNCTION: ecvs_clean
42# libs in /lib. This is to fix linking problems when you have 53# @USAGE: [list of dirs]
43# the .so in /lib, and the .a in /usr/lib. What happens is that 54# @DESCRIPTION:
44# in some cases when linking dynamic, the .a in /usr/lib is used 55# Remove CVS directories recursiveley. Useful when a source tarball contains
45# instead of the .so in /lib due to gcc/libtool tweaking ld's 56# internal CVS directories. Defaults to $PWD.
46# library search path. This cause many builds to fail. 57ecvs_clean() {
47# See bug #4411 for more info. 58 [[ -z $* ]] && set -- .
48# 59 find "$@" -type d -name 'CVS' -prune -print0 | xargs -0 rm -rf
49# To use, simply call: 60 find "$@" -type f -name '.cvs*' -print0 | xargs -0 rm -rf
50#
51# gen_usr_ldscript libfoo.so
52#
53# Note that you should in general use the unversioned name of
54# the library, as ldconfig should usually update it correctly
55# to point to the latest version of the library present.
56#
57# <azarah@gentoo.org> (26 Oct 2002)
58#
59gen_usr_ldscript() {
60 if [[ $(type -t _tc_gen_usr_ldscript) == "function" ]] ; then
61 _tc_gen_usr_ldscript "$@"
62 return $?
63 fi
64
65 ewarn "QA Notice: Please upgrade your ebuild to use toolchain-funcs"
66 ewarn "QA Notice: rather than gen_usr_ldscript() from eutils"
67
68 local lib libdir=$(get_libdir)
69 # Just make sure it exists
70 dodir /usr/${libdir}
71
72 for lib in "${@}" ; do
73 cat > "${D}/usr/${libdir}/${lib}" <<-END_LDSCRIPT
74 /* GNU ld script
75 Since Gentoo has critical dynamic libraries
76 in /lib, and the static versions in /usr/lib,
77 we need to have a "fake" dynamic lib in /usr/lib,
78 otherwise we run into linking problems.
79
80 See bug http://bugs.gentoo.org/4411 for more info.
81 */
82 GROUP ( /${libdir}/${lib} )
83 END_LDSCRIPT
84 fperms a+x "/usr/${libdir}/${lib}" || die "could not change perms on ${lib}"
85 done
86} 61}
87 62
63# @FUNCTION: esvn_clean
64# @USAGE: [list of dirs]
65# @DESCRIPTION:
66# Remove .svn directories recursiveley. Useful when a source tarball contains
67# internal Subversion directories. Defaults to $PWD.
68esvn_clean() {
69 [[ -z $* ]] && set -- .
70 find "$@" -type d -name '.svn' -prune -print0 | xargs -0 rm -rf
71}
88 72
89# Default directory where patches are located 73# Default directory where patches are located
90EPATCH_SOURCE="${WORKDIR}/patch" 74EPATCH_SOURCE="${WORKDIR}/patch"
91# Default extension for patches 75# Default extension for patches
92EPATCH_SUFFIX="patch.bz2" 76EPATCH_SUFFIX="patch.bz2"
93# Default options for patch 77# Default options for patch
94# Set -g0 to keep RCS, ClearCase, Perforce and SCCS happy. Bug #24571 78# Set -g0 to keep RCS, ClearCase, Perforce and SCCS happy. Bug #24571
95# Set --no-backup-if-mismatch so we don't leave '.orig' files behind. 79# Set --no-backup-if-mismatch so we don't leave '.orig' files behind.
96# Set -E to automatically remove empty files. 80# Set -E to automatically remove empty files.
97EPATCH_OPTS="-g0 -E --no-backup-if-mismatch" 81EPATCH_OPTS="-g0 -E --no-backup-if-mismatch"
98# List of patches not to apply. Not this is only file names, 82# List of patches not to apply. Note this is only file names,
99# and not the full path .. 83# and not the full path ..
100EPATCH_EXCLUDE="" 84EPATCH_EXCLUDE=""
101# Change the printed message for a single patch. 85# Change the printed message for a single patch.
102EPATCH_SINGLE_MSG="" 86EPATCH_SINGLE_MSG=""
103# Change the printed message for multiple patches. 87# Change the printed message for multiple patches.
121# bug they should be left as is to ensure an ebuild can rely on 105# bug they should be left as is to ensure an ebuild can rely on
122# them for. 106# them for.
123# 107#
124# Patches are applied in current directory. 108# Patches are applied in current directory.
125# 109#
126# Bulk Patches should preferibly have the form of: 110# Bulk Patches should preferably have the form of:
127# 111#
128# ??_${ARCH}_foo.${EPATCH_SUFFIX} 112# ??_${ARCH}_foo.${EPATCH_SUFFIX}
129# 113#
130# For example: 114# For example:
131# 115#
180 local EPATCH_SOURCE="$1/*" 164 local EPATCH_SOURCE="$1/*"
181 else 165 else
182 local EPATCH_SOURCE="$1/*.${EPATCH_SUFFIX}" 166 local EPATCH_SOURCE="$1/*.${EPATCH_SUFFIX}"
183 fi 167 fi
184 else 168 else
185 if [ ! -d ${EPATCH_SOURCE} ] || [ -n "$1" ] 169 if [[ ! -d ${EPATCH_SOURCE} ]] || [[ -n $1 ]] ; then
186 then
187 if [ -n "$1" -a "${EPATCH_SOURCE}" = "${WORKDIR}/patch" ] 170 if [ -n "$1" -a "${EPATCH_SOURCE}" = "${WORKDIR}/patch" ]
188 then 171 then
189 EPATCH_SOURCE="$1" 172 EPATCH_SOURCE="$1"
190 fi 173 fi
191 174
200 183
201 local EPATCH_SOURCE="${EPATCH_SOURCE}/*.${EPATCH_SUFFIX}" 184 local EPATCH_SOURCE="${EPATCH_SOURCE}/*.${EPATCH_SUFFIX}"
202 fi 185 fi
203 186
204 case ${EPATCH_SUFFIX##*\.} in 187 case ${EPATCH_SUFFIX##*\.} in
188 xz)
189 PIPE_CMD="xz -dc"
190 PATCH_SUFFIX="xz"
191 ;;
192 lzma)
193 PIPE_CMD="lzma -dc"
194 PATCH_SUFFIX="lzma"
195 ;;
205 bz2) 196 bz2)
206 PIPE_CMD="bzip2 -dc" 197 PIPE_CMD="bzip2 -dc"
207 PATCH_SUFFIX="bz2" 198 PATCH_SUFFIX="bz2"
208 ;; 199 ;;
209 gz|Z|z) 200 gz|Z|z)
259 fi 250 fi
260 251
261 echo "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 252 echo "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
262 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 253 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
263 254
255 # Decompress the patch if need be
256 if [[ ${PATCH_SUFFIX} != "patch" ]] ; then
257 echo -n "PIPE_COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
258 echo "${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
259
260 if ! (${PIPE_CMD} ${x} > ${PATCH_TARGET}) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1 ; then
261 echo
262 eerror "Could not extract patch!"
263 #die "Could not extract patch!"
264 count=5
265 break
266 fi
267 else
268 PATCH_TARGET="${x}"
269 fi
270
271 # Check for absolute paths in patches. If sandbox is disabled,
272 # people could (accidently) patch files in the root filesystem.
273 # Or trigger other unpleasantries #237667. So disallow -p0 on
274 # such patches.
275 local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }')
276 if [[ -n ${abs_paths} ]] ; then
277 count=1
278 echo "NOTE: skipping -p0 due to absolute paths in patch:" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
279 echo "${abs_paths}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
280 fi
281
264 # Allow for prefix to differ ... im lazy, so shoot me :/ 282 # Allow for prefix to differ ... im lazy, so shoot me :/
265 while [ "${count}" -lt 5 ] 283 while [ "${count}" -lt 5 ]
266 do 284 do
267 # Generate some useful debug info ... 285 # Generate some useful debug info ...
268 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 286 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
269 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 287 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
270 288
271 if [ "${PATCH_SUFFIX}" != "patch" ]
272 then
273 echo -n "PIPE_COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
274 echo "${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
275 else
276 PATCH_TARGET="${x}"
277 fi
278
279 echo -n "PATCH COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 289 echo -n "PATCH COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
280 echo "patch -p${count} ${popts} < ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 290 echo "patch -p${count} ${popts} < ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
281 291
282 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 292 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
283 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 293 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
284
285 if [ "${PATCH_SUFFIX}" != "patch" ]
286 then
287 if ! (${PIPE_CMD} ${x} > ${PATCH_TARGET}) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1
288 then
289 echo
290 eerror "Could not extract patch!"
291 #die "Could not extract patch!"
292 count=5
293 break
294 fi
295 fi
296 294
297 if (cat ${PATCH_TARGET} | patch -p${count} ${popts} --dry-run -f ; _epatch_assert) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1 295 if (cat ${PATCH_TARGET} | patch -p${count} ${popts} --dry-run -f ; _epatch_assert) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1
298 then 296 then
299 _epatch_draw_line "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real 297 _epatch_draw_line "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
300 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real 298 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
349 if [ "${SINGLE_PATCH}" = "no" ] 347 if [ "${SINGLE_PATCH}" = "no" ]
350 then 348 then
351 einfo "Done with patching" 349 einfo "Done with patching"
352 fi 350 fi
353} 351}
352epatch_user() {
353 [[ $# -ne 0 ]] && die "epatch_user takes no options"
354 354
355 # don't clobber any EPATCH vars that the parent might want
356 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT}/etc/portage/patches
357 for check in {${CATEGORY}/${PF},${CATEGORY}/${P},${CATEGORY}/${PN}}; do
358 EPATCH_SOURCE=${base}/${CTARGET}/${check}
359 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${CHOST}/${check}
360 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${check}
361 if [[ -d ${EPATCH_SOURCE} ]] ; then
362 EPATCH_SOURCE=${EPATCH_SOURCE} \
363 EPATCH_SUFFIX="patch" \
364 EPATCH_FORCE="yes" \
365 EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \
366 epatch
367 break
368 fi
369 done
370}
371
372# @FUNCTION: emktemp
373# @USAGE: [temp dir]
374# @DESCRIPTION:
355# Cheap replacement for when debianutils (and thus mktemp) 375# Cheap replacement for when debianutils (and thus mktemp)
356# does not exist on the users system 376# does not exist on the users system.
357# vapier@gentoo.org
358#
359# Takes just 1 optional parameter (the directory to create tmpfile in)
360emktemp() { 377emktemp() {
361 local exe="touch" 378 local exe="touch"
362 [[ $1 == -d ]] && exe="mkdir" && shift 379 [[ $1 == -d ]] && exe="mkdir" && shift
363 local topdir=$1 380 local topdir=$1
364 381
366 [[ -z ${T} ]] \ 383 [[ -z ${T} ]] \
367 && topdir="/tmp" \ 384 && topdir="/tmp" \
368 || topdir=${T} 385 || topdir=${T}
369 fi 386 fi
370 387
371 if [[ -z $(type -p mktemp) ]] ; then 388 if ! type -P mktemp > /dev/null ; then
389 # system lacks `mktemp` so we have to fake it
372 local tmp=/ 390 local tmp=/
373 while [[ -e ${tmp} ]] ; do 391 while [[ -e ${tmp} ]] ; do
374 tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM} 392 tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM}
375 done 393 done
376 ${exe} "${tmp}" || ${exe} -p "${tmp}" 394 ${exe} "${tmp}" || ${exe} -p "${tmp}"
377 echo "${tmp}" 395 echo "${tmp}"
378 else 396 else
397 # the args here will give slightly wierd names on BSD,
398 # but should produce a usable file on all userlands
379 if [[ ${exe} == "touch" ]] ; then 399 if [[ ${exe} == "touch" ]] ; then
380 [[ ${USERLAND} == "GNU" ]] \
381 && mktemp -p "${topdir}" \
382 || TMPDIR="${topdir}" mktemp -t tmp 400 TMPDIR="${topdir}" mktemp -t tmp.XXXXXXXXXX
383 else 401 else
384 [[ ${USERLAND} == "GNU" ]] \
385 && mktemp -d "${topdir}" \
386 || TMPDIR="${topdir}" mktemp -dt tmp 402 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
387 fi
388 fi 403 fi
404 fi
389} 405}
390 406
407# @FUNCTION: egetent
408# @USAGE: <database> <key>
409# @MAINTAINER:
410# base-system@gentoo.org (Linux)
411# Joe Jezak <josejx@gmail.com> (OS X)
412# usata@gentoo.org (OS X)
413# Aaron Walker <ka0ttic@gentoo.org> (FreeBSD)
414# @DESCRIPTION:
391# Small wrapper for getent (Linux), nidump (Mac OS X), 415# Small wrapper for getent (Linux),
416# nidump (< Mac OS X 10.5), dscl (Mac OS X 10.5),
392# and pw (FreeBSD) used in enewuser()/enewgroup() 417# and pw (FreeBSD) used in enewuser()/enewgroup()
393# Joe Jezak <josejx@gmail.com> and usata@gentoo.org
394# FBSD stuff: Aaron Walker <ka0ttic@gentoo.org>
395#
396# egetent(database, key)
397egetent() { 418egetent() {
398 case ${CHOST} in 419 case ${CHOST} in
399 *-darwin*) 420 *-darwin[678])
400 case "$2" in 421 case "$2" in
401 *[!0-9]*) # Non numeric 422 *[!0-9]*) # Non numeric
402 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }" 423 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }"
403 ;; 424 ;;
404 *) # Numeric 425 *) # Numeric
405 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }" 426 nidump $1 . | awk -F":" "{ if (\$3 == $2) {print \$0;exit;} }"
427 ;;
428 esac
429 ;;
430 *-darwin*)
431 local mytype=$1
432 [[ "passwd" == $mytype ]] && mytype="Users"
433 [[ "group" == $mytype ]] && mytype="Groups"
434 case "$2" in
435 *[!0-9]*) # Non numeric
436 dscl . -read /$mytype/$2 2>/dev/null |grep RecordName
437 ;;
438 *) # Numeric
439 local mykey="UniqueID"
440 [[ $mytype == "Groups" ]] && mykey="PrimaryGroupID"
441 dscl . -search /$mytype $mykey $2 2>/dev/null
406 ;; 442 ;;
407 esac 443 esac
408 ;; 444 ;;
409 *-freebsd*|*-dragonfly*) 445 *-freebsd*|*-dragonfly*)
410 local opts action="user" 446 local opts action="user"
425 getent "$1" "$2" 461 getent "$1" "$2"
426 ;; 462 ;;
427 esac 463 esac
428} 464}
429 465
430# Simplify/standardize adding users to the system 466# @FUNCTION: enewuser
431# vapier@gentoo.org 467# @USAGE: <user> [uid] [shell] [homedir] [groups] [params]
432# 468# @DESCRIPTION:
433# enewuser(username, uid, shell, homedir, groups, extra options) 469# Same as enewgroup, you are not required to understand how to properly add
434# 470# a user to the system. The only required parameter is the username.
435# Default values if you do not specify any: 471# Default uid is (pass -1 for this) next available, default shell is
436# username: REQUIRED ! 472# /bin/false, default homedir is /dev/null, there are no default groups,
437# uid: next available (see useradd(8)) 473# and default params sets the comment as 'added by portage for ${PN}'.
438# note: pass -1 to get default behavior
439# shell: /bin/false
440# homedir: /dev/null
441# groups: none
442# extra: comment of 'added by portage for ${PN}'
443enewuser() { 474enewuser() {
444 case ${EBUILD_PHASE} in 475 case ${EBUILD_PHASE} in
445 unpack|compile|test|install) 476 unpack|compile|test|install)
446 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function." 477 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
447 eerror "Package fails at QA and at life. Please file a bug." 478 eerror "Package fails at QA and at life. Please file a bug."
636 fi 667 fi
637 668
638 export SANDBOX_ON=${oldsandbox} 669 export SANDBOX_ON=${oldsandbox}
639} 670}
640 671
641# Simplify/standardize adding groups to the system 672# @FUNCTION: enewgroup
642# vapier@gentoo.org 673# @USAGE: <group> [gid]
643# 674# @DESCRIPTION:
644# enewgroup(group, gid) 675# This function does not require you to understand how to properly add a
645# 676# group to the system. Just give it a group name to add and enewgroup will
646# Default values if you do not specify any: 677# do the rest. You may specify the gid for the group or allow the group to
647# groupname: REQUIRED ! 678# allocate the next available one.
648# gid: next available (see groupadd(8))
649# extra: none
650enewgroup() { 679enewgroup() {
651 case ${EBUILD_PHASE} in 680 case ${EBUILD_PHASE} in
652 unpack|compile|test|install) 681 unpack|compile|test|install)
653 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function." 682 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
654 eerror "Package fails at QA and at life. Please file a bug." 683 eerror "Package fails at QA and at life. Please file a bug."
750 ;; 779 ;;
751 esac 780 esac
752 export SANDBOX_ON="${oldsandbox}" 781 export SANDBOX_ON="${oldsandbox}"
753} 782}
754 783
755# Simple script to replace 'dos2unix' binaries 784# @FUNCTION: edos2unix
756# vapier@gentoo.org 785# @USAGE: <file> [more files ...]
757# 786# @DESCRIPTION:
758# edos2unix(file, <more files> ...) 787# A handy replacement for dos2unix, recode, fixdos, etc... This allows you
788# to remove all of these text utilities from DEPEND variables because this
789# is a script based solution. Just give it a list of files to convert and
790# they will all be changed from the DOS CRLF format to the UNIX LF format.
759edos2unix() { 791edos2unix() {
760 echo "$@" | xargs sed -i 's/\r$//' 792 echo "$@" | xargs sed -i 's/\r$//'
761} 793}
762
763
764##############################################################
765# START: Handle .desktop files and menu entries #
766# maybe this should be separated into a new eclass some time #
767# lanius@gentoo.org #
768##############################################################
769 794
770# Make a desktop file ! 795# Make a desktop file !
771# Great for making those icons in kde/gnome startmenu ! 796# Great for making those icons in kde/gnome startmenu !
772# Amaze your friends ! Get the women ! Join today ! 797# Amaze your friends ! Get the women ! Join today !
773# 798#
777# name: the name that will show up in the menu 802# name: the name that will show up in the menu
778# icon: give your little like a pretty little icon ... 803# icon: give your little like a pretty little icon ...
779# this can be relative (to /usr/share/pixmaps) or 804# this can be relative (to /usr/share/pixmaps) or
780# a full path to an icon 805# a full path to an icon
781# type: what kind of application is this ? for categories: 806# type: what kind of application is this ? for categories:
782# http://www.freedesktop.org/Standards/desktop-entry-spec 807# http://standards.freedesktop.org/menu-spec/latest/apa.html
783# path: if your app needs to startup in a specific dir 808# path: if your app needs to startup in a specific dir
784make_desktop_entry() { 809make_desktop_entry() {
785 [[ -z $1 ]] && eerror "make_desktop_entry: You must specify the executable" && return 1 810 [[ -z $1 ]] && eerror "make_desktop_entry: You must specify the executable" && return 1
786 811
787 local exec=${1} 812 local exec=${1}
788 local name=${2:-${PN}} 813 local name=${2:-${PN}}
789 local icon=${3:-${PN}.png} 814 local icon=${3:-${PN}}
790 local type=${4} 815 local type=${4}
791 local path=${5} 816 local path=${5}
792 817
793 if [[ -z ${type} ]] ; then 818 if [[ -z ${type} ]] ; then
794 local catmaj=${CATEGORY%%-*} 819 local catmaj=${CATEGORY%%-*}
795 local catmin=${CATEGORY##*-} 820 local catmin=${CATEGORY##*-}
796 case ${catmaj} in 821 case ${catmaj} in
797 app) 822 app)
798 case ${catmin} in 823 case ${catmin} in
824 accessibility) type=Accessibility;;
799 admin) type=System;; 825 admin) type=System;;
826 antivirus) type=System;;
827 arch) type=Archiving;;
828 backup) type=Archiving;;
800 cdr) type=DiscBurning;; 829 cdr) type=DiscBurning;;
801 dicts) type=Dictionary;; 830 dicts) type=Dictionary;;
831 doc) type=Documentation;;
802 editors) type=TextEditor;; 832 editors) type=TextEditor;;
803 emacs) type=TextEditor;; 833 emacs) type=TextEditor;;
804 emulation) type=Emulator;; 834 emulation) type=Emulator;;
805 laptop) type=HardwareSettings;; 835 laptop) type=HardwareSettings;;
806 office) type=Office;; 836 office) type=Office;;
837 pda) type=PDA;;
807 vim) type=TextEditor;; 838 vim) type=TextEditor;;
808 xemacs) type=TextEditor;; 839 xemacs) type=TextEditor;;
809 *) type=;; 840 *) type=;;
810 esac 841 esac
811 ;; 842 ;;
817 games) 848 games)
818 case ${catmin} in 849 case ${catmin} in
819 action|fps) type=ActionGame;; 850 action|fps) type=ActionGame;;
820 arcade) type=ArcadeGame;; 851 arcade) type=ArcadeGame;;
821 board) type=BoardGame;; 852 board) type=BoardGame;;
853 emulation) type=Emulator;;
822 kids) type=KidsGame;; 854 kids) type=KidsGame;;
823 emulation) type=Emulator;;
824 puzzle) type=LogicGame;; 855 puzzle) type=LogicGame;;
856 roguelike) type=RolePlaying;;
825 rpg) type=RolePlaying;; 857 rpg) type=RolePlaying;;
826 roguelike) type=RolePlaying;;
827 simulation) type=Simulation;; 858 simulation) type=Simulation;;
828 sports) type=SportsGame;; 859 sports) type=SportsGame;;
829 strategy) type=StrategyGame;; 860 strategy) type=StrategyGame;;
830 *) type=;; 861 *) type=;;
831 esac 862 esac
832 type="Game;${type}" 863 type="Game;${type}"
864 ;;
865
866 gnome)
867 type="Gnome;GTK"
868 ;;
869
870 kde)
871 type="KDE;Qt"
833 ;; 872 ;;
834 873
835 mail) 874 mail)
836 type="Network;Email" 875 type="Network;Email"
837 ;; 876 ;;
863 type="Network;${type}" 902 type="Network;${type}"
864 ;; 903 ;;
865 904
866 sci) 905 sci)
867 case ${catmin} in 906 case ${catmin} in
868 astro*) type=Astronomy;; 907 astro*) type=Astronomy;;
869 bio*) type=Biology;; 908 bio*) type=Biology;;
870 calc*) type=Calculator;; 909 calc*) type=Calculator;;
871 chem*) type=Chemistry;; 910 chem*) type=Chemistry;;
911 elec*) type=Electronics;;
872 geo*) type=Geology;; 912 geo*) type=Geology;;
873 math*) type=Math;; 913 math*) type=Math;;
914 physics) type=Physics;;
915 visual*) type=DataVisualization;;
874 *) type=;; 916 *) type=;;
875 esac 917 esac
876 type="Science;${type}" 918 type="Science;${type}"
919 ;;
920
921 sys)
922 type="System"
877 ;; 923 ;;
878 924
879 www) 925 www)
880 case ${catmin} in 926 case ${catmin} in
881 client) type=WebBrowser;; 927 client) type=WebBrowser;;
897 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop" 943 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop"
898 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop 944 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop
899 945
900 cat <<-EOF > "${desktop}" 946 cat <<-EOF > "${desktop}"
901 [Desktop Entry] 947 [Desktop Entry]
902 Encoding=UTF-8
903 Version=0.9.2 948 Version=1.0
904 Name=${name} 949 Name=${name}
905 Type=Application 950 Type=Application
906 Comment=${DESCRIPTION} 951 Comment=${DESCRIPTION}
907 Exec=${exec} 952 Exec=${exec}
908 TryExec=${exec%% *} 953 TryExec=${exec%% *}
909 Path=${path}
910 Icon=${icon} 954 Icon=${icon}
911 Categories=Application;${type}; 955 Categories=${type};
912 EOF 956 EOF
957
958 [[ ${path} ]] && echo "Path=${path}" >> "${desktop}"
913 959
914 ( 960 (
915 # wrap the env here so that the 'insinto' call 961 # wrap the env here so that the 'insinto' call
916 # doesn't corrupt the env of the caller 962 # doesn't corrupt the env of the caller
917 insinto /usr/share/applications 963 insinto /usr/share/applications
918 doins "${desktop}" 964 doins "${desktop}"
919 ) 965 )
920} 966}
921 967
922# Make a GDM/KDM Session file 968# @FUNCTION: validate_desktop_entries
923# 969# @USAGE: [directories]
924# make_session_desktop(<title>, <command>) 970# @MAINTAINER:
925# title: File to execute to start the Window Manager 971# Carsten Lohrke <carlo@gentoo.org>
926# command: Name of the Window Manager 972# @DESCRIPTION:
973# Validate desktop entries using desktop-file-utils
974validate_desktop_entries() {
975 if [[ -x /usr/bin/desktop-file-validate ]] ; then
976 einfo "Checking desktop entry validity"
977 local directories=""
978 for d in /usr/share/applications $@ ; do
979 [[ -d ${D}${d} ]] && directories="${directories} ${D}${d}"
980 done
981 if [[ -n ${directories} ]] ; then
982 for FILE in $(find ${directories} -name "*\.desktop" \
983 -not -path '*.hidden*' | sort -u 2>/dev/null)
984 do
985 local temp=$(desktop-file-validate ${FILE} | grep -v "warning:" | \
986 sed -e "s|error: ||" -e "s|${FILE}:|--|g" )
987 [[ -n $temp ]] && elog ${temp/--/${FILE/${D}/}:}
988 done
989 fi
990 echo ""
991 else
992 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo."
993 fi
994}
927 995
996# @FUNCTION: make_session_desktop
997# @USAGE: <title> <command> [command args...]
998# @DESCRIPTION:
999# Make a GDM/KDM Session file. The title is the file to execute to start the
1000# Window Manager. The command is the name of the Window Manager.
1001#
1002# You can set the name of the file via the ${wm} variable.
928make_session_desktop() { 1003make_session_desktop() {
929 [[ -z $1 ]] && eerror "make_session_desktop: You must specify the title" && return 1 1004 [[ -z $1 ]] && eerror "$0: You must specify the title" && return 1
930 [[ -z $2 ]] && eerror "make_session_desktop: You must specify the command" && return 1 1005 [[ -z $2 ]] && eerror "$0: You must specify the command" && return 1
931 1006
932 local title=$1 1007 local title=$1
933 local command=$2 1008 local command=$2
934 local desktop=${T}/${wm}.desktop 1009 local desktop=${T}/${wm:-${PN}}.desktop
1010 shift 2
935 1011
936 cat <<-EOF > "${desktop}" 1012 cat <<-EOF > "${desktop}"
937 [Desktop Entry] 1013 [Desktop Entry]
938 Encoding=UTF-8
939 Name=${title} 1014 Name=${title}
940 Comment=This session logs you into ${title} 1015 Comment=This session logs you into ${title}
941 Exec=${command} 1016 Exec=${command} $*
942 TryExec=${command} 1017 TryExec=${command}
943 Type=Application 1018 Type=XSession
944 EOF 1019 EOF
945 1020
946 ( 1021 (
947 # wrap the env here so that the 'insinto' call 1022 # wrap the env here so that the 'insinto' call
948 # doesn't corrupt the env of the caller 1023 # doesn't corrupt the env of the caller
949 insinto /usr/share/xsessions 1024 insinto /usr/share/xsessions
950 doins "${desktop}" 1025 doins "${desktop}"
951 ) 1026 )
952} 1027}
953 1028
1029# @FUNCTION: domenu
1030# @USAGE: <menus>
1031# @DESCRIPTION:
1032# Install the list of .desktop menu files into the appropriate directory
1033# (/usr/share/applications).
954domenu() { 1034domenu() {
955 ( 1035 (
956 # wrap the env here so that the 'insinto' call 1036 # wrap the env here so that the 'insinto' call
957 # doesn't corrupt the env of the caller 1037 # doesn't corrupt the env of the caller
958 local i j ret=0 1038 local i j ret=0
964 elif [[ -d ${i} ]] ; then 1044 elif [[ -d ${i} ]] ; then
965 for j in "${i}"/*.desktop ; do 1045 for j in "${i}"/*.desktop ; do
966 doins "${j}" 1046 doins "${j}"
967 ((ret+=$?)) 1047 ((ret+=$?))
968 done 1048 done
1049 else
1050 ((++ret))
969 fi 1051 fi
970 done 1052 done
971 exit ${ret} 1053 exit ${ret}
972 ) 1054 )
973} 1055}
1056
1057# @FUNCTION: newmenu
1058# @USAGE: <menu> <newname>
1059# @DESCRIPTION:
1060# Like all other new* functions, install the specified menu as newname.
974newmenu() { 1061newmenu() {
975 ( 1062 (
976 # wrap the env here so that the 'insinto' call 1063 # wrap the env here so that the 'insinto' call
977 # doesn't corrupt the env of the caller 1064 # doesn't corrupt the env of the caller
978 insinto /usr/share/applications 1065 insinto /usr/share/applications
979 newins "$@" 1066 newins "$@"
980 ) 1067 )
981} 1068}
982 1069
1070# @FUNCTION: doicon
1071# @USAGE: <list of icons>
1072# @DESCRIPTION:
1073# Install the list of icons into the icon directory (/usr/share/pixmaps).
1074# This is useful in conjunction with creating desktop/menu files.
983doicon() { 1075doicon() {
984 ( 1076 (
985 # wrap the env here so that the 'insinto' call 1077 # wrap the env here so that the 'insinto' call
986 # doesn't corrupt the env of the caller 1078 # doesn't corrupt the env of the caller
987 local i j ret 1079 local i j ret
993 elif [[ -d ${i} ]] ; then 1085 elif [[ -d ${i} ]] ; then
994 for j in "${i}"/*.png ; do 1086 for j in "${i}"/*.png ; do
995 doins "${j}" 1087 doins "${j}"
996 ((ret+=$?)) 1088 ((ret+=$?))
997 done 1089 done
1090 else
1091 ((++ret))
998 fi 1092 fi
999 done 1093 done
1000 exit ${ret} 1094 exit ${ret}
1001 ) 1095 )
1002} 1096}
1097
1098# @FUNCTION: newicon
1099# @USAGE: <icon> <newname>
1100# @DESCRIPTION:
1101# Like all other new* functions, install the specified icon as newname.
1003newicon() { 1102newicon() {
1004 ( 1103 (
1005 # wrap the env here so that the 'insinto' call 1104 # wrap the env here so that the 'insinto' call
1006 # doesn't corrupt the env of the caller 1105 # doesn't corrupt the env of the caller
1007 insinto /usr/share/pixmaps 1106 insinto /usr/share/pixmaps
1008 newins "$@" 1107 newins "$@"
1009 ) 1108 )
1010} 1109}
1011
1012##############################################################
1013# END: Handle .desktop files and menu entries #
1014##############################################################
1015
1016 1110
1017# for internal use only (unpack_pdv and unpack_makeself) 1111# for internal use only (unpack_pdv and unpack_makeself)
1018find_unpackable_file() { 1112find_unpackable_file() {
1019 local src=$1 1113 local src=$1
1020 if [[ -z ${src} ]] ; then 1114 if [[ -z ${src} ]] ; then
1030 fi 1124 fi
1031 [[ ! -e ${src} ]] && return 1 1125 [[ ! -e ${src} ]] && return 1
1032 echo "${src}" 1126 echo "${src}"
1033} 1127}
1034 1128
1129# @FUNCTION: unpack_pdv
1130# @USAGE: <file to unpack> <size of off_t>
1131# @DESCRIPTION:
1035# Unpack those pesky pdv generated files ... 1132# Unpack those pesky pdv generated files ...
1036# They're self-unpacking programs with the binary package stuffed in 1133# They're self-unpacking programs with the binary package stuffed in
1037# the middle of the archive. Valve seems to use it a lot ... too bad 1134# the middle of the archive. Valve seems to use it a lot ... too bad
1038# it seems to like to segfault a lot :(. So lets take it apart ourselves. 1135# it seems to like to segfault a lot :(. So lets take it apart ourselves.
1039# 1136#
1040# Usage: unpack_pdv [file to unpack] [size of off_t]
1041# - you have to specify the off_t size ... i have no idea how to extract that 1137# You have to specify the off_t size ... I have no idea how to extract that
1042# information out of the binary executable myself. basically you pass in 1138# information out of the binary executable myself. Basically you pass in
1043# the size of the off_t type (in bytes) on the machine that built the pdv 1139# the size of the off_t type (in bytes) on the machine that built the pdv
1140# archive.
1141#
1044# archive. one way to determine this is by running the following commands: 1142# One way to determine this is by running the following commands:
1143#
1144# @CODE
1045# strings <pdv archive> | grep lseek 1145# strings <pdv archive> | grep lseek
1046# strace -elseek <pdv archive> 1146# strace -elseek <pdv archive>
1147# @CODE
1148#
1047# basically look for the first lseek command (we do the strings/grep because 1149# Basically look for the first lseek command (we do the strings/grep because
1048# sometimes the function call is _llseek or something) and steal the 2nd 1150# sometimes the function call is _llseek or something) and steal the 2nd
1049# parameter. here is an example: 1151# parameter. Here is an example:
1152#
1153# @CODE
1050# root@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek 1154# vapier@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek
1051# lseek 1155# lseek
1052# root@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin 1156# vapier@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin
1053# lseek(3, -4, SEEK_END) = 2981250 1157# lseek(3, -4, SEEK_END) = 2981250
1158# @CODE
1159#
1054# thus we would pass in the value of '4' as the second parameter. 1160# Thus we would pass in the value of '4' as the second parameter.
1055unpack_pdv() { 1161unpack_pdv() {
1056 local src=$(find_unpackable_file "$1") 1162 local src=$(find_unpackable_file "$1")
1057 local sizeoff_t=$2 1163 local sizeoff_t=$2
1058 1164
1059 [[ -z ${src} ]] && die "Could not locate source for '$1'" 1165 [[ -z ${src} ]] && die "Could not locate source for '$1'"
1121 true 1227 true
1122 #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')" 1228 #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1123 #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')" 1229 #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1124} 1230}
1125 1231
1232# @FUNCTION: unpack_makeself
1233# @USAGE: [file to unpack] [offset] [tail|dd]
1234# @DESCRIPTION:
1126# Unpack those pesky makeself generated files ... 1235# Unpack those pesky makeself generated files ...
1127# They're shell scripts with the binary package tagged onto 1236# They're shell scripts with the binary package tagged onto
1128# the end of the archive. Loki utilized the format as does 1237# the end of the archive. Loki utilized the format as does
1129# many other game companies. 1238# many other game companies.
1130# 1239#
1131# Usage: unpack_makeself [file to unpack] [offset] [tail|dd] 1240# If the file is not specified, then ${A} is used. If the
1132# - If the file is not specified then unpack will utilize ${A}.
1133# - If the offset is not specified then we will attempt to extract 1241# offset is not specified then we will attempt to extract
1134# the proper offset from the script itself. 1242# the proper offset from the script itself.
1135unpack_makeself() { 1243unpack_makeself() {
1136 local src_input=${1:-${A}} 1244 local src_input=${1:-${A}}
1137 local src=$(find_unpackable_file "${src_input}") 1245 local src=$(find_unpackable_file "${src_input}")
1138 local skip=$2 1246 local skip=$2
1139 local exe=$3 1247 local exe=$3
1209 ;; 1317 ;;
1210 esac 1318 esac
1211 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})" 1319 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})"
1212} 1320}
1213 1321
1322# @FUNCTION: check_license
1323# @USAGE: [license]
1324# @DESCRIPTION:
1214# Display a license for user to accept. 1325# Display a license for user to accept. If no license is
1215#
1216# Usage: check_license [license]
1217# - If the file is not specified then ${LICENSE} is used. 1326# specified, then ${LICENSE} is used.
1218check_license() { 1327check_license() {
1219 local lic=$1 1328 local lic=$1
1220 if [ -z "${lic}" ] ; then 1329 if [ -z "${lic}" ] ; then
1221 lic="${PORTDIR}/licenses/${LICENSE}" 1330 lic="${PORTDIR}/licenses/${LICENSE}"
1222 else 1331 else
1250 The following license outlines the terms of use of this 1359 The following license outlines the terms of use of this
1251 package. You MUST accept this license for installation to 1360 package. You MUST accept this license for installation to
1252 continue. When you are done viewing, hit 'q'. If you 1361 continue. When you are done viewing, hit 'q'. If you
1253 CTRL+C out of this, the install will not run! 1362 CTRL+C out of this, the install will not run!
1254 ********************************************************** 1363 **********************************************************
1255 1364
1256 EOF 1365 EOF
1257 cat ${lic} >> ${licmsg} 1366 cat ${lic} >> ${licmsg}
1258 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}" 1367 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}"
1259 einfon "Do you accept the terms of this license (${l})? [yes/no] " 1368 einfon "Do you accept the terms of this license (${l})? [yes/no] "
1260 read alic 1369 read alic
1268 die "Failed to accept license" 1377 die "Failed to accept license"
1269 ;; 1378 ;;
1270 esac 1379 esac
1271} 1380}
1272 1381
1382# @FUNCTION: cdrom_get_cds
1383# @USAGE: <file on cd1> [file on cd2] [file on cd3] [...]
1384# @DESCRIPTION:
1273# Aquire cd(s) for those lovely cd-based emerges. Yes, this violates 1385# Aquire cd(s) for those lovely cd-based emerges. Yes, this violates
1274# the whole 'non-interactive' policy, but damnit I want CD support ! 1386# the whole 'non-interactive' policy, but damnit I want CD support !
1275# 1387#
1276# with these cdrom functions we handle all the user interaction and 1388# With these cdrom functions we handle all the user interaction and
1277# standardize everything. all you have to do is call cdrom_get_cds() 1389# standardize everything. All you have to do is call cdrom_get_cds()
1278# and when the function returns, you can assume that the cd has been 1390# and when the function returns, you can assume that the cd has been
1279# found at CDROM_ROOT. 1391# found at CDROM_ROOT.
1280# 1392#
1393# The function will attempt to locate a cd based upon a file that is on
1394# the cd. The more files you give this function, the more cds
1395# the cdrom functions will handle.
1396#
1281# normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2', 1397# Normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2',
1282# etc... if you want to give the cds better names, then just export 1398# etc... If you want to give the cds better names, then just export
1283# the appropriate CDROM_NAME variable before calling cdrom_get_cds(). 1399# the appropriate CDROM_NAME variable before calling cdrom_get_cds().
1284# - CDROM_NAME="fooie cd" - for when you only want 1 cd 1400# Use CDROM_NAME for one cd, or CDROM_NAME_# for multiple cds. You can
1285# - CDROM_NAME_1="install cd" - for when you want more than 1 cd 1401# also use the CDROM_NAME_SET bash array.
1286# CDROM_NAME_2="data cd"
1287# - CDROM_NAME_SET=( "install cd" "data cd" ) - short hand for CDROM_NAME_#
1288# 1402#
1289# for those multi cd ebuilds, see the cdrom_load_next_cd() below. 1403# For those multi cd ebuilds, see the cdrom_load_next_cd() function.
1290#
1291# Usage: cdrom_get_cds <file on cd1> [file on cd2] [file on cd3] [...]
1292# - this will attempt to locate a cd based upon a file that is on
1293# the cd ... the more files you give this function, the more cds
1294# the cdrom functions will handle
1295cdrom_get_cds() { 1404cdrom_get_cds() {
1296 # first we figure out how many cds we're dealing with by 1405 # first we figure out how many cds we're dealing with by
1297 # the # of files they gave us 1406 # the # of files they gave us
1298 local cdcnt=0 1407 local cdcnt=0
1299 local f= 1408 local f=
1385 export CDROM_SET="" 1494 export CDROM_SET=""
1386 export CDROM_CURRENT_CD=0 1495 export CDROM_CURRENT_CD=0
1387 cdrom_load_next_cd 1496 cdrom_load_next_cd
1388} 1497}
1389 1498
1390# this is only used when you need access to more than one cd. 1499# @FUNCTION: cdrom_load_next_cd
1391# when you have finished using the first cd, just call this function. 1500# @DESCRIPTION:
1392# when it returns, CDROM_ROOT will be pointing to the second cd. 1501# Some packages are so big they come on multiple CDs. When you're done reading
1393# remember, you can only go forward in the cd chain, you can't go back. 1502# files off a CD and want access to the next one, just call this function.
1503# Again, all the messy details of user interaction are taken care of for you.
1504# Once this returns, just read the variable CDROM_ROOT for the location of the
1505# mounted CD. Note that you can only go forward in the CD list, so make sure
1506# you only call this function when you're done using the current CD.
1394cdrom_load_next_cd() { 1507cdrom_load_next_cd() {
1395 local var 1508 local var
1396 ((++CDROM_CURRENT_CD)) 1509 ((++CDROM_CURRENT_CD))
1397 1510
1398 unset CDROM_ROOT 1511 unset CDROM_ROOT
1415# displayed and we'll hang out here until: 1528# displayed and we'll hang out here until:
1416# (1) the file is found on a mounted cdrom 1529# (1) the file is found on a mounted cdrom
1417# (2) the user hits CTRL+C 1530# (2) the user hits CTRL+C
1418_cdrom_locate_file_on_cd() { 1531_cdrom_locate_file_on_cd() {
1419 local mline="" 1532 local mline=""
1420 local showedmsg=0 1533 local showedmsg=0 showjolietmsg=0
1421 1534
1422 while [[ -z ${CDROM_ROOT} ]] ; do 1535 while [[ -z ${CDROM_ROOT} ]] ; do
1423 local i=0 1536 local i=0
1424 local -a cdset=(${*//:/ }) 1537 local -a cdset=(${*//:/ })
1425 if [[ -n ${CDROM_SET} ]] ; then 1538 if [[ -n ${CDROM_SET} ]] ; then
1430 local dir=$(dirname ${cdset[${i}]}) 1543 local dir=$(dirname ${cdset[${i}]})
1431 local file=$(basename ${cdset[${i}]}) 1544 local file=$(basename ${cdset[${i}]})
1432 1545
1433 local point= node= fs= foo= 1546 local point= node= fs= foo=
1434 while read point node fs foo ; do 1547 while read point node fs foo ; do
1435 [[ " cd9660 iso9660 " != *" ${fs} "* ]] && \ 1548 [[ " cd9660 iso9660 udf " != *" ${fs} "* ]] && \
1436 ! [[ ${fs} == "subfs" && ",${opts}," == *",fs=cdfss,"* ]] \ 1549 ! [[ ${fs} == "subfs" && ",${opts}," == *",fs=cdfss,"* ]] \
1437 && continue 1550 && continue
1438 point=${point//\040/ } 1551 point=${point//\040/ }
1552 [[ ! -d ${point}/${dir} ]] && continue
1439 [[ -z $(find "${point}/${dir}" -maxdepth 1 -iname "${file}") ]] && continue 1553 [[ -z $(find "${point}/${dir}" -maxdepth 1 -iname "${file}") ]] && continue
1440 export CDROM_ROOT=${point} 1554 export CDROM_ROOT=${point}
1441 export CDROM_SET=${i} 1555 export CDROM_SET=${i}
1442 export CDROM_MATCH=${cdset[${i}]} 1556 export CDROM_MATCH=${cdset[${i}]}
1443 return 1557 return
1465 showedmsg=1 1579 showedmsg=1
1466 fi 1580 fi
1467 einfo "Press return to scan for the cd again" 1581 einfo "Press return to scan for the cd again"
1468 einfo "or hit CTRL+C to abort the emerge." 1582 einfo "or hit CTRL+C to abort the emerge."
1469 echo 1583 echo
1584 if [[ ${showjolietmsg} -eq 0 ]] ; then
1585 showjolietmsg=1
1586 else
1470 einfo "If you are having trouble with the detection" 1587 ewarn "If you are having trouble with the detection"
1471 einfo "of your CD, it is possible that you do not have" 1588 ewarn "of your CD, it is possible that you do not have"
1472 einfo "Joliet support enabled in your kernel. Please" 1589 ewarn "Joliet support enabled in your kernel. Please"
1473 einfo "check that CONFIG_JOLIET is enabled in your kernel." 1590 ewarn "check that CONFIG_JOLIET is enabled in your kernel."
1591 ebeep 5
1592 fi
1474 read || die "something is screwed with your system" 1593 read || die "something is screwed with your system"
1475 done 1594 done
1476} 1595}
1477 1596
1597# @FUNCTION: strip-linguas
1598# @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
1599# @DESCRIPTION:
1478# Make sure that LINGUAS only contains languages that 1600# Make sure that LINGUAS only contains languages that
1479# a package can support 1601# a package can support. The first form allows you to
1480# 1602# specify a list of LINGUAS. The -i builds a list of po
1481# usage: strip-linguas <allow LINGUAS> 1603# files found in all the directories and uses the
1482# strip-linguas -i <directories of .po files> 1604# intersection of the lists. The -u builds a list of po
1483# strip-linguas -u <directories of .po files> 1605# files found in all the directories and uses the union
1484# 1606# of the lists.
1485# The first form allows you to specify a list of LINGUAS.
1486# The -i builds a list of po files found in all the
1487# directories and uses the intersection of the lists.
1488# The -u builds a list of po files found in all the
1489# directories and uses the union of the lists.
1490strip-linguas() { 1607strip-linguas() {
1491 local ls newls nols 1608 local ls newls nols
1492 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then 1609 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then
1493 local op=$1; shift 1610 local op=$1; shift
1494 ls=$(find "$1" -name '*.po' -exec basename {} .po \;); shift 1611 ls=$(find "$1" -name '*.po' -exec basename {} .po ';'); shift
1495 local d f 1612 local d f
1496 for d in "$@" ; do 1613 for d in "$@" ; do
1497 if [[ ${op} == "-u" ]] ; then 1614 if [[ ${op} == "-u" ]] ; then
1498 newls=${ls} 1615 newls=${ls}
1499 else 1616 else
1500 newls="" 1617 newls=""
1501 fi 1618 fi
1502 for f in $(find "$d" -name '*.po' -exec basename {} .po \;) ; do 1619 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1503 if [[ ${op} == "-i" ]] ; then 1620 if [[ ${op} == "-i" ]] ; then
1504 hasq ${f} ${ls} && newls="${newls} ${f}" 1621 hasq ${f} ${ls} && newls="${newls} ${f}"
1505 else 1622 else
1506 hasq ${f} ${ls} || newls="${newls} ${f}" 1623 hasq ${f} ${ls} || newls="${newls} ${f}"
1507 fi 1624 fi
1520 else 1637 else
1521 nols="${nols} ${f}" 1638 nols="${nols} ${f}"
1522 fi 1639 fi
1523 done 1640 done
1524 [[ -n ${nols} ]] \ 1641 [[ -n ${nols} ]] \
1525 && ewarn "Sorry, but ${PN} does not support the LINGUAs:" ${nols} 1642 && ewarn "Sorry, but ${PN} does not support the LINGUAS:" ${nols}
1526 export LINGUAS=${newls:1} 1643 export LINGUAS=${newls:1}
1527} 1644}
1528 1645
1529# moved from kernel.eclass since they are generally useful outside of 1646# @FUNCTION: preserve_old_lib
1530# kernel.eclass -iggy (20041002) 1647# @USAGE: <libs to preserve> [more libs]
1531 1648# @DESCRIPTION:
1532# the following functions are useful in kernel module ebuilds, etc.
1533# for an example see ivtv or drbd ebuilds
1534
1535# set's ARCH to match what the kernel expects
1536set_arch_to_kernel() {
1537 i=10
1538 while ((i--)) ; do
1539 ewarn "PLEASE UPDATE TO YOUR PACKAGE TO USE linux-info.eclass"
1540 done
1541 export EUTILS_ECLASS_PORTAGE_ARCH="${ARCH}"
1542 case ${ARCH} in
1543 x86) export ARCH="i386";;
1544 amd64) export ARCH="x86_64";;
1545 hppa) export ARCH="parisc";;
1546 mips) export ARCH="mips";;
1547 sparc) export ARCH="$(tc-arch-kernel)";; # Yeah this is ugly, but it's even WORSE if you don't do this. linux-info.eclass's set_arch_to_kernel is fixed, but won't get used over this one!
1548 *) export ARCH="${ARCH}";;
1549 esac
1550}
1551
1552# set's ARCH back to what portage expects
1553set_arch_to_portage() {
1554 i=10
1555 while ((i--)) ; do
1556 ewarn "PLEASE UPDATE TO YOUR PACKAGE TO USE linux-info.eclass"
1557 done
1558 export ARCH="${EUTILS_ECLASS_PORTAGE_ARCH}"
1559}
1560
1561# Jeremy Huddleston <eradicator@gentoo.org>:
1562# preserve_old_lib /path/to/libblah.so.0
1563# preserve_old_lib_notify /path/to/libblah.so.0
1564#
1565# These functions are useful when a lib in your package changes --library. Such 1649# These functions are useful when a lib in your package changes ABI SONAME.
1566# an example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0 1650# An example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0
1567# would break packages that link against it. Most people get around this 1651# would break packages that link against it. Most people get around this
1568# by using the portage SLOT mechanism, but that is not always a relevant 1652# by using the portage SLOT mechanism, but that is not always a relevant
1569# solution, so instead you can add the following to your ebuilds: 1653# solution, so instead you can call this from pkg_preinst. See also the
1570# 1654# preserve_old_lib_notify function.
1571# pkg_preinst() {
1572# ...
1573# preserve_old_lib /usr/$(get_libdir)/libogg.so.0
1574# ...
1575# }
1576#
1577# pkg_postinst() {
1578# ...
1579# preserve_old_lib_notify /usr/$(get_libdir)/libogg.so.0
1580# ...
1581# }
1582
1583preserve_old_lib() { 1655preserve_old_lib() {
1584 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then 1656 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then
1585 eerror "preserve_old_lib() must be called from pkg_preinst() only" 1657 eerror "preserve_old_lib() must be called from pkg_preinst() only"
1586# die "Invalid preserve_old_lib() usage" 1658 die "Invalid preserve_old_lib() usage"
1587 fi 1659 fi
1588 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]" 1660 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]"
1661
1662 # let portage worry about it
1663 has preserve-libs ${FEATURES} && return 0
1589 1664
1590 local lib dir 1665 local lib dir
1591 for lib in "$@" ; do 1666 for lib in "$@" ; do
1592 [[ -e ${ROOT}/${lib} ]] || continue 1667 [[ -e ${ROOT}/${lib} ]] || continue
1593 dir=${lib%/*} 1668 dir=${lib%/*}
1595 cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed" 1670 cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed"
1596 touch "${D}"/${lib} 1671 touch "${D}"/${lib}
1597 done 1672 done
1598} 1673}
1599 1674
1675# @FUNCTION: preserve_old_lib_notify
1676# @USAGE: <libs to notify> [more libs]
1677# @DESCRIPTION:
1678# Spit helpful messages about the libraries preserved by preserve_old_lib.
1600preserve_old_lib_notify() { 1679preserve_old_lib_notify() {
1601 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then 1680 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then
1602 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only" 1681 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only"
1603# die "Invalid preserve_old_lib_notify() usage" 1682 die "Invalid preserve_old_lib_notify() usage"
1604 fi 1683 fi
1684
1685 # let portage worry about it
1686 has preserve-libs ${FEATURES} && return 0
1605 1687
1606 local lib notice=0 1688 local lib notice=0
1607 for lib in "$@" ; do 1689 for lib in "$@" ; do
1608 [[ -e ${ROOT}/${lib} ]] || continue 1690 [[ -e ${ROOT}/${lib} ]] || continue
1609 if [[ ${notice} -eq 0 ]] ; then 1691 if [[ ${notice} -eq 0 ]] ; then
1615 ewarn "helper program, simply emerge the 'gentoolkit' package." 1697 ewarn "helper program, simply emerge the 'gentoolkit' package."
1616 ewarn 1698 ewarn
1617 fi 1699 fi
1618 ewarn " # revdep-rebuild --library ${lib##*/}" 1700 ewarn " # revdep-rebuild --library ${lib##*/}"
1619 done 1701 done
1702 if [[ ${notice} -eq 1 ]] ; then
1703 ewarn
1704 ewarn "Once you've finished running revdep-rebuild, it should be safe to"
1705 ewarn "delete the old libraries. Here is a copy & paste for the lazy:"
1706 for lib in "$@" ; do
1707 ewarn " # rm '${lib}'"
1708 done
1709 fi
1620} 1710}
1621 1711
1622# Hack for people to figure out if a package was built with 1712# @FUNCTION: built_with_use
1623# certain USE flags
1624#
1625# Usage: built_with_use [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags> 1713# @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1626# ex: built_with_use xchat gtk2 1714# @DESCRIPTION:
1715# A temporary hack until portage properly supports DEPENDing on USE
1716# flags being enabled in packages. This will check to see if the specified
1717# DEPEND atom was built with the specified list of USE flags. The
1718# --missing option controls the behavior if called on a package that does
1719# not actually support the defined USE flags (aka listed in IUSE).
1720# The default is to abort (call die). The -a and -o flags control
1721# the requirements of the USE flags. They correspond to "and" and "or"
1722# logic. So the -a flag means all listed USE flags must be enabled
1723# while the -o flag means at least one of the listed IUSE flags must be
1724# enabled. The --hidden option is really for internal use only as it
1725# means the USE flag we're checking is hidden expanded, so it won't be found
1726# in IUSE like normal USE flags.
1627# 1727#
1628# Flags: -a all USE flags should be utilized 1728# Remember that this function isn't terribly intelligent so order of optional
1629# -o at least one USE flag should be utilized 1729# flags matter.
1630# --missing peform the specified action if the flag is not in IUSE (true/false/die)
1631# --hidden USE flag we're checking is hidden expanded so it isnt in IUSE
1632# Note: the default flag is '-a'
1633built_with_use() { 1730built_with_use() {
1634 local hidden="no" 1731 local hidden="no"
1635 if [[ $1 == "--hidden" ]] ; then 1732 if [[ $1 == "--hidden" ]] ; then
1636 hidden="yes" 1733 hidden="yes"
1637 shift 1734 shift
1666 die) die "Unable to determine what USE flags $PKG was built with";; 1763 die) die "Unable to determine what USE flags $PKG was built with";;
1667 esac 1764 esac
1668 fi 1765 fi
1669 1766
1670 if [[ ${hidden} == "no" ]] ; then 1767 if [[ ${hidden} == "no" ]] ; then
1671 local IUSE_BUILT=$(<${IUSEFILE}) 1768 local IUSE_BUILT=( $(<"${IUSEFILE}") )
1672 # Don't check USE_EXPAND #147237 1769 # Don't check USE_EXPAND #147237
1673 local expand 1770 local expand
1674 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do 1771 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do
1675 if [[ $1 == ${expand}_* ]] ; then 1772 if [[ $1 == ${expand}_* ]] ; then
1676 expand="" 1773 expand=""
1677 break 1774 break
1678 fi 1775 fi
1679 done 1776 done
1680 if [[ -n ${expand} ]] ; then 1777 if [[ -n ${expand} ]] ; then
1681 if ! has $1 ${IUSE_BUILT} ; then 1778 if ! has $1 ${IUSE_BUILT[@]#[-+]} ; then
1682 case ${missing_action} in 1779 case ${missing_action} in
1683 true) return 0;; 1780 true) return 0;;
1684 false) return 1;; 1781 false) return 1;;
1685 die) die "$PKG does not actually support the $1 USE flag!";; 1782 die) die "$PKG does not actually support the $1 USE flag!";;
1686 esac 1783 esac
1698 shift 1795 shift
1699 done 1796 done
1700 [[ ${opt} = "-a" ]] 1797 [[ ${opt} = "-a" ]]
1701} 1798}
1702 1799
1800# @FUNCTION: epunt_cxx
1801# @USAGE: [dir to scan]
1802# @DESCRIPTION:
1703# Many configure scripts wrongly bail when a C++ compiler 1803# Many configure scripts wrongly bail when a C++ compiler could not be
1704# could not be detected. #73450 1804# detected. If dir is not specified, then it defaults to ${S}.
1805#
1806# http://bugs.gentoo.org/73450
1705epunt_cxx() { 1807epunt_cxx() {
1706 local dir=$1 1808 local dir=$1
1707 [[ -z ${dir} ]] && dir=${S} 1809 [[ -z ${dir} ]] && dir=${S}
1708 ebegin "Removing useless C++ checks" 1810 ebegin "Removing useless C++ checks"
1709 local f 1811 local f
1710 for f in $(find ${dir} -name configure) ; do 1812 find "${dir}" -name configure | while read f ; do
1711 patch -p0 "${f}" "${PORTDIR}/eclass/ELT-patches/nocxx/nocxx.patch" > /dev/null 1813 patch --no-backup-if-mismatch -p0 "${f}" "${PORTDIR}/eclass/ELT-patches/nocxx/nocxx.patch" > /dev/null
1712 done 1814 done
1713 eend 0 1815 eend 0
1714} 1816}
1715 1817
1716# make a wrapper script ... 1818# @FUNCTION: make_wrapper
1717# NOTE: this was originally games_make_wrapper, but I noticed other places where 1819# @USAGE: <wrapper> <target> [chdir] [libpaths] [installpath]
1718# this could be used, so I have moved it here and made it not games-specific 1820# @DESCRIPTION:
1719# -- wolf31o2 1821# Create a shell wrapper script named wrapper in installpath
1720# $1 == wrapper name 1822# (defaults to the bindir) to execute target (default of wrapper) by
1721# $2 == binary to run 1823# first optionally setting LD_LIBRARY_PATH to the colon-delimited
1722# $3 == directory to chdir before running binary 1824# libpaths followed by optionally changing directory to chdir.
1723# $4 == extra LD_LIBRARY_PATH's (make it : delimited)
1724# $5 == path for wrapper
1725make_wrapper() { 1825make_wrapper() {
1726 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5 1826 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5
1727 local tmpwrapper=$(emktemp) 1827 local tmpwrapper=$(emktemp)
1728 # We don't want to quote ${bin} so that people can pass complex 1828 # We don't want to quote ${bin} so that people can pass complex
1729 # things as $bin ... "./someprog --args" 1829 # things as $bin ... "./someprog --args"
1739fi 1839fi
1740exec ${bin} "\$@" 1840exec ${bin} "\$@"
1741EOF 1841EOF
1742 chmod go+rx "${tmpwrapper}" 1842 chmod go+rx "${tmpwrapper}"
1743 if [[ -n ${path} ]] ; then 1843 if [[ -n ${path} ]] ; then
1844 (
1744 exeinto "${path}" 1845 exeinto "${path}"
1745 newexe "${tmpwrapper}" "${wrapper}" 1846 newexe "${tmpwrapper}" "${wrapper}"
1847 ) || die
1746 else 1848 else
1747 newbin "${tmpwrapper}" "${wrapper}" 1849 newbin "${tmpwrapper}" "${wrapper}" || die
1850 fi
1851}
1852
1853# @FUNCTION: prepalldocs
1854# @USAGE:
1855# @DESCRIPTION:
1856# Compress files in /usr/share/doc which are not already
1857# compressed, excluding /usr/share/doc/${PF}/html.
1858# Uses the ecompressdir to do the compression.
1859# 2009-02-18 by betelgeuse:
1860# Commented because ecompressdir is even more internal to
1861# Portage than prepalldocs (it's not even mentioned in man 5
1862# ebuild). Please submit a better version for review to gentoo-dev
1863# if you want prepalldocs here.
1864#prepalldocs() {
1865# if [[ -n $1 ]] ; then
1866# ewarn "prepalldocs: invalid usage; takes no arguments"
1748 fi 1867# fi
1749} 1868
1869# cd "${D}"
1870# [[ -d usr/share/doc ]] || return 0
1871
1872# find usr/share/doc -exec gzip {} +
1873# ecompressdir --ignore /usr/share/doc/${PF}/html
1874# ecompressdir --queue /usr/share/doc
1875#}

Legend:
Removed from v.1.275  
changed lines
  Added in v.1.319

  ViewVC Help
Powered by ViewVC 1.1.20