diff options
author | Aaron Bauman <bman@gentoo.org> | 2020-12-15 14:40:40 -0500 |
---|---|---|
committer | Aaron Bauman <bman@gentoo.org> | 2020-12-15 15:19:56 -0500 |
commit | 774c5e734723c66634353f10c8a852f10862a554 (patch) | |
tree | d835c3b34d77b516726ef20388a23f801243a80b /eclass/gnuconfig.eclass | |
parent | eclass/font-ebdftopcf: fix documentation (diff) | |
download | gentoo-774c5e734723c66634353f10c8a852f10862a554.tar.gz gentoo-774c5e734723c66634353f10c8a852f10862a554.tar.bz2 gentoo-774c5e734723c66634353f10c8a852f10862a554.zip |
eclass/gnuconfig: fix documentation
Signed-off-by: Aaron Bauman <bman@gentoo.org>
Diffstat (limited to 'eclass/gnuconfig.eclass')
-rw-r--r-- | eclass/gnuconfig.eclass | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/eclass/gnuconfig.eclass b/eclass/gnuconfig.eclass index 3433837787c2..6ddaabff00a6 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 <wwoods@gentoo.org> -# + +# @ECLASS: gnuconfig.eclass +# @MAINTAINER: +# maintainer-needed@gentoo.org +# @AUTHOR: +# Will Woods <wwoods@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() { |