1 # Copyright 1999-2015 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
5 # @ECLASS: eutils.eclass
7 # base-system@gentoo.org
8 # @BLURB: many extra (but common) functions that are used in ebuilds
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.
15 # Due to the nature of this eclass, some functions may have maintainers
16 # different from the overall eclass!
18 if [[ -z ${_EUTILS_ECLASS} ]]; then
21 inherit multilib toolchain-funcs
23 if has "${EAPI:-0}" 0 1 2; then
28 # Sleep for the specified number of seconds (default of 5 seconds). Useful when
29 # printing a message the user should probably be reading and often used in
30 # conjunction with the ebeep function. If the EPAUSE_IGNORE env var is set,
31 # don't wait at all. Defined in EAPIs 0 1 and 2.
33 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5}
37 # @USAGE: [number of beeps]
39 # Issue the specified number of beeps (default of 5 beeps). Useful when
40 # printing a message the user should probably be reading and often used in
41 # conjunction with the epause function. If the EBEEP_IGNORE env var is set,
42 # don't beep at all. Defined in EAPIs 0 1 and 2.
45 if [[ -z ${EBEEP_IGNORE} ]] ; then
46 for ((n=1 ; n <= ${1:-5} ; n++)) ; do
48 sleep 0.1 &>/dev/null ; sleep 0,1 &>/dev/null
58 ewarn "QA Notice: ebeep is not defined in EAPI=${EAPI}, please file a bug at https://bugs.gentoo.org"
62 ewarn "QA Notice: epause is not defined in EAPI=${EAPI}, please file a bug at https://bugs.gentoo.org"
70 # Proxy to ewarn for package managers that don't provide eqawarn and use the PM
71 # implementation if available. Reuses PORTAGE_ELOG_CLASSES as set by the dev
73 if ! declare -F eqawarn >/dev/null ; then
75 has qa ${PORTAGE_ELOG_CLASSES} && ewarn "$@"
80 # @FUNCTION: ecvs_clean
81 # @USAGE: [list of dirs]
83 # Remove CVS directories recursiveley. Useful when a source tarball contains
84 # internal CVS directories. Defaults to $PWD.
86 [[ -z $* ]] && set -- .
87 find "$@" -type d -name 'CVS' -prune -print0 | xargs -0 rm -rf
88 find "$@" -type f -name '.cvs*' -print0 | xargs -0 rm -rf
91 # @FUNCTION: esvn_clean
92 # @USAGE: [list of dirs]
94 # Remove .svn directories recursiveley. Useful when a source tarball contains
95 # internal Subversion directories. Defaults to $PWD.
97 [[ -z $* ]] && set -- .
98 find "$@" -type d -name '.svn' -prune -print0 | xargs -0 rm -rf
101 # @FUNCTION: estack_push
102 # @USAGE: <stack> [items to push]
104 # Push any number of items onto the specified stack. Pick a name that
105 # is a valid variable (i.e. stick to alphanumerics), and push as many
106 # items as you like onto the stack at once.
108 # The following code snippet will echo 5, then 4, then 3, then ...
110 # estack_push mystack 1 2 3 4 5
111 # while estack_pop mystack i ; do
116 [[ $# -eq 0 ]] && die "estack_push: incorrect # of arguments"
117 local stack_name="_ESTACK_$1_" ; shift
118 eval ${stack_name}+=\( \"\$@\" \)
121 # @FUNCTION: estack_pop
122 # @USAGE: <stack> [variable]
124 # Pop a single item off the specified stack. If a variable is specified,
125 # the popped item is stored there. If no more items are available, return
126 # 1, else return 0. See estack_push for more info.
128 [[ $# -eq 0 || $# -gt 2 ]] && die "estack_pop: incorrect # of arguments"
130 # We use the fugly _estack_xxx var names to avoid collision with
131 # passing back the return value. If we used "local i" and the
132 # caller ran `estack_pop ... i`, we'd end up setting the local
133 # copy of "i" rather than the caller's copy. The _estack_xxx
134 # garbage is preferable to using $1/$2 everywhere as that is a
135 # bit harder to read.
136 local _estack_name="_ESTACK_$1_" ; shift
137 local _estack_retvar=$1 ; shift
138 eval local _estack_i=\${#${_estack_name}\[@\]}
139 # Don't warn -- let the caller interpret this as a failure
140 # or as normal behavior (akin to `shift`)
141 [[ $(( --_estack_i )) -eq -1 ]] && return 1
143 if [[ -n ${_estack_retvar} ]] ; then
144 eval ${_estack_retvar}=\"\${${_estack_name}\[${_estack_i}\]}\"
146 eval unset ${_estack_name}\[${_estack_i}\]
149 # @FUNCTION: evar_push
150 # @USAGE: <variable to save> [more vars to save]
152 # This let's you temporarily modify a variable and then restore it (including
153 # set vs unset semantics). Arrays are not supported at this time.
155 # This is meant for variables where using `local` does not work (such as
156 # exported variables, or only temporarily changing things in a func).
162 # ... do some stuff that needs LC_ALL=C set ...
165 # # You can also save/restore more than one var at a time
166 # evar_push BUTTERFLY IN THE SKY
167 # ... do stuff with the vars ...
168 # evar_pop # This restores just one var, SKY
169 # ... do more stuff ...
170 # evar_pop 3 # This pops the remaining 3 vars
175 [[ ${!var+set} == "set" ]] \
177 || val="unset_76fc3c462065bb4ca959f939e6793f94"
178 estack_push evar "${var}" "${val}"
182 # @FUNCTION: evar_push_set
183 # @USAGE: <variable to save> [new value to store]
185 # This is a handy shortcut to save and temporarily set a variable. If a value
186 # is not specified, the var will be unset.
192 2) printf -v "${var}" '%s' "$2" ;;
193 *) die "${FUNCNAME}: incorrect # of args: $*" ;;
197 # @FUNCTION: evar_pop
198 # @USAGE: [number of vars to restore]
200 # Restore the variables to the state saved with the corresponding
201 # evar_push call. See that function for more details.
206 1) isdigit "${cnt}" || die "${FUNCNAME}: first arg must be a number: $*" ;;
207 *) die "${FUNCNAME}: only accepts one arg: $*" ;;
211 while (( cnt-- )) ; do
212 estack_pop evar val || die "${FUNCNAME}: unbalanced push"
213 estack_pop evar var || die "${FUNCNAME}: unbalanced push"
214 [[ ${val} == "unset_76fc3c462065bb4ca959f939e6793f94" ]] \
216 || printf -v "${var}" '%s' "${val}"
220 # @FUNCTION: eshopts_push
221 # @USAGE: [options to `set` or `shopt`]
223 # Often times code will want to enable a shell option to change code behavior.
224 # Since changing shell options can easily break other pieces of code (which
225 # assume the default state), eshopts_push is used to (1) push the current shell
226 # options onto a stack and (2) pass the specified arguments to set.
228 # If the first argument is '-s' or '-u', we assume you want to call `shopt`
229 # rather than `set` as there are some options only available via that.
231 # A common example is to disable shell globbing so that special meaning/care
232 # may be used with variables/arguments to custom functions. That would be:
234 # eshopts_push -o noglob
235 # for x in ${foo} ; do
236 # if ...some check... ; then
244 if [[ $1 == -[su] ]] ; then
245 estack_push eshopts "$(shopt -p)"
246 [[ $# -eq 0 ]] && return 0
247 shopt "$@" || die "${FUNCNAME}: bad options to shopt: $*"
249 estack_push eshopts $-
250 [[ $# -eq 0 ]] && return 0
251 set "$@" || die "${FUNCNAME}: bad options to set: $*"
255 # @FUNCTION: eshopts_pop
258 # Restore the shell options to the state saved with the corresponding
259 # eshopts_push call. See that function for more details.
262 estack_pop eshopts s || die "${FUNCNAME}: unbalanced push"
263 if [[ ${s} == "shopt -"* ]] ; then
264 eval "${s}" || die "${FUNCNAME}: sanity: invalid shopt options: ${s}"
266 set +$- || die "${FUNCNAME}: sanity: invalid shell settings: $-"
267 set -${s} || die "${FUNCNAME}: sanity: unable to restore saved shell settings: ${s}"
271 # @FUNCTION: eumask_push
272 # @USAGE: <new umask>
274 # Set the umask to the new value specified while saving the previous
275 # value onto a stack. Useful for temporarily changing the umask.
277 estack_push eumask "$(umask)"
278 umask "$@" || die "${FUNCNAME}: bad options to umask: $*"
281 # @FUNCTION: eumask_pop
284 # Restore the previous umask state.
286 [[ $# -eq 0 ]] || die "${FUNCNAME}: we take no options"
288 estack_pop eumask s || die "${FUNCNAME}: unbalanced push"
289 umask ${s} || die "${FUNCNAME}: sanity: could not restore umask: ${s}"
293 # @USAGE: <number> [more numbers]
295 # Return true if all arguments are numbers.
299 [[ ${d:-bad} == *[!0-9]* ]] && return 1
304 # @VARIABLE: EPATCH_SOURCE
306 # Default directory to search for patches.
307 EPATCH_SOURCE="${WORKDIR}/patch"
308 # @VARIABLE: EPATCH_SUFFIX
310 # Default extension for patches (do not prefix the period yourself).
311 EPATCH_SUFFIX="patch.bz2"
312 # @VARIABLE: EPATCH_OPTS
314 # Options to pass to patch. Meant for ebuild/package-specific tweaking
315 # such as forcing the patch level (-p#) or fuzz (-F#) factor. Note that
316 # for single patch tweaking, you can also pass flags directly to epatch.
318 # @VARIABLE: EPATCH_COMMON_OPTS
320 # Common options to pass to `patch`. You probably should never need to
321 # change these. If you do, please discuss it with base-system first to
324 # -g0 - keep RCS, ClearCase, Perforce and SCCS happy #24571
325 # --no-backup-if-mismatch - do not leave .orig files behind
326 # -E - automatically remove empty files
328 EPATCH_COMMON_OPTS="-g0 -E --no-backup-if-mismatch"
329 # @VARIABLE: EPATCH_EXCLUDE
331 # List of patches not to apply. Note this is only file names,
332 # and not the full path. Globs accepted.
334 # @VARIABLE: EPATCH_SINGLE_MSG
336 # Change the printed message for a single patch.
338 # @VARIABLE: EPATCH_MULTI_MSG
340 # Change the printed message for multiple patches.
341 EPATCH_MULTI_MSG="Applying various patches (bugfixes/updates) ..."
342 # @VARIABLE: EPATCH_FORCE
344 # Only require patches to match EPATCH_SUFFIX rather than the extended
347 # @VARIABLE: EPATCH_USER_EXCLUDE
350 # List of patches not to apply. Note this is only file names,
351 # and not the full path. Globs accepted.
353 # @VARIABLE: EPATCH_USER_SOURCE
355 # Location for user patches, see the epatch_user function.
356 # Should be set by the user. Don't set this in ebuilds.
357 : ${EPATCH_USER_SOURCE:=${PORTAGE_CONFIGROOT%/}/etc/portage/patches}
360 # @USAGE: [options] [patches] [dirs of patches]
362 # epatch is designed to greatly simplify the application of patches. It can
363 # process patch files directly, or directories of patches. The patches may be
364 # compressed (bzip/gzip/etc...) or plain text. You generally need not specify
365 # the -p option as epatch will automatically attempt -p0 to -p4 until things
366 # apply successfully.
368 # If you do not specify any patches/dirs, then epatch will default to the
369 # directory specified by EPATCH_SOURCE.
371 # Any options specified that start with a dash will be passed down to patch
372 # for this specific invocation. As soon as an arg w/out a dash is found, then
373 # arg processing stops.
375 # When processing directories, epatch will apply all patches that match:
377 # if ${EPATCH_FORCE} != "yes"
378 # ??_${ARCH}_foo.${EPATCH_SUFFIX}
382 # The leading ?? are typically numbers used to force consistent patch ordering.
383 # The arch field is used to apply patches only for the host architecture with
384 # the special value of "all" means apply for everyone. Note that using values
385 # other than "all" is highly discouraged -- you should apply patches all the
386 # time and let architecture details be detected at configure/compile time.
388 # If EPATCH_SUFFIX is empty, then no period before it is implied when searching
389 # for patches to apply.
391 # Refer to the other EPATCH_xxx variables for more customization of behavior.
393 _epatch_draw_line() {
394 # create a line of same length as input string
395 [[ -z $1 ]] && set "$(printf "%65s" '')"
399 unset P4CONFIG P4PORT P4USER # keep perforce at bay #56402
401 # First process options. We localize the EPATCH_OPTS setting
402 # from above so that we can pass it on in the loop below with
403 # any additional values the user has specified.
404 local EPATCH_OPTS=( ${EPATCH_OPTS[*]} )
405 while [[ $# -gt 0 ]] ; do
407 -*) EPATCH_OPTS+=( "$1" ) ;;
413 # Let the rest of the code process one user arg at a time --
414 # each arg may expand into multiple patches, and each arg may
415 # need to start off with the default global EPATCH_xxx values
416 if [[ $# -gt 1 ]] ; then
424 local SINGLE_PATCH="no"
425 # no args means process ${EPATCH_SOURCE}
426 [[ $# -eq 0 ]] && set -- "${EPATCH_SOURCE}"
428 if [[ -f $1 ]] ; then
431 # Use the suffix from the single patch (localize it); the code
432 # below will find the suffix for us
433 local EPATCH_SUFFIX=$1
435 elif [[ -d $1 ]] ; then
436 # We have to force sorting to C so that the wildcard expansion is consistent #471666.
437 evar_push_set LC_COLLATE C
438 # Some people like to make dirs of patches w/out suffixes (vim).
439 set -- "$1"/*${EPATCH_SUFFIX:+."${EPATCH_SUFFIX}"}
442 elif [[ -f ${EPATCH_SOURCE}/$1 ]] ; then
443 # Re-use EPATCH_SOURCE as a search dir
444 epatch "${EPATCH_SOURCE}/$1"
448 # sanity check ... if it isn't a dir or file, wtf man ?
449 [[ $# -ne 0 ]] && EPATCH_SOURCE=$1
451 eerror "Cannot find \$EPATCH_SOURCE! Value for \$EPATCH_SOURCE is:"
453 eerror " ${EPATCH_SOURCE}"
454 eerror " ( ${EPATCH_SOURCE##*/} )"
456 die "Cannot find \$EPATCH_SOURCE!"
459 # Now that we know we're actually going to apply something, merge
460 # all of the patch options back in to a single variable for below.
461 EPATCH_OPTS="${EPATCH_COMMON_OPTS} ${EPATCH_OPTS[*]}"
464 case ${EPATCH_SUFFIX##*\.} in
465 xz) PIPE_CMD="xz -dc" ;;
466 lzma) PIPE_CMD="lzma -dc" ;;
467 bz2) PIPE_CMD="bzip2 -dc" ;;
468 gz|Z|z) PIPE_CMD="gzip -dc" ;;
469 ZIP|zip) PIPE_CMD="unzip -p" ;;
473 [[ ${SINGLE_PATCH} == "no" ]] && einfo "${EPATCH_MULTI_MSG}"
477 # If the patch dir given contains subdirs, or our EPATCH_SUFFIX
478 # didn't match anything, ignore continue on
479 [[ ! -f ${x} ]] && continue
481 local patchname=${x##*/}
483 # Apply single patches, or forced sets of patches, or
484 # patches with ARCH dependant names.
486 # Else, skip this input altogether
487 local a=${patchname#*_} # strip the ???_
488 a=${a%%_*} # strip the _foo.patch
489 if ! [[ ${SINGLE_PATCH} == "yes" || \
490 ${EPATCH_FORCE} == "yes" || \
497 # Let people filter things dynamically
498 if [[ -n ${EPATCH_EXCLUDE}${EPATCH_USER_EXCLUDE} ]] ; then
499 # let people use globs in the exclude
500 eshopts_push -o noglob
503 for ex in ${EPATCH_EXCLUDE} ; do
504 if [[ ${patchname} == ${ex} ]] ; then
505 einfo " Skipping ${patchname} due to EPATCH_EXCLUDE ..."
511 for ex in ${EPATCH_USER_EXCLUDE} ; do
512 if [[ ${patchname} == ${ex} ]] ; then
513 einfo " Skipping ${patchname} due to EPATCH_USER_EXCLUDE ..."
522 if [[ ${SINGLE_PATCH} == "yes" ]] ; then
523 if [[ -n ${EPATCH_SINGLE_MSG} ]] ; then
524 einfo "${EPATCH_SINGLE_MSG}"
526 einfo "Applying ${patchname} ..."
529 einfo " ${patchname} ..."
532 # Handle aliased patch command #404447 #461568
534 eval $(alias patch 2>/dev/null | sed 's:^alias ::')
536 # most of the time, there will only be one run per unique name,
537 # but if there are more, make sure we get unique log filenames
538 local STDERR_TARGET="${T}/${patchname}.out"
539 if [[ -e ${STDERR_TARGET} ]] ; then
540 STDERR_TARGET="${T}/${patchname}-$$.out"
543 printf "***** %s *****\nPWD: %s\nPATCH TOOL: %s -> %s\nVERSION INFO:\n%s\n\n" \
547 "$(type -P "${patch}")" \
548 "$(${patch} --version)" \
551 # Decompress the patch if need be
554 if [[ -n ${PIPE_CMD} ]] ; then
555 PATCH_TARGET="${T}/$$.patch"
556 echo "PIPE_COMMAND: ${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> "${STDERR_TARGET}"
558 if ! (${PIPE_CMD} "${x}" > "${PATCH_TARGET}") >> "${STDERR_TARGET}" 2>&1 ; then
560 eerror "Could not extract patch!"
561 #die "Could not extract patch!"
569 # Check for absolute paths in patches. If sandbox is disabled,
570 # people could (accidently) patch files in the root filesystem.
571 # Or trigger other unpleasantries #237667. So disallow -p0 on
573 local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }')
574 if [[ -n ${abs_paths} ]] ; then
576 printf "NOTE: skipping -p0 due to absolute paths in patch:\n%s\n" "${abs_paths}" >> "${STDERR_TARGET}"
578 # Similar reason, but with relative paths.
579 local rel_paths=$(egrep -n '^[-+]{3} [^ ]*[.][.]/' "${PATCH_TARGET}")
580 if [[ -n ${rel_paths} ]] ; then
582 eerror "Rejected Patch: ${patchname} !"
583 eerror " ( ${PATCH_TARGET} )"
585 eerror "Your patch uses relative paths '../':"
586 eerror "${rel_paths}"
588 die "you need to fix the relative paths in patch"
591 # Dynamically detect the correct -p# ... i'm lazy, so shoot me :/
593 while [[ ${count} -lt 5 ]] ; do
594 patch_cmd="${patch} -p${count} ${EPATCH_OPTS}"
596 # Generate some useful debug info ...
598 _epatch_draw_line "***** ${patchname} *****"
600 echo "PATCH COMMAND: ${patch_cmd} --dry-run -f < '${PATCH_TARGET}'"
602 _epatch_draw_line "***** ${patchname} *****"
603 ${patch_cmd} --dry-run -f < "${PATCH_TARGET}" 2>&1
606 echo "patch program exited with status ${ret}"
608 ) >> "${STDERR_TARGET}"
610 if [ $? -eq 0 ] ; then
612 _epatch_draw_line "***** ${patchname} *****"
614 echo "ACTUALLY APPLYING ${patchname} ..."
615 echo "PATCH COMMAND: ${patch_cmd} < '${PATCH_TARGET}'"
617 _epatch_draw_line "***** ${patchname} *****"
618 ${patch_cmd} < "${PATCH_TARGET}" 2>&1
621 echo "patch program exited with status ${ret}"
623 ) >> "${STDERR_TARGET}"
625 if [ $? -ne 0 ] ; then
627 eerror "A dry-run of patch command succeeded, but actually"
628 eerror "applying the patch failed!"
629 #die "Real world sux compared to the dreamworld!"
638 # if we had to decompress the patch, delete the temp one
639 if [[ -n ${PIPE_CMD} ]] ; then
640 rm -f "${PATCH_TARGET}"
643 if [[ ${count} -ge 5 ]] ; then
645 eerror "Failed Patch: ${patchname} !"
646 eerror " ( ${PATCH_TARGET} )"
648 eerror "Include in your bugreport the contents of:"
650 eerror " ${STDERR_TARGET}"
652 die "Failed Patch: ${patchname}!"
655 # if everything worked, delete the full debug patch log
656 rm -f "${STDERR_TARGET}"
658 # then log away the exact stuff for people to review later
659 cat <<-EOF >> "${T}/epatch.log"
668 [[ ${SINGLE_PATCH} == "no" ]] && einfo "Done with patching"
669 : # everything worked
672 # @FUNCTION: epatch_user
675 # Applies user-provided patches to the source tree. The patches are
676 # taken from /etc/portage/patches/<CATEGORY>/<P-PR|P|PN>[:SLOT]/, where the first
677 # of these three directories to exist will be the one to use, ignoring
678 # any more general directories which might exist as well. They must end
679 # in ".patch" to be applied.
681 # User patches are intended for quick testing of patches without ebuild
682 # modifications, as well as for permanent customizations a user might
683 # desire. Obviously, there can be no official support for arbitrarily
684 # patched ebuilds. So whenever a build log in a bug report mentions that
685 # user patches were applied, the user should be asked to reproduce the
686 # problem without these.
688 # Not all ebuilds do call this function, so placing patches in the
689 # stated directory might or might not work, depending on the package and
690 # the eclasses it inherits and uses. It is safe to call the function
691 # repeatedly, so it is always possible to add a call at the ebuild
692 # level. The first call is the time when the patches will be
695 # Ideally, this function should be called after gentoo-specific patches
696 # have been applied, so that their code can be modified as well, but
697 # before calls to e.g. eautoreconf, as the user patches might affect
698 # autotool input files as well.
700 [[ $# -ne 0 ]] && die "epatch_user takes no options"
702 # Allow multiple calls to this function; ignore all but the first
703 local applied="${T}/epatch_user.log"
704 [[ -e ${applied} ]] && return 2
706 # don't clobber any EPATCH vars that the parent might want
707 local EPATCH_SOURCE check
708 for check in ${CATEGORY}/{${P}-${PR},${P},${PN}}{,:${SLOT}}; do
709 EPATCH_SOURCE=${EPATCH_USER_SOURCE}/${CTARGET}/${check}
710 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${EPATCH_USER_SOURCE}/${CHOST}/${check}
711 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${EPATCH_USER_SOURCE}/${check}
712 if [[ -d ${EPATCH_SOURCE} ]] ; then
713 EPATCH_SOURCE=${EPATCH_SOURCE} \
714 EPATCH_SUFFIX="patch" \
716 EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \
718 echo "${EPATCH_SOURCE}" > "${applied}"
719 has epatch_user_death_notice ${EBUILD_DEATH_HOOKS} || EBUILD_DEATH_HOOKS+=" epatch_user_death_notice"
723 echo "none" > "${applied}"
726 # @FUNCTION: epatch_user_death_notice
729 # Include an explicit notice in the die message itself that user patches were
730 # applied to this build.
731 epatch_user_death_notice() {
732 ewarn "!!! User patches were applied to this build!"
738 # Cheap replacement for when debianutils (and thus mktemp)
739 # does not exist on the users system.
742 [[ $1 == -d ]] && exe="mkdir" && shift
745 if [[ -z ${topdir} ]] ; then
751 if ! type -P mktemp > /dev/null ; then
752 # system lacks `mktemp` so we have to fake it
754 while [[ -e ${tmp} ]] ; do
755 tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM}
757 ${exe} "${tmp}" || ${exe} -p "${tmp}"
760 # the args here will give slightly wierd names on BSD,
761 # but should produce a usable file on all userlands
762 if [[ ${exe} == "touch" ]] ; then
763 TMPDIR="${topdir}" mktemp -t tmp.XXXXXXXXXX
765 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
770 # @FUNCTION: edos2unix
771 # @USAGE: <file> [more files ...]
773 # A handy replacement for dos2unix, recode, fixdos, etc... This allows you
774 # to remove all of these text utilities from DEPEND variables because this
775 # is a script based solution. Just give it a list of files to convert and
776 # they will all be changed from the DOS CRLF format to the UNIX LF format.
778 [[ $# -eq 0 ]] && return 0
779 sed -i 's/\r$//' -- "$@" || die
782 # @FUNCTION: make_desktop_entry
783 # @USAGE: make_desktop_entry(<command>, [name], [icon], [type], [fields])
785 # Make a .desktop file.
788 # binary: what command does the app run with ?
789 # name: the name that will show up in the menu
790 # icon: the icon to use in the menu entry
791 # this can be relative (to /usr/share/pixmaps) or
792 # a full path to an icon
793 # type: what kind of application is this?
795 # http://standards.freedesktop.org/menu-spec/latest/apa.html
796 # if unset, function tries to guess from package's category
797 # fields: extra fields to append to the desktop file; a printf string
799 make_desktop_entry() {
800 [[ -z $1 ]] && die "make_desktop_entry: You must specify the executable"
803 local name=${2:-${PN}}
804 local icon=${3:-${PN}}
808 if [[ -z ${type} ]] ; then
809 local catmaj=${CATEGORY%%-*}
810 local catmin=${CATEGORY##*-}
814 accessibility) type="Utility;Accessibility";;
816 antivirus) type=System;;
817 arch) type="Utility;Archiving";;
818 backup) type="Utility;Archiving";;
819 cdr) type="AudioVideo;DiscBurning";;
820 dicts) type="Office;Dictionary";;
821 doc) type=Documentation;;
822 editors) type="Utility;TextEditor";;
823 emacs) type="Development;TextEditor";;
824 emulation) type="System;Emulator";;
825 laptop) type="Settings;HardwareSettings";;
826 office) type=Office;;
827 pda) type="Office;PDA";;
828 vim) type="Development;TextEditor";;
829 xemacs) type="Development;TextEditor";;
839 action|fps) type=ActionGame;;
840 arcade) type=ArcadeGame;;
841 board) type=BoardGame;;
842 emulation) type=Emulator;;
843 kids) type=KidsGame;;
844 puzzle) type=LogicGame;;
845 roguelike) type=RolePlaying;;
846 rpg) type=RolePlaying;;
847 simulation) type=Simulation;;
848 sports) type=SportsGame;;
849 strategy) type=StrategyGame;;
878 type="AudioVideo;${type}"
885 dialup) type=Dialup;;
886 ftp) type=FileTransfer;;
887 im) type=InstantMessaging;;
888 irc) type=IRCClient;;
892 p2p) type=FileTransfer;;
893 voip) type=Telephony;;
895 type="Network;${type}"
900 astro*) type=Astronomy;;
902 calc*) type=Calculator;;
903 chem*) type=Chemistry;;
904 elec*) type=Electronics;;
907 physics) type=Physics;;
908 visual*) type=DataVisualization;;
910 type="Education;Science;${type}"
919 client) type=WebBrowser;;
921 type="Network;${type}"
929 local slot=${SLOT%/*}
930 if [[ ${slot} == "0" ]] ; then
931 local desktop_name="${PN}"
933 local desktop_name="${PN}-${slot}"
935 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop"
936 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop
938 # Don't append another ";" when a valid category value is provided.
939 type=${type%;}${type:+;}
941 eshopts_push -s extglob
942 if [[ -n ${icon} && ${icon} != /* ]] && [[ ${icon} == *.xpm || ${icon} == *.png || ${icon} == *.svg ]]; then
943 ewarn "As described in the Icon Theme Specification, icon file extensions are not"
944 ewarn "allowed in .desktop files if the value is not an absolute path."
945 icon=${icon%.@(xpm|png|svg)}
949 cat <<-EOF > "${desktop}"
953 Comment=${DESCRIPTION}
960 if [[ ${fields:-=} != *=* ]] ; then
961 # 5th arg used to be value to Path=
962 ewarn "make_desktop_entry: update your 5th arg to read Path=${fields}"
963 fields="Path=${fields}"
965 [[ -n ${fields} ]] && printf '%b\n' "${fields}" >> "${desktop}"
968 # wrap the env here so that the 'insinto' call
969 # doesn't corrupt the env of the caller
970 insinto /usr/share/applications
972 ) || die "installing desktop file failed"
975 # @FUNCTION: _eutils_eprefix_init
978 # Initialized prefix variables for EAPI<3.
979 _eutils_eprefix_init() {
980 has "${EAPI:-0}" 0 1 2 && : ${ED:=${D}} ${EPREFIX:=} ${EROOT:=${ROOT}}
983 # @FUNCTION: validate_desktop_entries
984 # @USAGE: [directories]
986 # Carsten Lohrke <carlo@gentoo.org>
988 # Validate desktop entries using desktop-file-utils
989 validate_desktop_entries() {
991 if [[ -x "${EPREFIX}"/usr/bin/desktop-file-validate ]] ; then
992 einfo "Checking desktop entry validity"
994 for d in /usr/share/applications $@ ; do
995 [[ -d ${ED}${d} ]] && directories="${directories} ${ED}${d}"
997 if [[ -n ${directories} ]] ; then
998 for FILE in $(find ${directories} -name "*\.desktop" \
999 -not -path '*.hidden*' | sort -u 2>/dev/null)
1001 local temp=$(desktop-file-validate ${FILE} | grep -v "warning:" | \
1002 sed -e "s|error: ||" -e "s|${FILE}:|--|g" )
1003 [[ -n $temp ]] && elog ${temp/--/${FILE/${ED}/}:}
1008 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo."
1012 # @FUNCTION: make_session_desktop
1013 # @USAGE: <title> <command> [command args...]
1015 # Make a GDM/KDM Session file. The title is the file to execute to start the
1016 # Window Manager. The command is the name of the Window Manager.
1018 # You can set the name of the file via the ${wm} variable.
1019 make_session_desktop() {
1020 [[ -z $1 ]] && eerror "$0: You must specify the title" && return 1
1021 [[ -z $2 ]] && eerror "$0: You must specify the command" && return 1
1025 local desktop=${T}/${wm:-${PN}}.desktop
1028 cat <<-EOF > "${desktop}"
1031 Comment=This session logs you into ${title}
1038 # wrap the env here so that the 'insinto' call
1039 # doesn't corrupt the env of the caller
1040 insinto /usr/share/xsessions
1048 # Install the list of .desktop menu files into the appropriate directory
1049 # (/usr/share/applications).
1052 # wrap the env here so that the 'insinto' call
1053 # doesn't corrupt the env of the caller
1055 insinto /usr/share/applications
1057 if [[ -f ${i} ]] ; then
1060 elif [[ -d ${i} ]] ; then
1061 for j in "${i}"/*.desktop ; do
1073 # @FUNCTION: newmenu
1074 # @USAGE: <menu> <newname>
1076 # Like all other new* functions, install the specified menu as newname.
1079 # wrap the env here so that the 'insinto' call
1080 # doesn't corrupt the env of the caller
1081 insinto /usr/share/applications
1086 # @FUNCTION: _iconins
1089 # function for use in doicon and newicon
1092 # wrap the env here so that the 'insinto' call
1093 # doesn't corrupt the env of the caller
1094 local funcname=$1; shift
1099 while [[ $# -gt 0 ]] ; do
1102 if [[ ${2%%x*}x${2%%x*} == "$2" ]] ; then
1108 16|22|24|32|36|48|64|72|96|128|192|256|512)
1109 size=${size}x${size};;
1113 eerror "${size} is an unsupported icon size!"
1124 if [[ -z ${size} ]] ; then
1125 insinto /usr/share/pixmaps
1127 insinto /usr/share/icons/${theme}/${size}/${context}
1130 if [[ ${funcname} == doicon ]] ; then
1131 if [[ -f $1 ]] ; then
1133 elif [[ -d $1 ]] ; then
1135 doins "${1}"/*.{png,svg}
1138 eerror "${1} is not a valid file/directory!"
1147 if [[ ${funcname} == newicon ]] ; then
1154 # @USAGE: [options] <icons>
1156 # Install icon into the icon directory /usr/share/icons or into
1157 # /usr/share/pixmaps if "--size" is not set.
1158 # This is useful in conjunction with creating desktop/menu files.
1163 # !!! must specify to install into /usr/share/icons/... !!!
1164 # size of the icon, like 48 or 48x48
1165 # supported icon sizes are:
1166 # 16 22 24 32 36 48 64 72 96 128 192 256 scalable
1168 # defaults to "apps"
1170 # defaults to "hicolor"
1172 # icons: list of icons
1174 # example 1: doicon foobar.png fuqbar.svg suckbar.png
1175 # results in: insinto /usr/share/pixmaps
1176 # doins foobar.png fuqbar.svg suckbar.png
1178 # example 2: doicon -s 48 foobar.png fuqbar.png blobbar.png
1179 # results in: insinto /usr/share/icons/hicolor/48x48/apps
1180 # doins foobar.png fuqbar.png blobbar.png
1183 _iconins ${FUNCNAME} "$@"
1186 # @FUNCTION: newicon
1187 # @USAGE: [options] <icon> <newname>
1189 # Like doicon, install the specified icon as newname.
1192 # example 1: newicon foobar.png NEWNAME.png
1193 # results in: insinto /usr/share/pixmaps
1194 # newins foobar.png NEWNAME.png
1196 # example 2: newicon -s 48 foobar.png NEWNAME.png
1197 # results in: insinto /usr/share/icons/hicolor/48x48/apps
1198 # newins foobar.png NEWNAME.png
1201 _iconins ${FUNCNAME} "$@"
1204 # @FUNCTION: strip-linguas
1205 # @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
1207 # Make sure that LINGUAS only contains languages that
1208 # a package can support. The first form allows you to
1209 # specify a list of LINGUAS. The -i builds a list of po
1210 # files found in all the directories and uses the
1211 # intersection of the lists. The -u builds a list of po
1212 # files found in all the directories and uses the union
1216 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then
1218 ls=$(find "$1" -name '*.po' -exec basename {} .po ';'); shift
1221 if [[ ${op} == "-u" ]] ; then
1226 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1227 if [[ ${op} == "-i" ]] ; then
1228 has ${f} ${ls} && newls="${newls} ${f}"
1230 has ${f} ${ls} || newls="${newls} ${f}"
1241 for f in ${LINGUAS} ; do
1242 if has ${f} ${ls} ; then
1243 newls="${newls} ${f}"
1249 && einfo "Sorry, but ${PN} does not support the LINGUAS:" ${nols}
1250 export LINGUAS=${newls:1}
1253 # @FUNCTION: preserve_old_lib
1254 # @USAGE: <libs to preserve> [more libs]
1256 # These functions are useful when a lib in your package changes ABI SONAME.
1257 # An example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0
1258 # would break packages that link against it. Most people get around this
1259 # by using the portage SLOT mechanism, but that is not always a relevant
1260 # solution, so instead you can call this from pkg_preinst. See also the
1261 # preserve_old_lib_notify function.
1262 preserve_old_lib() {
1263 _eutils_eprefix_init
1264 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then
1265 eerror "preserve_old_lib() must be called from pkg_preinst() only"
1266 die "Invalid preserve_old_lib() usage"
1268 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]"
1270 # let portage worry about it
1271 has preserve-libs ${FEATURES} && return 0
1274 for lib in "$@" ; do
1275 [[ -e ${EROOT}/${lib} ]] || continue
1277 dodir ${dir} || die "dodir ${dir} failed"
1278 cp "${EROOT}"/${lib} "${ED}"/${lib} || die "cp ${lib} failed"
1279 touch "${ED}"/${lib}
1283 # @FUNCTION: preserve_old_lib_notify
1284 # @USAGE: <libs to notify> [more libs]
1286 # Spit helpful messages about the libraries preserved by preserve_old_lib.
1287 preserve_old_lib_notify() {
1288 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then
1289 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only"
1290 die "Invalid preserve_old_lib_notify() usage"
1293 # let portage worry about it
1294 has preserve-libs ${FEATURES} && return 0
1296 _eutils_eprefix_init
1299 for lib in "$@" ; do
1300 [[ -e ${EROOT}/${lib} ]] || continue
1301 if [[ ${notice} -eq 0 ]] ; then
1303 ewarn "Old versions of installed libraries were detected on your system."
1304 ewarn "In order to avoid breaking packages that depend on these old libs,"
1305 ewarn "the libraries are not being removed. You need to run revdep-rebuild"
1306 ewarn "in order to remove these old dependencies. If you do not have this"
1307 ewarn "helper program, simply emerge the 'gentoolkit' package."
1310 ewarn " # revdep-rebuild --library '${lib}' && rm '${lib}'"
1314 # @FUNCTION: built_with_use
1315 # @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1318 # Deprecated: Use EAPI 2 use deps in DEPEND|RDEPEND and with has_version calls.
1320 # A temporary hack until portage properly supports DEPENDing on USE
1321 # flags being enabled in packages. This will check to see if the specified
1322 # DEPEND atom was built with the specified list of USE flags. The
1323 # --missing option controls the behavior if called on a package that does
1324 # not actually support the defined USE flags (aka listed in IUSE).
1325 # The default is to abort (call die). The -a and -o flags control
1326 # the requirements of the USE flags. They correspond to "and" and "or"
1327 # logic. So the -a flag means all listed USE flags must be enabled
1328 # while the -o flag means at least one of the listed IUSE flags must be
1329 # enabled. The --hidden option is really for internal use only as it
1330 # means the USE flag we're checking is hidden expanded, so it won't be found
1331 # in IUSE like normal USE flags.
1333 # Remember that this function isn't terribly intelligent so order of optional
1336 _eutils_eprefix_init
1338 if [[ $1 == "--hidden" ]] ; then
1343 local missing_action="die"
1344 if [[ $1 == "--missing" ]] ; then
1347 case ${missing_action} in
1349 *) die "unknown action '${missing_action}'";;
1354 [[ ${opt:0:1} = "-" ]] && shift || opt="-a"
1356 local PKG=$(best_version $1)
1357 [[ -z ${PKG} ]] && die "Unable to resolve $1 to an installed package"
1360 local USEFILE=${EROOT}/var/db/pkg/${PKG}/USE
1361 local IUSEFILE=${EROOT}/var/db/pkg/${PKG}/IUSE
1363 # if the IUSE file doesn't exist, the read will error out, we need to handle
1365 if [[ ! -e ${USEFILE} ]] || [[ ! -e ${IUSEFILE} && ${hidden} == "no" ]] ; then
1366 case ${missing_action} in
1369 die) die "Unable to determine what USE flags $PKG was built with";;
1373 if [[ ${hidden} == "no" ]] ; then
1374 local IUSE_BUILT=( $(<"${IUSEFILE}") )
1375 # Don't check USE_EXPAND #147237
1377 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do
1378 if [[ $1 == ${expand}_* ]] ; then
1383 if [[ -n ${expand} ]] ; then
1384 if ! has $1 ${IUSE_BUILT[@]#[-+]} ; then
1385 case ${missing_action} in
1388 die) die "$PKG does not actually support the $1 USE flag!";;
1394 local USE_BUILT=$(<${USEFILE})
1395 while [[ $# -gt 0 ]] ; do
1396 if [[ ${opt} = "-o" ]] ; then
1397 has $1 ${USE_BUILT} && return 0
1399 has $1 ${USE_BUILT} || return 1
1406 # @FUNCTION: epunt_cxx
1407 # @USAGE: [dir to scan]
1409 # Many configure scripts wrongly bail when a C++ compiler could not be
1410 # detected. If dir is not specified, then it defaults to ${S}.
1412 # https://bugs.gentoo.org/73450
1415 [[ -z ${dir} ]] && dir=${S}
1416 ebegin "Removing useless C++ checks"
1418 while IFS= read -r -d '' f; do
1419 for p in "${PORTDIR}"/eclass/ELT-patches/nocxx/*.patch ; do
1420 if patch --no-backup-if-mismatch -p1 "${f}" "${p}" >/dev/null ; then
1425 done < <(find "${dir}" -name configure -print0)
1427 if [[ -z ${any_found} ]]; then
1428 eqawarn "epunt_cxx called unnecessarily (no C++ checks to punt)."
1433 # @FUNCTION: make_wrapper
1434 # @USAGE: <wrapper> <target> [chdir] [libpaths] [installpath]
1436 # Create a shell wrapper script named wrapper in installpath
1437 # (defaults to the bindir) to execute target (default of wrapper) by
1438 # first optionally setting LD_LIBRARY_PATH to the colon-delimited
1439 # libpaths followed by optionally changing directory to chdir.
1441 _eutils_eprefix_init
1442 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5
1443 local tmpwrapper=$(emktemp)
1447 [[ -n ${chdir} ]] && printf 'cd "%s"\n' "${EPREFIX}${chdir}"
1448 if [[ -n ${libdir} ]] ; then
1450 if [[ ${CHOST} == *-darwin* ]] ; then
1451 var=DYLD_LIBRARY_PATH
1456 if [ "\${${var}+set}" = "set" ] ; then
1457 export ${var}="\${${var}}:${EPREFIX}${libdir}"
1459 export ${var}="${EPREFIX}${libdir}"
1463 # We don't want to quote ${bin} so that people can pass complex
1464 # things as ${bin} ... "./someprog --args"
1465 printf 'exec %s "$@"\n' "${bin/#\//${EPREFIX}/}"
1467 chmod go+rx "${tmpwrapper}"
1469 if [[ -n ${path} ]] ; then
1472 newexe "${tmpwrapper}" "${wrapper}"
1475 newbin "${tmpwrapper}" "${wrapper}" || die
1479 # @FUNCTION: path_exists
1480 # @USAGE: [-a|-o] <paths>
1482 # Check if the specified paths exist. Works for all types of paths
1483 # (files/dirs/etc...). The -a and -o flags control the requirements
1484 # of the paths. They correspond to "and" and "or" logic. So the -a
1485 # flag means all the paths must exist while the -o flag means at least
1486 # one of the paths must exist. The default behavior is "and". If no
1487 # paths are specified, then the return value is "false".
1490 [[ ${opt} == -[ao] ]] && shift || opt="-a"
1492 # no paths -> return false
1493 # same behavior as: [[ -e "" ]]
1494 [[ $# -eq 0 ]] && return 1
1503 -a) return $(( r != 0 )) ;;
1504 -o) return $(( r == $# )) ;;
1508 # @FUNCTION: in_iuse
1511 # Determines whether the given flag is in IUSE. Strips IUSE default prefixes
1514 # Note that this function should not be used in the global scope.
1515 if has "${EAPI:-0}" 0 1 2 3 4 5; then
1517 debug-print-function ${FUNCNAME} "${@}"
1518 [[ ${#} -eq 1 ]] || die "Invalid args to ${FUNCNAME}()"
1521 local liuse=( ${IUSE} )
1523 has "${flag}" "${liuse[@]#[+-]}"
1527 # @FUNCTION: use_if_iuse
1530 # Return true if the given flag is in USE and IUSE.
1532 # Note that this function should not be used in the global scope.
1534 in_iuse $1 || return 1
1539 # @USAGE: <USE flag> [true output] [false output] [true suffix] [false suffix]
1541 # Proxy to declare usex for package managers or EAPIs that do not provide it
1542 # and use the package manager implementation when available (i.e. EAPI >= 5).
1543 # If USE flag is set, echo [true output][true suffix] (defaults to "yes"),
1544 # otherwise echo [false output][false suffix] (defaults to "no").
1545 if has "${EAPI:-0}" 0 1 2 3 4; then
1546 usex() { use "$1" && echo "${2-yes}$4" || echo "${3-no}$5" ; } #382963
1549 # @FUNCTION: prune_libtool_files
1550 # @USAGE: [--all|--modules]
1552 # Locate unnecessary libtool files (.la) and libtool static archives
1553 # (.a) and remove them from installation image.
1555 # By default, .la files are removed whenever the static linkage can
1556 # either be performed using pkg-config or doesn't introduce additional
1559 # If '--modules' argument is passed, .la files for modules (plugins) are
1560 # removed as well. This is usually useful when the package installs
1561 # plugins and the plugin loader does not use .la files.
1563 # If '--all' argument is passed, all .la files are removed without
1564 # performing any heuristic on them. You shouldn't ever use that,
1565 # and instead report a bug in the algorithm instead.
1567 # The .a files are only removed whenever corresponding .la files state
1568 # that they should not be linked to, i.e. whenever these files
1569 # correspond to plugins.
1571 # Note: if your package installs both static libraries and .pc files
1572 # which use variable substitution for -l flags, you need to add
1573 # pkg-config to your DEPEND.
1574 prune_libtool_files() {
1575 debug-print-function ${FUNCNAME} "$@"
1577 local removing_all removing_modules opt
1578 _eutils_eprefix_init
1589 die "Invalid argument to ${FUNCNAME}(): ${opt}"
1595 while IFS= read -r -d '' f; do # for all .la files
1596 local archivefile=${f/%.la/.a}
1598 # The following check is done by libtool itself.
1599 # It helps us avoid removing random files which match '*.la',
1601 if ! sed -n -e '/^# Generated by .*libtool/q0;4q1' "${f}"; then
1605 [[ ${f} != ${archivefile} ]] || die 'regex sanity check failed'
1606 local reason= pkgconfig_scanned=
1607 local snotlink=$(sed -n -e 's:^shouldnotlink=::p' "${f}")
1609 if [[ ${snotlink} == yes ]]; then
1611 # Remove static libs we're not supposed to link against.
1612 if [[ -f ${archivefile} ]]; then
1613 einfo "Removing unnecessary ${archivefile#${D%/}} (static plugin)"
1614 queue+=( "${archivefile}" )
1617 # The .la file may be used by a module loader, so avoid removing it
1618 # unless explicitly requested.
1619 if [[ ${removing_modules} ]]; then
1625 # Remove .la files when:
1626 # - user explicitly wants us to remove all .la files,
1627 # - respective static archive doesn't exist,
1628 # - they are covered by a .pc file already,
1629 # - they don't provide any new information (no libs & no flags).
1631 if [[ ${removing_all} ]]; then
1633 elif [[ ! -f ${archivefile} ]]; then
1634 reason='no static archive'
1635 elif [[ ! $(sed -nre \
1636 "s/^(dependency_libs|inherited_linker_flags)='(.*)'$/\2/p" \
1638 reason='no libs & flags'
1640 if [[ ! ${pkgconfig_scanned} ]]; then
1641 # Create a list of all .pc-covered libs.
1643 if [[ ! ${removing_all} ]]; then
1645 local tf=${T}/prune-lt-files.pc
1646 local pkgconf=$(tc-getPKG_CONFIG)
1648 while IFS= read -r -d '' pc; do # for all .pc files
1651 # Use pkg-config if available (and works),
1653 if ${pkgconf} --exists "${pc}" &>/dev/null; then
1654 sed -e '/^Requires:/d' "${pc}" > "${tf}"
1655 libs=$(${pkgconf} --libs "${tf}")
1657 libs=$(sed -ne 's/^Libs://p' "${pc}")
1660 for arg in ${libs}; do
1661 if [[ ${arg} == -l* ]]; then
1662 if [[ ${arg} == '*$*' ]]; then
1663 eqawarn "${FUNCNAME}: variable substitution likely failed in ${pc}"
1664 eqawarn "(arg: ${arg})"
1665 eqawarn "Most likely, you need to add virtual/pkgconfig to DEPEND."
1668 pc_libs+=( lib${arg#-l}.la )
1671 done < <(find "${D}" -type f -name '*.pc' -print0)
1677 fi # pkgconfig_scanned
1679 has "${f##*/}" "${pc_libs[@]}" && reason='covered by .pc'
1680 fi # removal due to .pc
1682 fi # shouldnotlink==no
1684 if [[ ${reason} ]]; then
1685 einfo "Removing unnecessary ${f#${D%/}} (${reason})"
1688 done < <(find "${ED}" -xtype f -name '*.la' -print0)
1690 if [[ ${queue[@]} ]]; then
1695 # @FUNCTION: einstalldocs
1697 # Install documentation using DOCS and HTML_DOCS.
1699 # If DOCS is declared and non-empty, all files listed in it are
1700 # installed. The files must exist, otherwise the function will fail.
1701 # In EAPI 4 and subsequent EAPIs DOCS may specify directories as well,
1702 # in other EAPIs using directories is unsupported.
1704 # If DOCS is not declared, the files matching patterns given
1705 # in the default EAPI implementation of src_install will be installed.
1706 # If this is undesired, DOCS can be set to empty value to prevent any
1707 # documentation from being installed.
1709 # If HTML_DOCS is declared and non-empty, all files and/or directories
1710 # listed in it are installed as HTML docs (using dohtml).
1712 # Both DOCS and HTML_DOCS can either be an array or a whitespace-
1713 # separated list. Whenever directories are allowed, '<directory>/.' may
1714 # be specified in order to install all files within the directory
1715 # without creating a sub-directory in docdir.
1717 # Passing additional options to dodoc and dohtml is not supported.
1718 # If you needed such a thing, you need to call those helpers explicitly.
1719 if has "${EAPI:-0}" 0 1 2 3 4 5; then
1721 debug-print-function ${FUNCNAME} "${@}"
1724 has ${EAPI} 0 1 2 3 && dodoc_opts=
1726 if ! declare -p DOCS &>/dev/null ; then
1728 for d in README* ChangeLog AUTHORS NEWS TODO CHANGES \
1729 THANKS BUGS FAQ CREDITS CHANGELOG ; do
1730 if [[ -s ${d} ]] ; then
1734 elif [[ $(declare -p DOCS) == "declare -a"* ]] ; then
1735 if [[ ${DOCS[@]} ]] ; then
1736 dodoc ${dodoc_opts} "${DOCS[@]}" || die
1739 if [[ ${DOCS} ]] ; then
1740 dodoc ${dodoc_opts} ${DOCS} || die
1744 if [[ $(declare -p HTML_DOCS 2>/dev/null) == "declare -a"* ]] ; then
1745 if [[ ${HTML_DOCS[@]} ]] ; then
1746 dohtml -r "${HTML_DOCS[@]}" || die
1749 if [[ ${HTML_DOCS} ]] ; then
1750 dohtml -r ${HTML_DOCS} || die
1758 check_license() { die "you no longer need this as portage supports ACCEPT_LICENSE itself"; }
1760 # @FUNCTION: optfeature
1761 # @USAGE: <short description> <package atom to match> [other atoms]
1763 # Print out a message suggesting an optional package (or packages) which
1764 # provide the described functionality
1766 # The following snippet would suggest app-misc/foo for optional foo support,
1767 # app-misc/bar or app-misc/baz[bar] for optional bar support
1768 # and either both app-misc/a and app-misc/b or app-misc/c for alphabet support.
1770 # optfeature "foo support" app-misc/foo
1771 # optfeature "bar support" app-misc/bar app-misc/baz[bar]
1772 # optfeature "alphabet support" "app-misc/a app-misc/b" app-misc/c
1775 debug-print-function ${FUNCNAME} "$@"
1782 if has_version "${j}"; then
1789 if [[ ${flag} -eq 1 ]]; then
1793 if [[ ${flag} -eq 0 ]]; then
1799 msg="${msg:0: -4} for ${desc}"