diff options
| author |   Michał Górny <mgorny@gentoo.org> | 2020-12-28 10:12:24 +0100 |
|---|---|---|
| committer | Michał Górny <mgorny@gentoo.org> | 2020-12-28 10:31:30 +0100 |
| commit | 2f653f03c381cd6c4b1c7fc3aa7b25901fc8b47f (patch) | |
| tree | bf4a87d73bd7f963bb8cfbea36d492599cbc4147 /eclass/db-use.eclass | |
| parent | dev-ruby/racc: avoid dep on bundler (diff) | |
| download | gentoo-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/db-use.eclass')
| -rw-r--r-- | eclass/db-use.eclass | 34 |
1 files changed, 8 insertions, 26 deletions
diff --git a/eclass/db-use.eclass b/eclass/db-use.eclass index de257a9ae23b..7633425bac3b 100644 --- a/eclass/db-use.eclass +++ b/eclass/db-use.eclass @@ -1,15 +1,8 @@ # Copyright 1999-2020 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 - -# @ECLASS: db-use.eclass -# @MAINTAINER: -# maintainer-needed@gentoo.org -# @AUTHOR: -# Paul de Vrieze <pauldv@gentoo.org> -# @SUPPORTED_EAPIS: 0 1 2 3 4 5 6 7 -# @BLURB: functions that aid the use of sys-libs/db -# @DESCRIPTION: -# functions that aid in the use of sys-libs/db +# This is a common location for functions that aid the use of sys-libs/db +# +# Bugs: maintainer-needed@gentoo.org # multilib is used for get_libname in all EAPI case "${EAPI:-0}" in @@ -17,10 +10,7 @@ case "${EAPI:-0}" in *) inherit multilib ;; esac -# @FUNCTION: db_ver_to_slot -# @USAGE: <version> -# @DESCRIPTION: -# Convert a version to a db slot +#Convert a version to a db slot db_ver_to_slot() { if [ $# -ne 1 ]; then eerror "Function db_ver_to_slot needs one argument" >&2 @@ -38,10 +28,7 @@ db_ver_to_slot() { echo -n "$1" } -# @FUNCTION: db_findver -# @USAGE: <atom> -# @DESCRIPTION: -# Find the version that corresponds to the given atom +#Find the version that correspond to the given atom db_findver() { has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX= if [ $# -ne 1 ]; then @@ -65,9 +52,6 @@ db_findver() { fi } -# @FUNCTION: db_includedir -# @USAGE: <version> -# @DESCRIPTION: # Get the include dir for berkeley db. # This function has two modes. Without any arguments it will give the best # version available. With arguments that form the versions of db packages @@ -87,7 +71,7 @@ db_includedir() { return 1 fi else - # arguments given + #arguments given for x in $@ do if VER=$(db_findver "=sys-libs/db-${x}*") && @@ -101,9 +85,7 @@ db_includedir() { fi } -# @FUNCTION: db_libname -# @USAGE: <version> -# @DESCRIPTION: + # Get the library name for berkeley db. Something like "db-4.2" will be the # outcome. This function has two modes. Without any arguments it will give # the best version available. With arguments that form the versions of db @@ -121,7 +103,7 @@ db_libname() { return 1 fi else - # arguments given + #arguments given for x in $@ do if VER=$(db_findver "=sys-libs/db-${x}*"); then |