From 1ade252f652cfba4068bb2275e0b24e1175ee924 Mon Sep 17 00:00:00 2001
From: Sam James <sam@gentoo.org>
Date: Sun, 28 Mar 2021 04:39:37 +0000
Subject: [PATCH] alternatives.eclass: document alternatives_makesym()

Signed-off-by: Sam James <sam@gentoo.org>
---
 eclass/alternatives.eclass | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/eclass/alternatives.eclass b/eclass/alternatives.eclass
index 86adc87b6f4c4..d6bb6b19e9734 100644
--- a/eclass/alternatives.eclass
+++ b/eclass/alternatives.eclass
@@ -63,7 +63,7 @@ _ALTERNATIVES_ECLASS=1
 
 # @FUNCTION: alternatives_auto_makesym
 # @DESCRIPTION:
-# automatic deduction based on a symlink and a regex mask
+# Automatic deduction (Bash pathname expansion) based on a symlink and a regex mask
 alternatives_auto_makesym() {
 	local SYMLINK REGEX ALT myregex
 	SYMLINK=$1
@@ -84,6 +84,9 @@ alternatives_auto_makesym() {
 	alternatives_makesym ${SYMLINK} ${ALT}
 }
 
+# @FUNCTION: alternatives_makesym
+# @DESCRIPTION:
+# Creates symlink based on a symlink and regex mask literally
 alternatives_makesym() {
 	local ALTERNATIVES=""
 	local SYMLINK=""