mirror of
https://github.com/gentoo-mirror/gentoo.git
synced 2026-11-09 06:37:10 -08:00
Michał Górny
2f653f03c3
Revert multiple meaningless eclass documentation changes, notably adding a lot of placeholders and documenting implementation details. These changes were aimed at silencing (valid) documentation warnings without actually providing valuable documentation to the end users. While some of these changes were beneficial, it would take a lot of effort to review them all and the author is unwilling to fix his mistakes. Signed-off-by: Michał Górny <mgorny@gentoo.org>
139 lines
3.3 KiB
Bash
139 lines
3.3 KiB
Bash
# Copyright 1999-2020 Gentoo Authors
|
|
# Distributed under the terms of the GNU General Public License v2
|
|
|
|
# @ECLASS: bash-completion-r1.eclass
|
|
# @MAINTAINER:
|
|
# mgorny@gentoo.org
|
|
# @SUPPORTED_EAPIS: 0 1 2 3 4 5 6 7
|
|
# @BLURB: A few quick functions to install bash-completion files
|
|
# @EXAMPLE:
|
|
#
|
|
# @CODE
|
|
# EAPI=5
|
|
#
|
|
# src_configure() {
|
|
# econf \
|
|
# --with-bash-completion-dir="$(get_bashcompdir)"
|
|
# }
|
|
#
|
|
# src_install() {
|
|
# default
|
|
#
|
|
# newbashcomp contrib/${PN}.bash-completion ${PN}
|
|
# }
|
|
# @CODE
|
|
|
|
inherit toolchain-funcs
|
|
|
|
case ${EAPI:-0} in
|
|
0|1|2|3|4|5|6|7) ;;
|
|
*) die "EAPI ${EAPI} unsupported (yet)."
|
|
esac
|
|
|
|
# @FUNCTION: _bash-completion-r1_get_bashdir
|
|
# @INTERNAL
|
|
# @DESCRIPTION:
|
|
# First argument is name of the string in bash-completion.pc
|
|
# Second argument is the fallback directory if the string is not found
|
|
# @EXAMPLE:
|
|
# _bash-completion-r1_get_bashdir completionsdir /usr/share/bash-completion
|
|
_bash-completion-r1_get_bashdir() {
|
|
debug-print-function ${FUNCNAME} "${@}"
|
|
|
|
if $(tc-getPKG_CONFIG) --exists bash-completion &>/dev/null; then
|
|
local path
|
|
path=$($(tc-getPKG_CONFIG) --variable="${1}" bash-completion) || die
|
|
# we need to return unprefixed, so strip from what pkg-config returns
|
|
# to us, bug #477692
|
|
echo "${path#${EPREFIX}}"
|
|
else
|
|
echo "${2}"
|
|
fi
|
|
}
|
|
|
|
# @FUNCTION: _bash-completion-r1_get_bashcompdir
|
|
# @INTERNAL
|
|
# @DESCRIPTION:
|
|
# Get unprefixed bash-completion completions directory.
|
|
_bash-completion-r1_get_bashcompdir() {
|
|
debug-print-function ${FUNCNAME} "${@}"
|
|
|
|
_bash-completion-r1_get_bashdir completionsdir /usr/share/bash-completion/completions
|
|
}
|
|
|
|
# @FUNCTION: _bash-completion-r1_get_helpersdir
|
|
# @INTERNAL
|
|
# @DESCRIPTION:
|
|
# Get unprefixed bash-completion helpers directory.
|
|
_bash-completion-r1_get_bashhelpersdir() {
|
|
debug-print-function ${FUNCNAME} "${@}"
|
|
|
|
_bash-completion-r1_get_bashdir helpersdir /usr/share/bash-completion/helpers
|
|
}
|
|
|
|
# @FUNCTION: get_bashcompdir
|
|
# @DESCRIPTION:
|
|
# Get the bash-completion completions directory.
|
|
get_bashcompdir() {
|
|
debug-print-function ${FUNCNAME} "${@}"
|
|
|
|
echo "${EPREFIX}$(_bash-completion-r1_get_bashcompdir)"
|
|
}
|
|
|
|
# @FUNCTION: get_bashhelpersdir
|
|
# @INTERNAL
|
|
# @DESCRIPTION:
|
|
# Get the bash-completion helpers directory.
|
|
get_bashhelpersdir() {
|
|
debug-print-function ${FUNCNAME} "${@}"
|
|
|
|
echo "${EPREFIX}$(_bash-completion-r1_get_bashhelpersdir)"
|
|
}
|
|
|
|
# @FUNCTION: dobashcomp
|
|
# @USAGE: <file> [...]
|
|
# @DESCRIPTION:
|
|
# Install bash-completion files passed as args. Has EAPI-dependant failure
|
|
# behavior (like doins).
|
|
dobashcomp() {
|
|
debug-print-function ${FUNCNAME} "${@}"
|
|
|
|
(
|
|
insopts -m 0644
|
|
insinto "$(_bash-completion-r1_get_bashcompdir)"
|
|
doins "${@}"
|
|
)
|
|
}
|
|
|
|
# @FUNCTION: newbashcomp
|
|
# @USAGE: <file> <newname>
|
|
# @DESCRIPTION:
|
|
# Install bash-completion file under a new name. Has EAPI-dependant failure
|
|
# behavior (like newins).
|
|
newbashcomp() {
|
|
debug-print-function ${FUNCNAME} "${@}"
|
|
|
|
(
|
|
insopts -m 0644
|
|
insinto "$(_bash-completion-r1_get_bashcompdir)"
|
|
newins "${@}"
|
|
)
|
|
}
|
|
|
|
# @FUNCTION: bashcomp_alias
|
|
# @USAGE: <basename> <alias>...
|
|
# @DESCRIPTION:
|
|
# Alias <basename> completion to one or more commands (<alias>es).
|
|
bashcomp_alias() {
|
|
debug-print-function ${FUNCNAME} "${@}"
|
|
|
|
[[ ${#} -lt 2 ]] && die "Usage: ${FUNCNAME} <basename> <alias>..."
|
|
local base=${1} f
|
|
shift
|
|
|
|
for f; do
|
|
dosym "${base}" "$(_bash-completion-r1_get_bashcompdir)/${f}" \
|
|
|| return
|
|
done
|
|
}
|