summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichał Górny <mgorny@gentoo.org>2020-12-28 10:12:24 +0100
committerMichał Górny <mgorny@gentoo.org>2020-12-28 10:31:30 +0100
commit2f653f03c381cd6c4b1c7fc3aa7b25901fc8b47f (patch)
treebf4a87d73bd7f963bb8cfbea36d492599cbc4147 /eclass/gnuconfig.eclass
parentdev-ruby/racc: avoid dep on bundler (diff)
downloadgentoo-2f653f03c381cd6c4b1c7fc3aa7b25901fc8b47f.tar.gz
gentoo-2f653f03c381cd6c4b1c7fc3aa7b25901fc8b47f.tar.bz2
gentoo-2f653f03c381cd6c4b1c7fc3aa7b25901fc8b47f.zip
eclass: [QA] Revert multiple meaningless doc changes
Revert multiple meaningless eclass documentation changes, notably adding a lot of placeholders and documenting implementation details. These changes were aimed at silencing (valid) documentation warnings without actually providing valuable documentation to the end users. While some of these changes were beneficial, it would take a lot of effort to review them all and the author is unwilling to fix his mistakes. Signed-off-by: Michał Górny <mgorny@gentoo.org>
Diffstat (limited to 'eclass/gnuconfig.eclass')
-rw-r--r--eclass/gnuconfig.eclass19
1 files changed, 4 insertions, 15 deletions
diff --git a/eclass/gnuconfig.eclass b/eclass/gnuconfig.eclass
index 6ddaabff00a..3433837787c 100644
--- a/eclass/gnuconfig.eclass
+++ b/eclass/gnuconfig.eclass
@@ -1,13 +1,8 @@
# Copyright 1999-2020 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
-
-# @ECLASS: gnuconfig.eclass
-# @MAINTAINER:
-# maintainer-needed@gentoo.org
-# @AUTHOR:
-# Will Woods <wwoods@gentoo.org>
-# @BLURB: Automatically update automake files to newest version
-# @DESCRIPTION:
+#
+# Author: Will Woods <wwoods@gentoo.org>
+#
# 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
@@ -25,8 +20,6 @@
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.
@@ -49,12 +42,10 @@ 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
@@ -84,8 +75,6 @@ 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() {