From 0766662706d8be50b3311919b9f9fbad6ce30ce6 Mon Sep 17 00:00:00 2001
From: Sam James <sam@gentoo.org>
Date: Sun, 28 Mar 2021 07:54:04 +0100
Subject: fixheadtails.eclass: document _do_sed_fix, mark @INTERNAL

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

(limited to 'eclass/fixheadtails.eclass')

diff --git a/eclass/fixheadtails.eclass b/eclass/fixheadtails.eclass
index 475b182843a5..e5e5ae1069c6 100644
--- a/eclass/fixheadtails.eclass
+++ b/eclass/fixheadtails.eclass
@@ -1,4 +1,4 @@
-# Copyright 1999-2020 Gentoo Authors
+# Copyright 1999-2021 Gentoo Authors
 # Distributed under the terms of the GNU General Public License v2
 
 # @ECLASS: fixheadtails.eclass
@@ -8,6 +8,12 @@
 # Original author John Mylchreest <johnm@gentoo.org>
 # @BLURB: functions to replace obsolete head/tail with POSIX compliant ones
 
+# @FUNCTION: _do_sed_fix
+# @INTERNAL
+# @USAGE: <file>
+# @DESCRIPTION:
+# Apply series of regular expressions via sed to file
+# to make head/tail compliant
 _do_sed_fix() {
 	einfo " - fixed $1"
 	sed -i \
-- 
cgit v1.2.3