[gentoo-commits] repo/gentoo:master commit in: eclass/

[Aaron Bauman]

commit:     5cd3a39e4699279038b3f838aef51a49ea245ebd
Author:     Aaron Bauman <bman <AT> gentoo <DOT> org>
AuthorDate: Wed Dec 16 18:29:35 2020 +0000
Commit:     Aaron Bauman <bman <AT> gentoo <DOT> org>
CommitDate: Wed Dec 16 20:33:01 2020 +0000
URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=5cd3a39e

eclass/alternatives: fixup documentation

Signed-off-by: Aaron Bauman <bman <AT> gentoo.org>

 eclass/alternatives.eclass | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/eclass/alternatives.eclass b/eclass/alternatives.eclass
index 6ee984458fd..108a55af811 100644
--- a/eclass/alternatives.eclass
+++ b/eclass/alternatives.eclass
@@ -74,14 +74,17 @@ alternatives_auto_makesym() {
        alternatives_makesym ${SYMLINK} ${ALT}
 }
 
+# @FUNCTION: alternatives_makesym
+# @USAGE: alternatives_makesym <resulting symlink> [alternative targets..]
+# @DESCRIPTION:
+# make sure it is in the prefix, allow it already to be in the prefix
+
 alternatives_makesym() {
        has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX=
        local ALTERNATIVES=""
        local SYMLINK=""
        local alt pref
 
-       # usage: alternatives_makesym <resulting symlink> [alternative 
targets..]
-       # make sure it is in the prefix, allow it already to be in the prefix
        SYMLINK=${EPREFIX}/${1#${EPREFIX}}
        # this trick removes the trailing / from ${ROOT}
        pref=${ROOT%/}
@@ -126,6 +129,7 @@ alternatives_makesym() {
 # @FUNCTION: alernatives-pkg_postinst
 # @DESCRIPTION:
 # The alternatives pkg_postinst, this function will be exported
+
 alternatives_pkg_postinst() {
        if [ -n "${ALTERNATIVES}" -a -n "${SOURCE}" ]; then
                alternatives_makesym ${SOURCE} ${ALTERNATIVES}
@@ -135,6 +139,7 @@ alternatives_pkg_postinst() {
 # @FUNCTION: alternatives_pkg_postrm
 # @DESCRIPTION:
 # The alternatives pkg_postrm, this function will be exported
+
 alternatives_pkg_postrm() {
        if [ -n "${ALTERNATIVES}" -a -n "${SOURCE}" ]; then
                alternatives_makesym ${SOURCE} ${ALTERNATIVES}