commit: 774c5e734723c66634353f10c8a852f10862a554
Author: Aaron Bauman <bman <AT> gentoo <DOT> org>
AuthorDate: Tue Dec 15 19:40:40 2020 +0000
Commit: Aaron Bauman <bman <AT> gentoo <DOT> org>
CommitDate: Tue Dec 15 20:19:56 2020 +0000
URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=774c5e73
eclass/gnuconfig: fix documentation
Signed-off-by: Aaron Bauman <bman <AT> gentoo.org>
eclass/gnuconfig.eclass | 19 +++++++++++++++----
1 file changed, 15 insertions(+), 4 deletions(-)
diff --git a/eclass/gnuconfig.eclass b/eclass/gnuconfig.eclass
index 3433837787c..6ddaabff00a 100644
--- a/eclass/gnuconfig.eclass
+++ b/eclass/gnuconfig.eclass
@@ -1,8 +1,13 @@
# Copyright 1999-2020 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
-#
-# Author: Will Woods <wwo...@gentoo.org>
-#
+
+# @ECLASS: gnuconfig.eclass
+# @MAINTAINER:
+# maintainer-nee...@gentoo.org
+# @AUTHOR:
+# Will Woods <wwo...@gentoo.org>
+# @BLURB: Automatically update automake files to newest version
+# @DESCRIPTION:
# This eclass is used to automatically update files that typically come with
# automake to the newest version available on the system. The most common use
# of this is to update config.guess and config.sub when configure dies from
@@ -20,6 +25,8 @@
DEPEND="sys-devel/gnuconfig"
+# @FUNCTION: gnuconfig_update
+# @DESCRIPTION:
# Wrapper function for gnuconfig_do_update. If no arguments are given, update
# config.sub and config.guess (old default behavior), otherwise update the
# named files.
@@ -42,10 +49,12 @@ gnuconfig_update() {
return $?
}
+# @FUNCTION: gnuconfig_do_update
+# @DESCRIPTION:
# Copy the newest available version of specified files over any old ones in the
# source dir. This function shouldn't be called directly - use gnuconfig_update
#
-# Note that since bash using dynamic scoping, startdir is available here from
+# Note: that since bash using dynamic scoping, startdir is available here from
# the gnuconfig_update function
gnuconfig_do_update() {
local configsubs_dir target targetlist file
@@ -75,6 +84,8 @@ gnuconfig_do_update() {
return 0
}
+# @FUNCTION: gnuconfig_findnewest
+# @DESCRIPTION:
# this searches the standard locations for the newest config.{sub|guess}, and
# returns the directory where they can be found.
gnuconfig_findnewest() {
