From 5cd3a39e4699279038b3f838aef51a49ea245ebd Mon Sep 17 00:00:00 2001
From: Aaron Bauman <bman@gentoo.org>
Date: Wed, 16 Dec 2020 13:29:35 -0500
Subject: eclass/alternatives: fixup documentation

Signed-off-by: Aaron Bauman <bman@gentoo.org>
---
 eclass/alternatives.eclass | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

(limited to 'eclass')

diff --git a/eclass/alternatives.eclass b/eclass/alternatives.eclass
index 6ee984458fd6..108a55af8112 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}
-- 
cgit v1.2.3-65-gdbad