diff options
| author |   Repository mirror & CI <repomirrorci@gentoo.org> | 2021-03-31 07:43:59 +0000 |
|---|---|---|
| committer | Repository mirror & CI <repomirrorci@gentoo.org> | 2021-03-31 07:43:59 +0000 |
| commit | 4d5977090f2e1ba296f13c192b9ada1831c23391 (patch) | |
| tree | b258ec5510e3c94a179680cbed906d6f5f56fb7f /eclass | |
| parent | 2021-03-30 16:35:54 UTC (diff) | |
| parent | sys-kernel/gentoo-sources: Linux patch 5.4.109 (diff) | |
| download | gentoo-4d5977090f2e1ba296f13c192b9ada1831c23391.tar.gz gentoo-4d5977090f2e1ba296f13c192b9ada1831c23391.tar.bz2 gentoo-4d5977090f2e1ba296f13c192b9ada1831c23391.zip | |
Merge updates from master
Diffstat (limited to 'eclass')
70 files changed, 260 insertions, 141 deletions
diff --git a/eclass/alternatives.eclass b/eclass/alternatives.eclass index 79f14d81b134..e83326314261 100644 --- a/eclass/alternatives.eclass +++ b/eclass/alternatives.eclass @@ -1,9 +1,11 @@ -# Copyright 1999-2020 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: alternatives.eclass +# @MAINTAINER: +# maintainer-needed@gentoo.org # @AUTHOR: -# Original author: Alastair Tse <liquidx@gentoo.org> (03 Oct 2003) +# Alastair Tse <liquidx@gentoo.org> (03 Oct 2003) # @BLURB: Creates symlink to the latest version of multiple slotted packages. # @DESCRIPTION: # When a package is SLOT'ed, very often we need to have a symlink to the diff --git a/eclass/ant-tasks.eclass b/eclass/ant-tasks.eclass index 42f801a84d70..ea347fd706af 100644 --- a/eclass/ant-tasks.eclass +++ b/eclass/ant-tasks.eclass @@ -1,4 +1,4 @@ -# Copyright 2007-2020 Gentoo Authors +# Copyright 2007-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: ant-tasks.eclass @@ -33,12 +33,14 @@ inherit java-pkg-2 java-ant-2 EXPORT_FUNCTIONS src_unpack src_compile src_install # @ECLASS-VARIABLE: ANT_TASK_JDKVER +# @PRE_INHERIT # @DESCRIPTION: # Affects the >=virtual/jdk version set in DEPEND string. Defaults to 1.8, can # be overridden from ebuild BEFORE inheriting this eclass. ANT_TASK_JDKVER=${ANT_TASK_JDKVER-1.8} # @ECLASS-VARIABLE: ANT_TASK_JREVER +# @PRE_INHERIT # @DESCRIPTION: # Affects the >=virtual/jre version set in DEPEND string. Defaults to 1.8, can # be overridden from ebuild BEFORE inheriting this eclass. @@ -51,6 +53,7 @@ ANT_TASK_JREVER=${ANT_TASK_JREVER-1.8} ANT_TASK_NAME="${PN#ant-}" # @ECLASS-VARIABLE: ANT_TASK_DEPNAME +# @PRE_INHERIT # @DESCRIPTION: # Specifies JAVA_PKG_NAME (PN{-SLOT} used with java-pkg_jar-from) of the package # that this one depends on. Defaults to the name of ant task, ebuild can @@ -60,12 +63,14 @@ ANT_TASK_NAME="${PN#ant-}" ANT_TASK_DEPNAME=${ANT_TASK_DEPNAME-${ANT_TASK_NAME}} # @ECLASS-VARIABLE: ANT_TASK_DISABLE_VM_DEPS +# @PRE_INHERIT # @DEFAULT_UNSET # @DESCRIPTION: # If set, no JDK/JRE deps are added. # @VARIABLE: ANT_TASK_PV # @INTERNAL +# @DESCRIPTION: # Version of ant-core this task is intended to register and thus load with. ANT_TASK_PV="${PV}" @@ -80,7 +85,7 @@ MY_P="apache-ant-${MY_PV}" # Default values for standard ebuild variables, can be overridden from ebuild. DESCRIPTION="Apache Ant's optional tasks depending on ${ANT_TASK_DEPNAME}" -HOMEPAGE="http://ant.apache.org/" +HOMEPAGE="https://ant.apache.org/" SRC_URI="${UPSTREAM_PREFIX}/${MY_P}-src.tar.bz2 ${GENTOO_PREFIX}/ant-${PV}-gentoo.tar.bz2" LICENSE="Apache-2.0" diff --git a/eclass/aspell-dict-r1.eclass b/eclass/aspell-dict-r1.eclass index 4d0e64ed4e79..24bc5ff27996 100644 --- a/eclass/aspell-dict-r1.eclass +++ b/eclass/aspell-dict-r1.eclass @@ -15,6 +15,7 @@ # Support for aspell-0.60 has been added by Sergey Ulanov. # @ECLASS-VARIABLE: ASPELL_LANG +# @PRE_INHERIT # @REQUIRED # @DESCRIPTION: # Pure cleartext string that is included into DESCRIPTION. @@ -28,6 +29,7 @@ readonly ASPELL_SPELLANG=${PN/aspell-/} # @ECLASS-VARIABLE: ASPELL_VERSION +# @PRE_INHERIT # @DEFAULT_UNSET # @DESCRIPTION: # What major version of Aspell is this dictionary for? Valid values are 5, 6 or undefined. diff --git a/eclass/autotools.eclass b/eclass/autotools.eclass index 4ae360aa24d4..3e6906cb469a 100644 --- a/eclass/autotools.eclass +++ b/eclass/autotools.eclass @@ -34,16 +34,19 @@ esac inherit libtool # @ECLASS-VARIABLE: WANT_AUTOCONF +# @PRE_INHERIT # @DESCRIPTION: # The major version of autoconf your package needs : ${WANT_AUTOCONF:=latest} # @ECLASS-VARIABLE: WANT_AUTOMAKE +# @PRE_INHERIT # @DESCRIPTION: # The major version of automake your package needs : ${WANT_AUTOMAKE:=latest} # @ECLASS-VARIABLE: WANT_LIBTOOL +# @PRE_INHERIT # @DESCRIPTION: # Do you want libtool? Valid values here are "latest" and "none". : ${WANT_LIBTOOL:=latest} @@ -61,9 +64,9 @@ inherit libtool # version. # If a newer slot is stable on any arch, and is NOT reflected in this list, # then circular dependencies may arise during emerge @system bootstraps. -# -# See bug 312315 and 465732 for further information and context. -# +# +# See bug #312315 and bug #465732 for further information and context. +# # Do NOT change this variable in your ebuilds! # If you want to force a newer minor version, you can specify the correct # WANT value by using a colon: <PV>:<WANT_AUTOMAKE> @@ -75,7 +78,7 @@ if [[ -n ${WANT_AUTOMAKE} ]]; then case ${WANT_AUTOMAKE} in # Even if the package doesn't use automake, we still need to depend # on it because we run aclocal to process m4 macros. This matches - # the autoreconf tool, so this requirement is correct. #401605 + # the autoreconf tool, so this requirement is correct, bug #401605. none) ;; latest) # Use SLOT deps if we can. For EAPI=0, we get pretty close. @@ -117,6 +120,7 @@ AUTOTOOLS_DEPEND="${_automake_atom} RDEPEND="" # @ECLASS-VARIABLE: AUTOTOOLS_AUTO_DEPEND +# @PRE_INHERIT # @DESCRIPTION: # Set to 'no' to disable automatically adding to DEPEND. This lets # ebuilds form conditional depends by using ${AUTOTOOLS_DEPEND} in @@ -159,11 +163,13 @@ unset _automake_atom _autoconf_atom # particular options # @ECLASS-VARIABLE: AT_M4DIR +# @DEFAULT_UNSET # @DESCRIPTION: # Additional director(y|ies) aclocal should search : ${AT_M4DIR:=} # @ECLASS-VARIABLE: AT_SYS_M4DIR +# @DEFAULT_UNSET # @INTERNAL # @DESCRIPTION: # For system integrators, a list of additional aclocal search paths. @@ -182,13 +188,13 @@ unset _automake_atom _autoconf_atom eautoreconf() { local x g - # Subdirs often share a common build dir #529404. If so, we can't safely + # Subdirs often share a common build dir, bug #529404. If so, we can't safely # run in parallel because many tools clobber the content in there. Libtool # and automake both `rm && cp` while aclocal reads the output. We might be # able to handle this if we split the steps and grab locks on the dirs the # tools actually write to. Then we'd run all the common tools that use # those inputs. Doing this in bash does not scale easily. - # If we do re-enable parallel support, make sure #426512 is handled. + # If we do re-enable parallel support, make sure bug #426512 is handled. if [[ -z ${AT_NO_RECURSIVE} ]] ; then # Take care of subdirs for x in $(autotools_check_macro_val AC_CONFIG_SUBDIRS) ; do @@ -294,8 +300,8 @@ eaclocal_amflags() { [[ -e ${amflags_file} ]] || continue # setup the env in case the pkg does something crazy # in their ACLOCAL_AMFLAGS. like run a shell script - # which turns around and runs autotools. #365401 - # or split across multiple lines. #383525 + # which turns around and runs autotools (bug #365401) + # or split across multiple lines (bug #383525) autotools_env_setup aclocal_opts=$(sed -n \ "/^ACLOCAL_AMFLAGS[[:space:]]*=/{ \ @@ -317,7 +323,7 @@ eaclocal_amflags() { # specified parametes. The name of the tool run is the same of the function # without e prefix. # They also force installing the support files for safety. -# Respects AT_M4DIR for additional directories to search for macro's. +# Respects AT_M4DIR for additional directories to search for macros. eaclocal() { [[ ! -f aclocal.m4 || -n $(grep -e 'generated.*by aclocal' aclocal.m4) ]] && \ autotools_run_tool --at-m4flags aclocal "$@" $(eaclocal_amflags) @@ -366,7 +372,7 @@ eautoconf() { fi # Install config.guess and config.sub which are required by many macros - # in Autoconf >=2.70. + # in autoconf >=2.70. local _gnuconfig case ${EAPI:-0} in 0|1|2|3|4|5|6) @@ -424,7 +430,7 @@ eautomake() { || extra_opts+=( --foreign ) # Older versions of automake do not support --force-missing. But we want - # to use this whenever possible to update random bundled files #133489. + # to use this whenever possible to update random bundled files, bug #133489. case $(_automake_version) in 1.4|1.4[.-]*) ;; *) extra_opts+=( --force-missing ) ;; @@ -518,17 +524,17 @@ autotools_run_tool() { done if [[ ${EBUILD_PHASE} != "unpack" && ${EBUILD_PHASE} != "prepare" ]]; then - ewarn "QA Warning: running $1 in ${EBUILD_PHASE} phase" + ewarn "QA Warning: running '$1' in ${EBUILD_PHASE} phase" fi if ${missing_ok} && ! type -P ${1} >/dev/null ; then - einfo "Skipping '$*' due $1 not installed" + einfo "Skipping '$*' because '$1' not installed" return 0 fi autotools_env_setup - # Allow people to pass in full paths. #549268 + # Allow people to pass in full paths, bug #549268 local STDERR_TARGET="${T}/${1##*/}.out" # most of the time, there will only be one run, but if there are # more, make sure we get unique log filenames @@ -557,13 +563,13 @@ autotools_run_tool() { "$@" >> "${STDERR_TARGET}" 2>&1 if ! eend $? && ${autofail} ; then echo - eerror "Failed Running $1 !" + eerror "Failed running '$1'!" eerror - eerror "Include in your bugreport the contents of:" + eerror "Include in your bug report the contents of:" eerror eerror " ${STDERR_TARGET}" echo - die "Failed Running $1 !" + die "Failed running '$1'!" fi } diff --git a/eclass/cargo.eclass b/eclass/cargo.eclass index e763ac3468c5..e2894b4588b6 100644 --- a/eclass/cargo.eclass +++ b/eclass/cargo.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: cargo.eclass @@ -204,7 +204,6 @@ cargo_src_unpack() { # @FUNCTION: cargo_live_src_unpack # @DESCRIPTION: # Runs 'cargo fetch' and vendors downloaded crates for offline use, used in live ebuilds - cargo_live_src_unpack() { debug-print-function ${FUNCNAME} "$@" @@ -316,7 +315,6 @@ cargo_live_src_unpack() { # In some cases crates may need '--no-default-features' option, # as there is no way to disable single feature, except disabling all. # It can be passed directly to cargo_src_configure(). - cargo_src_configure() { debug-print-function ${FUNCNAME} "$@" @@ -361,7 +359,6 @@ cargo_src_compile() { # In come case workspaces need alternative --path parameter # default is '--path ./' if nothing specified. # '--path ./somedir' can be passed directly to cargo_src_install() - cargo_src_install() { debug-print-function ${FUNCNAME} "$@" diff --git a/eclass/cdrom.eclass b/eclass/cdrom.eclass index 4bbe6aa31759..623a19867d42 100644 --- a/eclass/cdrom.eclass +++ b/eclass/cdrom.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: cdrom.eclass @@ -21,6 +21,7 @@ inherit portability # @ECLASS-VARIABLE: CDROM_OPTIONAL # @DEFAULT_UNSET +# @PRE_INHERIT # @DESCRIPTION: # By default, the eclass sets PROPERTIES="interactive" on the assumption # that people will be using these. If your package optionally supports @@ -229,13 +230,13 @@ cdrom_load_next_cd() { if [[ ${showedmsg} -eq 0 ]] ; then if [[ ${CDROM_NUM_CDS} -eq 1 ]] ; then - einfo "Please insert+mount the ${CDROM_NAME:-CD for ${PN}} now !" + einfo "Please insert+mount the ${CDROM_NAME:-CD for ${PN}} now!" else local var="CDROM_NAME_${CDROM_CURRENT_CD}" if [[ -z ${!var} ]] ; then - einfo "Please insert+mount CD #${CDROM_CURRENT_CD} for ${PN} now !" + einfo "Please insert+mount CD #${CDROM_CURRENT_CD} for ${PN} now!" else - einfo "Please insert+mount the ${!var} now !" + einfo "Please insert+mount the ${!var} now!" fi fi showedmsg=1 diff --git a/eclass/check-reqs.eclass b/eclass/check-reqs.eclass index a45cbd15fee7..5c4a420ee06e 100644 --- a/eclass/check-reqs.eclass +++ b/eclass/check-reqs.eclass @@ -1,4 +1,4 @@ -# Copyright 2004-2020 Gentoo Authors +# Copyright 2004-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: check-reqs.eclass @@ -350,8 +350,8 @@ check-reqs_unsatisfied() { ${msg} "There is NOT at least ${sizeunit} ${location}" # @ECLASS-VARIABLE: CHECKREQS_FAILED - # @DESCRIPTION: # @INTERNAL + # @DESCRIPTION: # If set the checks failed and eclass should abort the build. # Internal, do not set yourself. CHECKREQS_FAILED="true" diff --git a/eclass/cmake-multilib.eclass b/eclass/cmake-multilib.eclass index e6d8fe64a02f..1266b5b42ed6 100644 --- a/eclass/cmake-multilib.eclass +++ b/eclass/cmake-multilib.eclass @@ -20,6 +20,7 @@ # phase rather than 'default'. # @ECLASS-VARIABLE: CMAKE_ECLASS +# @PRE_INHERIT # @DESCRIPTION: # Default is "cmake-utils" for compatibility in EAPI-7. Specify "cmake" for # ebuilds that ported to cmake.eclass already. Future EAPI is "cmake" only. diff --git a/eclass/cmake-utils.eclass b/eclass/cmake-utils.eclass index aae859a44cc8..8a4405bef86c 100644 --- a/eclass/cmake-utils.eclass +++ b/eclass/cmake-utils.eclass @@ -94,6 +94,7 @@ _CMAKE_UTILS_ECLASS=1 # "no" to disable (default) or anything else to enable. # @ECLASS-VARIABLE: CMAKE_EXTRA_CACHE_FILE +# @USER_VARIABLE # @DEFAULT_UNSET # @DESCRIPTION: # Specifies an extra cache file to pass to cmake. This is the analog of EXTRA_ECONF @@ -101,6 +102,7 @@ _CMAKE_UTILS_ECLASS=1 # Should be set by user in a per-package basis in /etc/portage/package.env. # @ECLASS-VARIABLE: CMAKE_UTILS_QA_SRC_DIR_READONLY +# @USER_VARIABLE # @DEFAULT_UNSET # @DESCRIPTION: # After running cmake-utils_src_prepare, sets ${S} to read-only. This is diff --git a/eclass/cmake.eclass b/eclass/cmake.eclass index 196c60e0b15c..4bd09459ea62 100644 --- a/eclass/cmake.eclass +++ b/eclass/cmake.eclass @@ -48,6 +48,7 @@ _CMAKE_ECLASS=1 # Set to enable in-source build. # @ECLASS-VARIABLE: CMAKE_MAKEFILE_GENERATOR +# @PRE_INHERIT # @DEFAULT_UNSET # @DESCRIPTION: # Specify a makefile generator to be used by cmake. @@ -81,6 +82,7 @@ _CMAKE_ECLASS=1 : ${CMAKE_WARN_UNUSED_CLI:=yes} # @ECLASS-VARIABLE: CMAKE_EXTRA_CACHE_FILE +# @USER_VARIABLE # @DEFAULT_UNSET # @DESCRIPTION: # Specifies an extra cache file to pass to cmake. This is the analog of EXTRA_ECONF @@ -88,6 +90,7 @@ _CMAKE_ECLASS=1 # Should be set by user in a per-package basis in /etc/portage/package.env. # @ECLASS-VARIABLE: CMAKE_QA_SRC_DIR_READONLY +# @USER_VARIABLE # @DEFAULT_UNSET # @DESCRIPTION: # After running cmake_src_prepare, sets ${S} to read-only. This is diff --git a/eclass/cron.eclass b/eclass/cron.eclass index b9f436a4a5aa..5548b190f9a7 100644 --- a/eclass/cron.eclass +++ b/eclass/cron.eclass @@ -1,4 +1,4 @@ -# Copyright 1999-2019 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: cron.eclass @@ -16,7 +16,6 @@ # NOTE on defaults: the default settings in the below functions were # chosen based on the most common setting among cron ebuilds. # -# Please assign any bugs regarding this eclass to cron-bugs@gentoo.org. inherit eutils flag-o-matic diff --git a/eclass/cvs.eclass b/eclass/cvs.eclass index dd3cbe135a39..a8e5ee4cc9a0 100644 --- a/eclass/cvs.eclass +++ b/eclass/cvs.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: cvs.eclass @@ -62,6 +62,7 @@ _CVS_ECLASS=1 # CVS options given after the cvs checkout command. # @ECLASS-VARIABLE: ECVS_OFFLINE +# @USER_VARIABLE # @DESCRIPTION: # Set this variable to a non-empty value to disable the automatic updating of # a CVS source tree. This is intended to be set outside the cvs source @@ -131,6 +132,7 @@ _CVS_ECLASS=1 #: ${ECVS_BRANCH:="HEAD"} # @ECLASS-VARIABLE: ECVS_AUTH +# @PRE_INHERIT # @DESCRIPTION: # Authentication method to use # diff --git a/eclass/darcs.eclass b/eclass/darcs.eclass index 12e7289cc7d0..1ed886fb4dce 100644 --- a/eclass/darcs.eclass +++ b/eclass/darcs.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: darcs.eclass @@ -71,6 +71,7 @@ SRC_URI="" : ${EDARCS_REPOSITORY:=} # @ECLASS-VARIABLE: EDARCS_OFFLINE +# @USER_VARIABLE # @DESCRIPTION: # Set this variable to a non-empty value to disable the automatic updating of # a darcs repository. This is intended to be set outside the darcs source @@ -100,6 +101,7 @@ case ${EAPI:-0} in esac # @FUNCTION: darcs_patchcount +# @INTERNAL # @DESCRIPTION: # Internal function to determine amount of patches in repository. darcs_patchcount() { @@ -109,6 +111,7 @@ darcs_patchcount() { } # @FUNCTION: darcs_fetch +# @INTERNAL # @DESCRIPTION: # Internal function is called from darcs_src_unpack darcs_fetch() { diff --git a/eclass/dotnet.eclass b/eclass/dotnet.eclass index ae861daf6e79..fd25ad1d5856 100644 --- a/eclass/dotnet.eclass +++ b/eclass/dotnet.eclass @@ -1,8 +1,9 @@ -# Copyright 1999-2020 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: dotnet.eclass -# @MAINTAINER: dotnet@gentoo.org +# @MAINTAINER: +# dotnet@gentoo.org # @SUPPORTED_EAPIS: 1 2 3 4 5 6 7 # @BLURB: common settings and functions for mono and dotnet related packages # @DESCRIPTION: @@ -24,6 +25,7 @@ esac inherit mono-env # @ECLASS-VARIABLE: USE_DOTNET +# @PRE_INHERIT # @DESCRIPTION: # Use flags added to IUSE diff --git a/eclass/dune.eclass b/eclass/dune.eclass index 03857d25a2d4..a6b499cfbdb1 100644 --- a/eclass/dune.eclass +++ b/eclass/dune.eclass @@ -15,6 +15,7 @@ # src_install for dune-based packages. # @ECLASS-VARIABLE: DUNE_PKG_NAME +# @PRE_INHERIT # @DESCRIPTION: # Sets the actual dune package name, if different from gentoo package name. # Set before inheriting the eclass. diff --git a/eclass/elisp.eclass b/eclass/elisp.eclass index 7876928c7fb2..a092041009bf 100644 --- a/eclass/elisp.eclass +++ b/eclass/elisp.eclass @@ -1,4 +1,4 @@ -# Copyright 2002-2020 Gentoo Authors +# Copyright 2002-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: elisp.eclass @@ -27,6 +27,7 @@ # ${PN}.el in src_unpack(). # @ECLASS-VARIABLE: NEED_EMACS +# @PRE_INHERIT # @DEFAULT_UNSET # @DESCRIPTION: # If you need anything different from Emacs 23, use the NEED_EMACS diff --git a/eclass/emboss-r2.eclass b/eclass/emboss-r2.eclass index 1f09805f8541..680b7b7e4d61 100644 --- a/eclass/emboss-r2.eclass +++ b/eclass/emboss-r2.eclass @@ -23,6 +23,7 @@ # inherit emboss-r2 # @ECLASS-VARIABLE: EBO_DESCRIPTION +# @PRE_INHERIT # @DEFAULT_UNSET # @DESCRIPTION: # Completes the generic description of the embassy module as follows: diff --git a/eclass/epatch.eclass b/eclass/epatch.eclass index fbb4f0b5bc0d..0c7ca0cf045a 100644 --- a/eclass/epatch.eclass +++ b/eclass/epatch.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: epatch.eclass @@ -294,7 +294,7 @@ epatch() { local rel_paths=$(egrep -n '^[-+]{3} [^ ]*[.][.]/' "${PATCH_TARGET}") if [[ -n ${rel_paths} ]] ; then echo - eerror "Rejected Patch: ${patchname} !" + eerror "Rejected Patch: ${patchname}!" eerror " ( ${PATCH_TARGET} )" eerror eerror "Your patch uses relative paths '../':" @@ -359,14 +359,14 @@ epatch() { if [[ ${count} -ge 5 ]] ; then echo - eerror "Failed Patch: ${patchname} !" + eerror "Failed patch: ${patchname}!" eerror " ( ${PATCH_TARGET} )" eerror - eerror "Include in your bugreport the contents of:" + eerror "Include in your bug report the contents of:" eerror eerror " ${STDERR_TARGET}" echo - die "Failed Patch: ${patchname}!" + die "Failed patch: ${patchname}!" fi # if everything worked, delete the full debug patch log diff --git a/eclass/fixheadtails.eclass b/eclass/fixheadtails.eclass index 475b182843a5..f1df8242b6fd 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 \ @@ -37,5 +43,5 @@ ht_fix_all() { MATCHES=$(grep -l -s -i -R -e "head -[ 0-9]" -e "tail [+-][ 0-9]" * | sort -u) [[ -n ${MATCHES} ]] \ && ht_fix_file ${MATCHES} \ - || einfo "No need for ht_fix_all anymore !" + || einfo "No need for ht_fix_all anymore!" } diff --git a/eclass/freedict.eclass b/eclass/freedict.eclass index 2af79666aa20..20603adc8427 100644 --- a/eclass/freedict.eclass +++ b/eclass/freedict.eclass @@ -5,7 +5,7 @@ # @MAINTAINER: # maintainer-needed@gentoo.org # @AUTHOR: -# Original author: Seemant Kulleen +# Original author: Seemant Kulleen <seemant@gentoo.org> # @SUPPORTED_EAPIS: 7 # @BLURB: Ease the installation of freedict translation dictionaries # @DESCRIPTION: @@ -37,7 +37,7 @@ S="${WORKDIR}" # @FUNCTION: freedict_src_install # @DESCRIPTION: -# Installs translation specific dict.dz and index files. +# Installs translation-specific dict.dz and index files. freedict_src_install() { insinto /usr/$(get_libdir)/dict doins ${FREEDICT_P}.dict.dz diff --git a/eclass/ghc-package.eclass b/eclass/ghc-package.eclass index 72d668ca0e2e..7e8a5aa0cba8 100644 --- a/eclass/ghc-package.eclass +++ b/eclass/ghc-package.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: ghc-package.eclass @@ -37,6 +37,7 @@ ghc-getghc() { } # @FUNCTION: ghc-getghcpkg +# @INTERNAL # @DESCRIPTION: # Internal function determines returns the name of the ghc-pkg executable ghc-getghcpkg() { diff --git a/eclass/git-r3.eclass b/eclass/git-r3.eclass index cda7ac161e92..9c4f2c9d778e 100644 --- a/eclass/git-r3.eclass +++ b/eclass/git-r3.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: git-r3.eclass @@ -36,6 +36,7 @@ if [[ ! ${_INHERITED_BY_GIT_2} ]]; then fi # @ECLASS-VARIABLE: EGIT_CLONE_TYPE +# @USER_VARIABLE # @DESCRIPTION: # Type of clone that should be used against the remote repository. # This can be either of: 'mirror', 'single', 'shallow'. diff --git a/eclass/gkrellm-plugin.eclass b/eclass/gkrellm-plugin.eclass index d6eb57ad0eca..3d13409933e7 100644 --- a/eclass/gkrellm-plugin.eclass +++ b/eclass/gkrellm-plugin.eclass @@ -1,12 +1,12 @@ -# Copyright 1999-2018 Gentoo Foundation +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: gkrellm-plugin.eclass # @MAINTAINER: # maintainer-needed@gentoo.org # @AUTHOR: -# Original author: Jim Ramsay -# EAPI 6 author: David Seifert +# Original author: Jim Ramsay <lack@gentoo.org> +# EAPI 6 author: David Seifert <soap@gentoo.org> # @SUPPORTED_EAPIS: 6 # @BLURB: Provides src_install used by (almost) all gkrellm plugins # @DESCRIPTION: diff --git a/eclass/golang-base.eclass b/eclass/golang-base.eclass index e700d17a4d8f..8e859d0fdf63 100644 --- a/eclass/golang-base.eclass +++ b/eclass/golang-base.eclass @@ -1,4 +1,4 @@ -# Copyright 1999-2019 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: golang-base.eclass @@ -15,7 +15,7 @@ case "${EAPI:-0}" in 5|6|7) ;; *) - die "${ECLASS}: Unsupported eapi (EAPI=${EAPI})" + die "${ECLASS}: Unsupported EAPI (EAPI=${EAPI})" ;; esac diff --git a/eclass/golang-vcs-snapshot.eclass b/eclass/golang-vcs-snapshot.eclass index 306db1f26c98..abdb7fa119dd 100644 --- a/eclass/golang-vcs-snapshot.eclass +++ b/eclass/golang-vcs-snapshot.eclass @@ -1,12 +1,11 @@ -# Copyright 1999-2020 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: golang-vcs-snapshot.eclass # @MAINTAINER: # William Hubbs <williamh@gentoo.org> # @SUPPORTED_EAPIS: 5 6 7 -# @BLURB: support eclass for unpacking VCS snapshot tarballs for -# software written in the Go programming language +# @BLURB: eclass to unpack VCS snapshot tarballs for Go software # @DESCRIPTION: # This eclass provides a convenience src_unpack() which unpacks the # first tarball mentioned in SRC_URI to its appropriate location in diff --git a/eclass/golang-vcs.eclass b/eclass/golang-vcs.eclass index 159b32f952f9..4d4a38bffe8c 100644 --- a/eclass/golang-vcs.eclass +++ b/eclass/golang-vcs.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: golang-vcs.eclass @@ -41,6 +41,7 @@ PROPERTIES+=" live" # @CODE # @ECLASS-VARIABLE: EGO_STORE_DIR +# @USER_VARIABLE # @DESCRIPTION: # Storage directory for Go sources. # diff --git a/eclass/haskell-cabal.eclass b/eclass/haskell-cabal.eclass index 6099363bc9a5..b4741a0840c1 100644 --- a/eclass/haskell-cabal.eclass +++ b/eclass/haskell-cabal.eclass @@ -1,4 +1,4 @@ -# Copyright 1999-2019 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: haskell-cabal.eclass @@ -42,6 +42,7 @@ inherit eutils ghc-package multilib toolchain-funcs # @ECLASS-VARIABLE: CABAL_EXTRA_CONFIGURE_FLAGS +# @USER_VARIABLE # @DESCRIPTION: # User-specified additional parameters passed to 'setup configure'. # example: /etc/portage/make.conf: @@ -49,12 +50,14 @@ inherit eutils ghc-package multilib toolchain-funcs : ${CABAL_EXTRA_CONFIGURE_FLAGS:=} # @ECLASS-VARIABLE: CABAL_EXTRA_BUILD_FLAGS +# @USER_VARIABLE # @DESCRIPTION: # User-specified additional parameters passed to 'setup build'. # example: /etc/portage/make.conf: CABAL_EXTRA_BUILD_FLAGS=-v : ${CABAL_EXTRA_BUILD_FLAGS:=} # @ECLASS-VARIABLE: GHC_BOOTSTRAP_FLAGS +# @USER_VARIABLE # @DESCRIPTION: # User-specified additional parameters for ghc when building # _only_ 'setup' binary bootstrap. @@ -63,6 +66,7 @@ inherit eutils ghc-package multilib toolchain-funcs : ${GHC_BOOTSTRAP_FLAGS:=} # @ECLASS-VARIABLE: CABAL_EXTRA_HADDOCK_FLAGS +# @USER_VARIABLE # @DESCRIPTION: # User-specified additional parameters passed to 'setup haddock'. # example: /etc/portage/make.conf: @@ -70,6 +74,7 @@ inherit eutils ghc-package multilib toolchain-funcs : ${CABAL_EXTRA_HADDOCK_FLAGS:=} # @ECLASS-VARIABLE: CABAL_EXTRA_HOOGLE_FLAGS +# @USER_VARIABLE # @DESCRIPTION: # User-specified additional parameters passed to 'setup haddock --hoogle'. # example: /etc/portage/make.conf: @@ -77,6 +82,7 @@ inherit eutils ghc-package multilib toolchain-funcs : ${CABAL_EXTRA_HOOGLE_FLAGS:=} # @ECLASS-VARIABLE: CABAL_EXTRA_HSCOLOUR_FLAGS +# @USER_VARIABLE # @DESCRIPTION: # User-specified additional parameters passed to 'setup hscolour'. # example: /etc/portage/make.conf: @@ -85,6 +91,7 @@ inherit eutils ghc-package multilib toolchain-funcs # @ECLASS-VARIABLE: CABAL_EXTRA_TEST_FLAGS +# @USER_VARIABLE # @DESCRIPTION: # User-specified additional parameters passed to 'setup test'. # example: /etc/portage/make.conf: diff --git a/eclass/java-ant-2.eclass b/eclass/java-ant-2.eclass index 733d1d1f6bf7..69e3f7d46d8e 100644 --- a/eclass/java-ant-2.eclass +++ b/eclass/java-ant-2.eclass @@ -1,11 +1,12 @@ -# Copyright 2004-2019 Gentoo Authors +# Copyright 2004-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: java-ant-2.eclass # @MAINTAINER: # java@gentoo.org # @AUTHOR: -# kiorky (kiorky@cryptelium.net), Petteri Räty (betelgeuse@gentoo.org) +# kiorky <kiorky@cryptelium.net> +# Petteri Räty <betelgeuse@gentoo.org> # @BLURB: eclass for ant based Java packages # @DESCRIPTION: # Eclass for Ant-based Java packages. Provides support for both automatic and diff --git a/eclass/java-osgi.eclass b/eclass/java-osgi.eclass index bb8c1d8575bd..f9a77b8490fa 100644 --- a/eclass/java-osgi.eclass +++ b/eclass/java-osgi.eclass @@ -1,11 +1,11 @@ -# Copyright 2007-2015 Gentoo Foundation +# Copyright 2007-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: java-osgi.eclass # @MAINTAINER: # java@gentoo.org # @AUTHOR: -# Java maintainers (java@gentoo.org) +# Java maintainers <java@gentoo.org> # @BLURB: Java OSGi eclass # @DESCRIPTION: # This eclass provides functionality which is used by packages that need to be diff --git a/eclass/java-pkg-2.eclass b/eclass/java-pkg-2.eclass index bd5e92da6a27..4b690be13751 100644 --- a/eclass/java-pkg-2.eclass +++ b/eclass/java-pkg-2.eclass @@ -1,4 +1,4 @@ -# Copyright 2004-2015 Gentoo Foundation +# Copyright 2004-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: java-pkg-2.eclass @@ -14,6 +14,7 @@ inherit java-utils-2 # @ECLASS-VARIABLE: JAVA_PKG_IUSE +# @PRE_INHERIT # @DEFAULT_UNSET # @DESCRIPTION: # Use JAVA_PKG_IUSE instead of IUSE for doc, source and examples so that @@ -42,7 +43,6 @@ esac # @FUNCTION: java-pkg-2_pkg_setup # @DESCRIPTION: # pkg_setup initializes the Java environment - java-pkg-2_pkg_setup() { java-pkg_init } @@ -51,7 +51,6 @@ java-pkg-2_pkg_setup() { # @FUNCTION: java-pkg-2_src_prepare # @DESCRIPTION: # wrapper for java-utils-2_src_prepare - java-pkg-2_src_prepare() { java-utils-2_src_prepare } @@ -72,7 +71,6 @@ java-pkg-2_src_prepare() { # EANT_EXTRA_ARGS - extra arguments to pass to eant # EANT_ANT_TASKS - modifies the ANT_TASKS variable in the eant environment # @CODE - java-pkg-2_src_compile() { if [[ -e "${EANT_BUILD_XML:=build.xml}" ]]; then # auto generate classpath @@ -96,7 +94,6 @@ java-pkg-2_src_compile() { # @FUNCTION: java-pkg-2_src_test # @DESCRIPTION: # src_test, not exported. - java-pkg-2_src_test() { [[ -e "${EANT_BUILD_XML:=build.xml}" ]] || return @@ -149,7 +146,6 @@ java-pkg-2_src_test() { # @FUNCTION: java-pkg-2_pkg_preinst # @DESCRIPTION: # wrapper for java-utils-2_pkg_preinst - java-pkg-2_pkg_preinst() { java-utils-2_pkg_preinst } diff --git a/eclass/java-pkg-simple.eclass b/eclass/java-pkg-simple.eclass index a1ab0afb3162..ca03fea78cf4 100644 --- a/eclass/java-pkg-simple.eclass +++ b/eclass/java-pkg-simple.eclass @@ -1,11 +1,11 @@ -# Copyright 2004-2020 Gentoo Authors +# Copyright 2004-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: java-pkg-simple.eclass # @MAINTAINER: # java@gentoo.org # @AUTHOR: -# Java maintainers (java@gentoo.org) +# Java maintainers <java@gentoo.org> # @BLURB: Eclass for packaging Java software with ease. # @DESCRIPTION: # This class is intended to build pure Java packages from Java sources diff --git a/eclass/java-utils-2.eclass b/eclass/java-utils-2.eclass index b0d4d8acbefc..a5c06a689ced 100644 --- a/eclass/java-utils-2.eclass +++ b/eclass/java-utils-2.eclass @@ -1,4 +1,4 @@ -# Copyright 2004-2020 Gentoo Authors +# Copyright 2004-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: java-utils-2.eclass @@ -1484,7 +1484,6 @@ java-pkg_ensure-vm-version-sufficient() { # @FUNCTION: java-pkg_is-vm-version-sufficient # @INTERNAL -# @DESCRIPTION: # @RETURN: zero - VM is sufficient; non-zero - VM is not sufficient java-pkg_is-vm-version-sufficient() { debug-print-function ${FUNCNAME} $* @@ -2592,14 +2591,14 @@ java-pkg_needs-vm() { # @FUNCTION: java-pkg_get-current-vm # @INTERNAL -# @RETURN - The current VM being used +# @RETURN: The current VM being used java-pkg_get-current-vm() { java-config -f } # @FUNCTION: java-pkg_get-vm-vendor # @INTERNAL -# @RETURN - The vendor of the current VM +# @RETURN: The vendor of the current VM java-pkg_get-vm-vendor() { debug-print-function ${FUNCNAME} $* @@ -2610,7 +2609,7 @@ java-pkg_get-vm-vendor() { # @FUNCTION: java-pkg_get-vm-version # @INTERNAL -# @RETURN - The version of the current VM +# @RETURN: The version of the current VM java-pkg_get-vm-version() { debug-print-function ${FUNCNAME} $* @@ -2619,12 +2618,12 @@ java-pkg_get-vm-version() { # @FUNCTION: java-pkg_build-vm-from-handle # @INTERNAL +# @RETURN: VM handle of an available JDK # @DESCRIPTION: # Selects a build vm from a list of vm handles. First checks for the system-vm # beeing usable, then steps through the listed handles till a suitable vm is # found. # -# @RETURN - VM handle of an available JDK java-pkg_build-vm-from-handle() { debug-print-function ${FUNCNAME} "$*" diff --git a/eclass/kernel-2.eclass b/eclass/kernel-2.eclass index dccd39ec8f2f..67ad4acc1fef 100644 --- a/eclass/kernel-2.eclass +++ b/eclass/kernel-2.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: kernel-2.eclass @@ -1631,9 +1631,9 @@ kernel-2_pkg_setup() { echo ewarn "Be warned !! >=sys-devel/gcc-4.0.0 isn't supported with linux-2.4!" ewarn "Either switch to another gcc-version (via gcc-config) or use a" - ewarn "newer kernel that supports gcc-4." + ewarn "newer kernel that supports >=sys-devel/gcc-4." echo - ewarn "Also be aware that bugreports about gcc-4 not working" + ewarn "Also, be aware that bug reports about gcc-4 not working" ewarn "with linux-2.4 based ebuilds will be closed as INVALID!" echo fi diff --git a/eclass/libretro-core.eclass b/eclass/libretro-core.eclass index f5f63065f223..ff7b629d63b5 100644 --- a/eclass/libretro-core.eclass +++ b/eclass/libretro-core.eclass @@ -1,4 +1,4 @@ -# Copyright 2018-2020 Gentoo Authors +# Copyright 2018-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: libretro-core.eclass @@ -53,11 +53,13 @@ if [[ -z "${LIBRETRO_CORE_NAME}" ]]; then fi # @ECLASS-VARIABLE: LIBRETRO_COMMIT_SHA +# @PRE_INHERIT # @DESCRIPTION: # Commit SHA used for SRC_URI will die if not set in <9999 ebuilds. # Needs to be set before inherit. # @ECLASS-VARIABLE: LIBRETRO_REPO_NAME +# @PRE_INHERIT # @REQUIRED # @DESCRIPTION: # Contains the real repo name of the core formatted as "repouser/reponame". diff --git a/eclass/linux-info.eclass b/eclass/linux-info.eclass index 11a890889e4f..55f38af0ffd8 100644 --- a/eclass/linux-info.eclass +++ b/eclass/linux-info.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: linux-info.eclass @@ -951,9 +951,9 @@ linux-info_pkg_setup() { ewarn "linux-2.4 (or modules building against a linux-2.4 kernel)!" echo ewarn "Either switch to another gcc-version (via gcc-config) or use a" - ewarn "newer kernel that supports gcc-4." + ewarn "newer kernel that supports >=sys-devel/gcc-4." echo - ewarn "Also be aware that bugreports about gcc-4 not working" + ewarn "Also, be aware that bug reports about gcc-4 not working" ewarn "with linux-2.4 based ebuilds will be closed as INVALID!" echo fi diff --git a/eclass/linux-mod.eclass b/eclass/linux-mod.eclass index e0444eacc61a..11b0fd0cfb5e 100644 --- a/eclass/linux-mod.eclass +++ b/eclass/linux-mod.eclass @@ -18,11 +18,13 @@ # These are as follows: # @ECLASS-VARIABLE: MODULES_OPTIONAL_USE +# @PRE_INHERIT # @DESCRIPTION: # A string containing the USE flag to use for making this eclass optional # The recommended non-empty value is 'modules' # @ECLASS-VARIABLE: MODULES_OPTIONAL_USE_IUSE_DEFAULT +# @PRE_INHERIT # @DESCRIPTION: # A boolean to control the IUSE default state for the MODULES_OPTIONAL_USE USE # flag. Default value is unset (false). True represented by 1 or 'on', other diff --git a/eclass/mercurial.eclass b/eclass/mercurial.eclass index faf38306db38..dc0d19f59ae2 100644 --- a/eclass/mercurial.eclass +++ b/eclass/mercurial.eclass @@ -1,4 +1,4 @@ -# Copyright 1999-2019 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: mercurial.eclass @@ -35,6 +35,7 @@ DEPEND="dev-vcs/mercurial" : ${EHG_REVISION:="default"} # @ECLASS-VARIABLE: EHG_STORE_DIR +# @USER_VARIABLE # @DESCRIPTION: # Mercurial sources store directory. Users may override this in /etc/portage/make.conf [[ -z "${EHG_STORE_DIR}" ]] && EHG_STORE_DIR="${PORTAGE_ACTUAL_DISTDIR:-${DISTDIR}}/hg-src" diff --git a/eclass/mozextension.eclass b/eclass/mozextension.eclass index c6276908b9f5..3966dfd9f53f 100644 --- a/eclass/mozextension.eclass +++ b/eclass/mozextension.eclass @@ -1,11 +1,12 @@ -# Copyright 1999-2020 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # + # @ECLASS: mozextension.eclass # @MAINTAINER: # Mozilla team <mozilla@gentoo.org> -# @BLURB: Install extensions for use in mozilla products. -# +# @BLURB: Install extensions for use in Mozilla products. + if [[ ! ${_MOZEXTENSION} ]]; then # @ECLASS-VARIABLE: MOZEXTENSION_TARGET diff --git a/eclass/mozlinguas-v2.eclass b/eclass/mozlinguas-v2.eclass index be01ef6aca50..423f0bdcc71a 100644 --- a/eclass/mozlinguas-v2.eclass +++ b/eclass/mozlinguas-v2.eclass @@ -28,6 +28,7 @@ esac EXPORT_FUNCTIONS src_unpack src_compile src_install # @ECLASS-VARIABLE: MOZ_LANGS +# @DEFAULT_UNSET # @DESCRIPTION: # Array containing the list of language pack xpis available for # this release. The list can be updated with scripts/get_langs.sh from the @@ -35,34 +36,40 @@ EXPORT_FUNCTIONS src_unpack src_compile src_install : ${MOZ_LANGS:=()} # @ECLASS-VARIABLE: MOZ_PV +# @DEFAULT_UNSET # @DESCRIPTION: # Ebuild package version converted to equivalent upstream version. # Defaults to ${PV}, and should be overridden for alphas, betas, and RCs : ${MOZ_PV:="${PV}"} # @ECLASS-VARIABLE: MOZ_PN +# @DEFAULT_UNSET # @DESCRIPTION: # Ebuild package name converted to equivalent upstream name. # Defaults to ${PN}, and should be overridden for binary ebuilds. : ${MOZ_PN:="${PN}"} # @ECLASS-VARIABLE: MOZ_P +# @DEFAULT_UNSET # @DESCRIPTION: # Ebuild package name + version converted to upstream equivalent. # Defaults to ${MOZ_PN}-${MOZ_PV} : ${MOZ_P:="${MOZ_PN}-${MOZ_PV}"} # @ECLASS-VARIABLE: MOZ_FTP_URI +# @DEFAULT_UNSET # @DESCRIPTION: # The ftp URI prefix for the release tarballs and language packs. : ${MOZ_FTP_URI:=""} # @ECLASS-VARIABLE: MOZ_HTTP_URI +# @PRE_INHERIT # @DESCRIPTION: # The http URI prefix for the release tarballs and language packs. : ${MOZ_HTTP_URI:=""} # @ECLASS-VARIABLE: MOZ_LANGPACK_HTTP_URI +# @PRE_INHERIT # @DESCRIPTION: # An alternative http URI if it differs from official mozilla URI. # Defaults to whatever MOZ_HTTP_URI was set to. @@ -91,6 +98,8 @@ EXPORT_FUNCTIONS src_unpack src_compile src_install : ${MOZ_LANGPACK_UNOFFICIAL:=""} # @ECLASS-VARIABLE: MOZ_GENERATE_LANGPACKS +# @PRE_INHERIT +# @DEFAULT_UNSET # @DESCRIPTION: # This flag specifies whether or not the langpacks should be # generated directly during the build process, rather than @@ -106,6 +115,8 @@ EXPORT_FUNCTIONS src_unpack src_compile src_install : ${MOZ_L10N_SOURCEDIR:="${WORKDIR}/l10n-sources"} # @ECLASS-VARIABLE: MOZ_L10N_URI_PREFIX +# @PRE_INHERIT +# @DEFAULT_UNSET # @DESCRIPTION: # The full URI prefix of the distfile for each l10n locale. The # AB_CD and MOZ_L10N_URI_SUFFIX will be appended to this to complete the @@ -115,12 +126,14 @@ EXPORT_FUNCTIONS src_unpack src_compile src_install : ${MOZ_L10N_URI_PREFIX:=""} # @ECLASS-VARIABLE: MOZ_L10N_URI_SUFFIX +# @DEFAULT_UNSET # @DESCRIPTION: # The suffix of l10n source distfiles. # Defaults to '.tar.xz' : ${MOZ_L10N_URI_SUFFIX:=".tar.xz"} # @ECLASS-VARIABLE: MOZ_FORCE_UPSTREAM_L10N +# @DEFAULT_UNSET # @DESCRIPTION: # Set this to use upstream langpaks even if the package normally # shouldn't (ie it is an alpha or beta package) diff --git a/eclass/multilib-build.eclass b/eclass/multilib-build.eclass index 585364de6273..e85cee1b94ce 100644 --- a/eclass/multilib-build.eclass +++ b/eclass/multilib-build.eclass @@ -1,4 +1,4 @@ -# Copyright 2013-2020 Gentoo Authors +# Copyright 2013-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: multilib-build.eclass @@ -663,7 +663,6 @@ multilib_native_with() { # of <false1> (or 'no' if unspecified) and <false2>. Arguments # are the same as for usex in the EAPI. # -# Note: in EAPI 4 you need to inherit eutils to use this function. multilib_native_usex() { if multilib_is_native_abi; then usex "${@}" diff --git a/eclass/netsurf.eclass b/eclass/netsurf.eclass index 065ed1e568f3..07b5ab3b5284 100644 --- a/eclass/netsurf.eclass +++ b/eclass/netsurf.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: netsurf.eclass @@ -19,7 +19,7 @@ inherit toolchain-funcs # @FUNCTION: netsurf_define_makeconf # @USAGE: # @DESCRIPTION: -# This function sets NETSURF_MAKECONF as needed by netsurf build system +# This function sets NETSURF_MAKECONF as needed by the netsurf build system netsurf_define_makeconf() { NETSURF_MAKECONF=( PREFIX="${EPREFIX}/usr" diff --git a/eclass/oasis.eclass b/eclass/oasis.eclass index 83e68ae75335..42ad9368f735 100644 --- a/eclass/oasis.eclass +++ b/eclass/oasis.eclass @@ -19,6 +19,7 @@ # Ebuilds using oasis.eclass must be EAPI>=3. # @ECLASS-VARIABLE: OASIS_BUILD_DOCS +# @PRE_INHERIT # @DESCRIPTION: # Will make oasis_src_compile build the documentation if this variable is # defined and the doc useflag is enabled. @@ -27,6 +28,7 @@ # Set before inheriting the eclass. # @ECLASS-VARIABLE: OASIS_BUILD_TESTS +# @PRE_INHERIT # @DESCRIPTION: # Will make oasis_src_configure enable building the tests if the test useflag is # enabled. oasis_src_test will then run them. @@ -38,6 +40,7 @@ # @ECLASS-VARIABLE: OASIS_NO_DEBUG +# @PRE_INHERIT # @DESCRIPTION: # Disable debug useflag usage. Old oasis versions did not support it so we allow # disabling it in those cases. @@ -45,6 +48,7 @@ # Set before inheriting the eclass. # @ECLASS-VARIABLE: OASIS_DOC_DIR +# @PRE_INHERIT # @DESCRIPTION: # Specify where to install documentation. Default is for ocamldoc HTML. # Change it before inherit if this is not what you want. diff --git a/eclass/office-ext-r1.eclass b/eclass/office-ext-r1.eclass index a1649ac8d6aa..a81eea4b6107 100644 --- a/eclass/office-ext-r1.eclass +++ b/eclass/office-ext-r1.eclass @@ -20,6 +20,7 @@ esac EXPORT_FUNCTIONS src_unpack src_install # @ECLASS-VARIABLE: OFFICE_REQ_USE +# @PRE_INHERIT # @DESCRIPTION: # Useflags required on office implementation for the extension. # @@ -45,6 +46,7 @@ fi [[ -z ${OFFICE_IMPLEMENTATIONS} ]] && OFFICE_IMPLEMENTATIONS=( "libreoffice" ) # @ECLASS-VARIABLE: OFFICE_EXTENSIONS +# @PRE_INHERIT # @REQUIRED # @DESCRIPTION: # Array containing list of extensions to install. diff --git a/eclass/opam.eclass b/eclass/opam.eclass index 338ba842cd9c..2789e32d315a 100644 --- a/eclass/opam.eclass +++ b/eclass/opam.eclass @@ -22,6 +22,7 @@ esac QA_FLAGS_IGNORED='.*' # @ECLASS-VARIABLE: OPAM_INSTALLER_DEP +# @PRE_INHERIT # @DESCRIPTION: # Override dependency for OPAM_INSTALLER : ${OPAM_INSTALLER_DEP:="dev-ml/opam-installer"} diff --git a/eclass/openib.eclass b/eclass/openib.eclass index a36f5cd85d02..7810062fae36 100644 --- a/eclass/openib.eclass +++ b/eclass/openib.eclass @@ -1,9 +1,11 @@ -# Copyright 1999-2020 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: openib.eclass +# @MAINTAINER: +# maintainer-needed@gentoo.org # @AUTHOR: -# Original Author: Alexey Shvetsov <alexxy@gentoo.org> +# Author: Alexey Shvetsov <alexxy@gentoo.org> # @BLURB: Simplify working with OFED packages inherit eutils rpm versionator diff --git a/eclass/pax-utils.eclass b/eclass/pax-utils.eclass index 1e109c884b14..209e4831f960 100644 --- a/eclass/pax-utils.eclass +++ b/eclass/pax-utils.eclass @@ -1,4 +1,4 @@ -# Copyright 1999-2019 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: pax-utils.eclass @@ -176,6 +176,10 @@ host-is-pax() { # them elsewhere as they are not supported (i.e. they may be removed # or their function may change arbitrarily). +# @FUNCTION: _pax_list_files +# @INTERNAL +# @USAGE: <command to display items> [items] +# @DESCRIPTION: # Display a list of things, one per line, indented a bit, using the # display command in $1. _pax_list_files() { diff --git a/eclass/perl-module.eclass b/eclass/perl-module.eclass index 7a839bc7288c..4c43c0e67ea1 100644 --- a/eclass/perl-module.eclass +++ b/eclass/perl-module.eclass @@ -1,4 +1,4 @@ -# Copyright 1999-2019 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: perl-module.eclass @@ -172,6 +172,7 @@ LICENSE="${LICENSE:-|| ( Artistic GPL-1+ )}" # Named MODULE_SECTION in EAPI=5. # @ECLASS-VARIABLE: DIST_EXAMPLES +# @PRE_INHERIT # @DEFAULT_UNSET # @DESCRIPTION: # (EAPI=6 and later) This Bash array allows passing a list of example files to be installed @@ -358,6 +359,7 @@ perl-module_src_compile() { # network : do not try to disable network tests # @ECLASS-VARIABLE: DIST_TEST_OVERRIDE +# @USER_VARIABLE # @DEFAULT_UNSET # @DESCRIPTION: # (EAPI=6 and later) Variable that controls if tests are run in the test phase diff --git a/eclass/php-ext-pecl-r3.eclass b/eclass/php-ext-pecl-r3.eclass index 8df60a372053..19040a7e762b 100644 --- a/eclass/php-ext-pecl-r3.eclass +++ b/eclass/php-ext-pecl-r3.eclass @@ -1,4 +1,4 @@ -# Copyright 1999-2016 Gentoo Foundation +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: php-ext-pecl-r3.eclass @@ -11,6 +11,7 @@ # see https://pecl.php.net/ # @ECLASS-VARIABLE: PHP_EXT_PECL_PKG +# @PRE_INHERIT # @DESCRIPTION: # Set in ebuild before inheriting this eclass if the tarball name # differs from ${PN/pecl-/} so that SRC_URI and HOMEPAGE get set @@ -22,6 +23,7 @@ [[ -z "${PHP_EXT_PECL_PKG}" ]] && PHP_EXT_PECL_PKG="${PN/pecl-/}" # @ECLASS-VARIABLE: PHP_EXT_PECL_FILENAME +# @PRE_INHERIT # @DEFAULT_UNSET # @DESCRIPTION: # Set in ebuild before inheriting this eclass if the tarball name diff --git a/eclass/php-ext-source-r3.eclass b/eclass/php-ext-source-r3.eclass index b2eae22fb74d..a782081b72a7 100644 --- a/eclass/php-ext-source-r3.eclass +++ b/eclass/php-ext-source-r3.eclass @@ -1,4 +1,4 @@ -# Copyright 1999-2019 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: php-ext-source-r3.eclass @@ -22,6 +22,7 @@ case ${EAPI:-0} in esac # @ECLASS-VARIABLE: PHP_EXT_NAME +# @PRE_INHERIT # @REQUIRED # @DESCRIPTION: # The extension name. This must be set, otherwise the eclass dies. @@ -87,6 +88,7 @@ esac : ${PHP_INI_NAME:=${PHP_EXT_NAME}} # @ECLASS-VARIABLE: PHP_EXT_NEEDED_USE +# @PRE_INHERIT # @DEFAULT_UNSET # @DESCRIPTION: # A list of USE flags to append to each PHP target selected diff --git a/eclass/php-pear-r2.eclass b/eclass/php-pear-r2.eclass index d3887492047d..f0fe4b96f8ef 100644 --- a/eclass/php-pear-r2.eclass +++ b/eclass/php-pear-r2.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: php-pear-r2.eclass @@ -39,7 +39,8 @@ RDEPEND=">=dev-php/pear-1.8.1" # @ECLASS-VARIABLE: PEAR-P # @INTERNAL -# @DESCRIPTION: Combines PHP_PEAR_PKG_NAME and PEAR_PV +# @DESCRIPTION: +# Combines PHP_PEAR_PKG_NAME and PEAR_PV PEAR_P="${PHP_PEAR_PKG_NAME}-${PEAR_PV}" # @ECLASS-VARIABLE: PHP_PEAR_DOMAIN diff --git a/eclass/portability.eclass b/eclass/portability.eclass index 333a9590b39c..3b085d6c4e70 100644 --- a/eclass/portability.eclass +++ b/eclass/portability.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: portability.eclass @@ -13,7 +13,6 @@ _PORTABILITY_ECLASS=1 # @FUNCTION: treecopy # @USAGE: <orig1> [orig2 orig3 ....] <dest> -# @RETURN: # @DESCRIPTION: # mimic cp --parents copy, but working on BSD userland as well treecopy() { @@ -118,7 +117,6 @@ get_bmake() { # @FUNCTION: get_mounts # @USAGE: # @RETURN: table of mounts in form "point node fs opts" -# @MAINTAINER: # @DESCRIPTION: # Portable method of getting mount names and points. # Returns as "point node fs options" diff --git a/eclass/postgres-multi.eclass b/eclass/postgres-multi.eclass index 49d5c6a9c684..acaa5077217f 100644 --- a/eclass/postgres-multi.eclass +++ b/eclass/postgres-multi.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 inherit multibuild postgres @@ -8,7 +8,8 @@ EXPORT_FUNCTIONS pkg_setup src_prepare src_compile src_install src_test # @ECLASS: postgres-multi.eclass # @MAINTAINER: # PostgreSQL <pgsql-bugs@gentoo.org> -# @AUTHOR: Aaron W. Swenson <titanofold@gentoo.org> +# @AUTHOR: +# Aaron W. Swenson <titanofold@gentoo.org> # @SUPPORTED_EAPIS: 5 6 7 # @BLURB: An eclass to build PostgreSQL-related packages against multiple slots # @DESCRIPTION: @@ -24,6 +25,7 @@ esac # @ECLASS-VARIABLE: POSTGRES_COMPAT +# @PRE_INHERIT # @REQUIRED # @DESCRIPTION: # A Bash array containing a list of compatible PostgreSQL slots as diff --git a/eclass/postgres.eclass b/eclass/postgres.eclass index 2e2ac85ead6f..7652a8625184 100644 --- a/eclass/postgres.eclass +++ b/eclass/postgres.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 inherit user @@ -7,7 +7,8 @@ EXPORT_FUNCTIONS pkg_setup # @ECLASS: postgres.eclass # @MAINTAINER: # PostgreSQL <pgsql-bugs@gentoo.org> -# @AUTHOR: Aaron W. Swenson <titanofold@gentoo.org> +# @AUTHOR: +# Aaron W. Swenson <titanofold@gentoo.org> # @SUPPORTED_EAPIS: 5 6 7 # @BLURB: An eclass for PostgreSQL-related packages # @DESCRIPTION: @@ -32,6 +33,7 @@ _POSTGRES_ALL_VERSIONS=( 9999 13 12 11 10 9.6 9.5 9.4 9.3 9.2 ) # @ECLASS-VARIABLE: POSTGRES_COMPAT +# @PRE_INHERIT # @DEFAULT_UNSET # @DESCRIPTION: # A Bash array containing a list of compatible PostgreSQL slots as @@ -49,6 +51,7 @@ _POSTGRES_ALL_VERSIONS=( 9999 13 12 11 10 9.6 9.5 9.4 9.3 9.2 ) POSTGRES_DEP="dev-db/postgresql:=" # @ECLASS-VARIABLE: POSTGRES_USEDEP +# @PRE_INHERIT # @DEFAULT_UNSET # @DESCRIPTION: # Add the 2-Style and/or 4-Style use dependencies without brackets to be used diff --git a/eclass/qt5-build.eclass b/eclass/qt5-build.eclass index 6698b69b32f4..e94f3f33a101 100644 --- a/eclass/qt5-build.eclass +++ b/eclass/qt5-build.eclass @@ -51,6 +51,7 @@ esac # system to obtain the global qmodule.pri file. # @ECLASS-VARIABLE: VIRTUALX_REQUIRED +# @PRE_INHERIT # @DESCRIPTION: # For proper description see virtualx.eclass man page. # Here we redefine default value to be manual, if your package needs virtualx diff --git a/eclass/ros-catkin.eclass b/eclass/ros-catkin.eclass index 2779a0353ecb..b6f10ce6202d 100644 --- a/eclass/ros-catkin.eclass +++ b/eclass/ros-catkin.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: ros-catkin.eclass @@ -61,11 +61,13 @@ DEPEND="${RDEPEND} " # @ECLASS-VARIABLE: CATKIN_HAS_MESSAGES +# @PRE_INHERIT # @DESCRIPTION: # Set it to a non-empty value before inherit to tell the eclass the package has messages to build. # Messages will be built based on ROS_MESSAGES USE_EXPANDed variable. # @ECLASS-VARIABLE: CATKIN_MESSAGES_TRANSITIVE_DEPS +# @PRE_INHERIT # @DESCRIPTION: # Some messages have dependencies on other messages. # In that case, CATKIN_MESSAGES_TRANSITIVE_DEPS should contain a space-separated list of atoms diff --git a/eclass/ruby-fakegem.eclass b/eclass/ruby-fakegem.eclass index 6fee9eb3e157..715c1df44f6c 100644 --- a/eclass/ruby-fakegem.eclass +++ b/eclass/ruby-fakegem.eclass @@ -17,12 +17,14 @@ inherit ruby-ng # @ECLASS-VARIABLE: RUBY_FAKEGEM_NAME +# @PRE_INHERIT # @DESCRIPTION: # Sets the Gem name for the generated fake gemspec. # This variable MUST be set before inheriting the eclass. RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}" # @ECLASS-VARIABLE: RUBY_FAKEGEM_VERSION +# @PRE_INHERIT # @DESCRIPTION: # Sets the Gem version for the generated fake gemspec. # This variable MUST be set before inheriting the eclass. diff --git a/eclass/ruby-ng.eclass b/eclass/ruby-ng.eclass index e52c507d8010..1933049f4ac2 100644 --- a/eclass/ruby-ng.eclass +++ b/eclass/ruby-ng.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: ruby-ng.eclass @@ -111,6 +111,7 @@ ruby_implementation_depend() { # @FUNCTION: _ruby_get_all_impls # @INTERNAL # @RETURN: list of valid values in USE_RUBY +# @DESCRIPTION: # Return a list of valid implementations in USE_RUBY, skipping the old # implementations that are no longer supported. _ruby_get_all_impls() { diff --git a/eclass/ruby-single.eclass b/eclass/ruby-single.eclass index 4ca5f5ef207b..bf339bc9b601 100644 --- a/eclass/ruby-single.eclass +++ b/eclass/ruby-single.eclass @@ -1,4 +1,4 @@ -# Copyright 1999-2018 Gentoo Foundation +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: ruby-single.eclass @@ -39,6 +39,7 @@ inherit ruby-utils # @ECLASS-VARIABLE: USE_RUBY # @DEFAULT_UNSET +# @PRE_INHERIT # @REQUIRED # @DESCRIPTION: # This variable contains a space separated list of targets (see above) a package diff --git a/eclass/ssl-cert.eclass b/eclass/ssl-cert.eclass index fdd6775ffc77..a774f9b8b9ec 100644 --- a/eclass/ssl-cert.eclass +++ b/eclass/ssl-cert.eclass @@ -1,8 +1,9 @@ -# Copyright 1999-2020 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: ssl-cert.eclass # @MAINTAINER: +# maintainer-needed@gentoo.org # @AUTHOR: # Max Kalika <max@gentoo.org> # @SUPPORTED_EAPIS: 1 2 3 4 5 6 7 @@ -26,16 +27,19 @@ case "${EAPI:-0}" in esac # @ECLASS-VARIABLE: SSL_CERT_MANDATORY +# @PRE_INHERIT # @DESCRIPTION: # Set to non zero if ssl-cert is mandatory for ebuild. : ${SSL_CERT_MANDATORY:=0} # @ECLASS-VARIABLE: SSL_CERT_USE +# @PRE_INHERIT # @DESCRIPTION: # Use flag to append dependency to. : ${SSL_CERT_USE:=ssl} # @ECLASS-VARIABLE: SSL_DEPS_SKIP +# @PRE_INHERIT # @DESCRIPTION: # Set to non zero to skip adding to DEPEND and IUSE. : ${SSL_DEPS_SKIP:=0} @@ -61,12 +65,12 @@ if [[ "${SSL_DEPS_SKIP}" == "0" ]]; then fi # @FUNCTION: gen_cnf +# @INTERNAL # @USAGE: # @DESCRIPTION: # Initializes variables and generates the needed # OpenSSL configuration file and a CA serial file # -# Access: private gen_cnf() { # Location of the config file SSL_CONF="${T}/${$}ssl.cnf" @@ -113,13 +117,13 @@ gen_cnf() { } # @FUNCTION: get_base +# @INTERNAL # @USAGE: [if_ca] # @RETURN: <base path> # @DESCRIPTION: # Simple function to determine whether we're creating # a CA (which should only be done once) or final part # -# Access: private get_base() { if [ "${1}" ] ; then echo "${T}/${$}ca" @@ -129,11 +133,11 @@ get_base() { } # @FUNCTION: gen_key +# @INTERNAL # @USAGE: <base path> # @DESCRIPTION: # Generates an RSA key # -# Access: private gen_key() { local base=$(get_base "$1") ebegin "Generating ${SSL_BITS} bit RSA key${1:+ for CA}" @@ -149,12 +153,12 @@ gen_key() { } # @FUNCTION: gen_csr +# @INTERNAL # @USAGE: <base path> # @DESCRIPTION: # Generates a certificate signing request using # the key made by gen_key() # -# Access: private gen_csr() { local base=$(get_base "$1") ebegin "Generating Certificate Signing Request${1:+ for CA}" @@ -166,6 +170,7 @@ gen_csr() { } # @FUNCTION: gen_crt +# @INTERNAL # @USAGE: <base path> # @DESCRIPTION: # Generates either a self-signed CA certificate using @@ -173,7 +178,6 @@ gen_csr() { # a signed server certificate using the CA cert previously # created by gen_crt() # -# Access: private gen_crt() { local base=$(get_base "$1") if [ "${1}" ] ; then @@ -196,12 +200,12 @@ gen_crt() { } # @FUNCTION: gen_pem +# @INTERNAL # @USAGE: <base path> # @DESCRIPTION: # Generates a PEM file by concatinating the key # and cert file created by gen_key() and gen_cert() # -# Access: private gen_pem() { local base=$(get_base "$1") ebegin "Generating PEM Certificate" @@ -220,7 +224,6 @@ gen_pem() { # # Example: "install_cert /foo/bar" installs ${ROOT}/foo/bar.{key,csr,crt,pem} # -# Access: public install_cert() { if [ $# -lt 1 ] ; then eerror "At least one argument needed" diff --git a/eclass/subversion.eclass b/eclass/subversion.eclass index 36b1fbb0c685..6ed8a62dbe35 100644 --- a/eclass/subversion.eclass +++ b/eclass/subversion.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: subversion.eclass @@ -40,6 +40,7 @@ case ${EAPI} in esac # @ECLASS-VARIABLE: ESVN_STORE_DIR +# @USER_VARIABLE # @DESCRIPTION: # subversion sources store directory. Users may override this in /etc/portage/make.conf [[ -z ${ESVN_STORE_DIR} ]] && ESVN_STORE_DIR="${PORTAGE_ACTUAL_DISTDIR:-${DISTDIR}}/svn-src" @@ -151,6 +152,8 @@ ESVN_PATCHES="${ESVN_PATCHES:-}" ESVN_RESTRICT="${ESVN_RESTRICT:-}" # @ECLASS-VARIABLE: ESVN_OFFLINE +# @USER_VARIABLE +# @DEFAULT_UNSET # @DESCRIPTION: # Set this variable to a non-empty value to disable the automatic updating of # an svn source tree. This is intended to be set outside the subversion source @@ -158,6 +161,7 @@ ESVN_RESTRICT="${ESVN_RESTRICT:-}" ESVN_OFFLINE="${ESVN_OFFLINE:-${EVCS_OFFLINE}}" # @ECLASS-VARIABLE: ESVN_UMASK +# @USER_VARIABLE # @DESCRIPTION: # Set this variable to a custom umask. This is intended to be set by users. # By setting this to something like 002, it can make life easier for people @@ -168,6 +172,7 @@ ESVN_OFFLINE="${ESVN_OFFLINE:-${EVCS_OFFLINE}}" ESVN_UMASK="${ESVN_UMASK:-${EVCS_UMASK}}" # @ECLASS-VARIABLE: ESVN_UP_FREQ +# @USER_VARIABLE # @DESCRIPTION: # Set the minimum number of hours between svn up'ing in any given svn module. This is particularly # useful for split KDE ebuilds where we want to ensure that all submodules are compiled for the same @@ -175,6 +180,7 @@ ESVN_UMASK="${ESVN_UMASK:-${EVCS_UMASK}}" ESVN_UP_FREQ="${ESVN_UP_FREQ:=}" # @ECLASS-VARIABLE: ESCM_LOGDIR +# @USER_VARIABLE # @DESCRIPTION: # User configuration variable. If set to a path such as e.g. /var/log/scm any # package inheriting from subversion.eclass will record svn revision to diff --git a/eclass/texlive-module.eclass b/eclass/texlive-module.eclass index 15988fb4b54d..22b74237a4fb 100644 --- a/eclass/texlive-module.eclass +++ b/eclass/texlive-module.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: texlive-module.eclass @@ -24,6 +24,7 @@ # bash array. # @ECLASS-VARIABLE: TEXLIVE_MODULE_CONTENTS +# @PRE_INHERIT # @REQUIRED # @DESCRIPTION: # The list of packages that will be installed. This variable will be expanded to @@ -31,12 +32,14 @@ # foo -> texlive-module-foo-${PV}.tar.xz # @ECLASS-VARIABLE: TEXLIVE_MODULE_DOC_CONTENTS +# @PRE_INHERIT # @REQUIRED # @DESCRIPTION: # The list of packages that will be installed if the doc useflag is enabled. # Expansion to SRC_URI is the same as for TEXLIVE_MODULE_CONTENTS. # @ECLASS-VARIABLE: TEXLIVE_MODULE_SRC_CONTENTS +# @PRE_INHERIT # @REQUIRED # @DESCRIPTION: # The list of packages that will be installed if the source useflag is enabled. diff --git a/eclass/tmpfiles.eclass b/eclass/tmpfiles.eclass index 632343821648..b9238a6434a0 100644 --- a/eclass/tmpfiles.eclass +++ b/eclass/tmpfiles.eclass @@ -1,4 +1,4 @@ -# Copyright 2016-2019 Gentoo Authors +# Copyright 2016-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: tmpfiles.eclass @@ -61,6 +61,7 @@ case "${EAPI}" in esac # @ECLASS-VARIABLE: TMPFILES_OPTIONAL +# @PRE_INHERIT # @DEFAULT_UNSET # @DESCRIPTION: # When not empty, disables the dependency on virtual/tmpfiles. diff --git a/eclass/unpacker.eclass b/eclass/unpacker.eclass index 3a1dc9f29f33..d01a6e8e648a 100644 --- a/eclass/unpacker.eclass +++ b/eclass/unpacker.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: unpacker.eclass @@ -20,6 +20,7 @@ _UNPACKER_ECLASS=1 inherit toolchain-funcs # @ECLASS-VARIABLE: UNPACKER_BZ2 +# @USER_VARIABLE # @DEFAULT_UNSET # @DESCRIPTION: # Utility to use to decompress bzip2 files. Will dynamically pick between @@ -27,6 +28,7 @@ inherit toolchain-funcs # Note: this is meant for users to set, not ebuilds. # @ECLASS-VARIABLE: UNPACKER_LZIP +# @USER_VARIABLE # @DEFAULT_UNSET # @DESCRIPTION: # Utility to use to decompress lzip files. Will dynamically pick between diff --git a/eclass/user.eclass b/eclass/user.eclass index f8993b827741..96d3757233b9 100644 --- a/eclass/user.eclass +++ b/eclass/user.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: user.eclass @@ -100,7 +100,7 @@ enewuser() { # get the username local euser=$1; shift if [[ -z ${euser} ]] ; then - eerror "No username specified !" + eerror "No username specified!" die "Cannot call enewuser without a username" fi @@ -122,7 +122,7 @@ enewuser() { euid="next" fi else - eerror "Userid given but is not greater than 0 !" + eerror "Userid given but is not greater than 0!" die "${euid} is not a valid UID" fi else @@ -142,7 +142,7 @@ enewuser() { local eshell=$1; shift if [[ ! -z ${eshell} ]] && [[ ${eshell} != "-1" ]] ; then if [[ ! -e ${ROOT}${eshell} ]] ; then - eerror "A shell was specified but it does not exist !" + eerror "A shell was specified but it does not exist!" die "${eshell} does not exist in ${ROOT}" fi if [[ ${eshell} == */false || ${eshell} == */nologin ]] ; then @@ -254,7 +254,7 @@ enewgroup() { # get the group local egroup=$1; shift if [[ -z ${egroup} ]] ; then - eerror "No group specified !" + eerror "No group specified!" die "Cannot call enewgroup without a group" fi @@ -273,7 +273,7 @@ enewgroup() { egid="next available; requested gid taken" fi else - eerror "Groupid given but is not greater than 0 !" + eerror "Groupid given but is not greater than 0!" die "${egid} is not a valid GID" fi else @@ -339,7 +339,7 @@ esethome() { # get the username local euser=$1; shift if [[ -z ${euser} ]] ; then - eerror "No username specified !" + eerror "No username specified!" die "Cannot call esethome without a username" fi @@ -352,7 +352,7 @@ esethome() { # handle homedir local ehome=$1; shift if [[ -z ${ehome} ]] ; then - eerror "No home directory specified !" + eerror "No home directory specified!" die "Cannot call esethome without a home directory or '-1'" fi @@ -408,7 +408,7 @@ esetshell() { # get the username local euser=$1; shift if [[ -z ${euser} ]] ; then - eerror "No username specified !" + eerror "No username specified!" die "Cannot call esetshell without a username" fi @@ -421,7 +421,7 @@ esetshell() { # handle shell local eshell=$1; shift if [[ -z ${eshell} ]] ; then - eerror "No shell specified !" + eerror "No shell specified!" die "Cannot call esetshell without a shell or '-1'" fi @@ -468,7 +468,7 @@ esetcomment() { # get the username local euser=$1; shift if [[ -z ${euser} ]] ; then - eerror "No username specified !" + eerror "No username specified!" die "Cannot call esetcomment without a username" fi @@ -481,7 +481,7 @@ esetcomment() { # handle comment local ecomment=$1; shift if [[ -z ${ecomment} ]] ; then - eerror "No comment specified !" + eerror "No comment specified!" die "Cannot call esetcomment without a comment" fi diff --git a/eclass/vim-spell.eclass b/eclass/vim-spell.eclass index 828a45310e9d..f762a6bfd315 100644 --- a/eclass/vim-spell.eclass +++ b/eclass/vim-spell.eclass @@ -1,4 +1,4 @@ -# Copyright 1999-2017 Gentoo Foundation +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: vim-spell.eclass @@ -62,8 +62,6 @@ # spell files. It's best to let upstream know if you've generated spell files # for another language rather than keeping them Gentoo-specific. -inherit eutils - EXPORT_FUNCTIONS src_install pkg_postinst SRC_URI="mirror://gentoo/${P}.tar.bz2" diff --git a/eclass/virtualx.eclass b/eclass/virtualx.eclass index fa16784bd943..a95f8a7e1c14 100644 --- a/eclass/virtualx.eclass +++ b/eclass/virtualx.eclass @@ -1,4 +1,4 @@ -# Copyright 1999-2019 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: virtualx.eclass @@ -25,6 +25,7 @@ esac [[ ${EAPI} == [45] ]] && inherit eutils # @ECLASS-VARIABLE: VIRTUALX_REQUIRED +# @PRE_INHERIT # @DESCRIPTION: # Variable specifying the dependency on xorg-server and xhost. # Possible special values are "always" and "manual", which specify diff --git a/eclass/webapp.eclass b/eclass/webapp.eclass index b0a8f7a34d4d..6907ef1c321d 100644 --- a/eclass/webapp.eclass +++ b/eclass/webapp.eclass @@ -1,4 +1,4 @@ -# Copyright 1999-2019 Gentoo Authors +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: webapp.eclass @@ -16,12 +16,14 @@ WEBAPP_DEPEND=">=app-admin/webapp-config-1.50.15" # @ECLASS-VARIABLE: WEBAPP_NO_AUTO_INSTALL +# @PRE_INHERIT # @DESCRIPTION: # An ebuild sets this to `yes' if an automatic installation and/or upgrade is # not possible. The ebuild should overwrite pkg_postinst() and explain the # reason for this BEFORE calling webapp_pkg_postinst(). # @ECLASS-VARIABLE: WEBAPP_OPTIONAL +# @PRE_INHERIT # @DESCRIPTION: # An ebuild sets this to `yes' to make webapp support optional, in which case # you also need to take care of USE-flags and dependencies. diff --git a/eclass/xemacs-packages.eclass b/eclass/xemacs-packages.eclass index a40487bae78e..372e4c5301cf 100644 --- a/eclass/xemacs-packages.eclass +++ b/eclass/xemacs-packages.eclass @@ -1,4 +1,4 @@ -# Copyright 1999-2017 Gentoo Foundation +# Copyright 1999-2021 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 # @ECLASS: xemacs-packages.eclass @@ -15,6 +15,7 @@ # mule, or contrib. # @ECLASS-VARIABLE: XEMACS_EXPERIMENTAL +# @PRE_INHERIT # @DEFAULT_UNSET # @DESCRIPTION: # If set then the package is downloaded from the experimental packages diff --git a/eclass/xorg-2.eclass b/eclass/xorg-2.eclass index 21b3da5374a9..e6ec80523ae2 100644 --- a/eclass/xorg-2.eclass +++ b/eclass/xorg-2.eclass @@ -43,6 +43,7 @@ if [[ ${CATEGORY} = media-fonts ]]; then fi # @ECLASS-VARIABLE: XORG_MULTILIB +# @PRE_INHERIT # @DESCRIPTION: # If set to 'yes', the multilib support for package will be enabled. Set # before inheriting this eclass. @@ -68,18 +69,21 @@ EXPORT_FUNCTIONS ${EXPORTED_FUNCTIONS} IUSE="" # @ECLASS-VARIABLE: XORG_EAUTORECONF +# @PRE_INHERIT # @DESCRIPTION: # If set to 'yes' and configure.ac exists, eautoreconf will run. Set # before inheriting this eclass. : ${XORG_EAUTORECONF:="no"} # @ECLASS-VARIABLE: XORG_BASE_INDIVIDUAL_URI +# @PRE_INHERIT # @DESCRIPTION: # Set up SRC_URI for individual modular releases. If set to an empty # string, no SRC_URI will be provided by the eclass. : ${XORG_BASE_INDIVIDUAL_URI="https://www.x.org/releases/individual"} # @ECLASS-VARIABLE: XORG_MODULE +# @PRE_INHERIT # @DESCRIPTION: # The subdirectory to download source from. Possible settings are app, # doc, data, util, driver, font, lib, proto, xserver. Set above the @@ -99,6 +103,7 @@ if [[ ${XORG_MODULE} == auto ]]; then fi # @ECLASS-VARIABLE: XORG_PACKAGE_NAME +# @PRE_INHERIT # @DESCRIPTION: # For git checkout the git repository might differ from package name. # This variable can be used for proper directory specification @@ -148,6 +153,7 @@ if [[ ${FONT} == yes ]]; then >=x11-apps/mkfontscale-1.2.0" # @ECLASS-VARIABLE: FONT_DIR + # @PRE_INHERIT # @DESCRIPTION: # If you're creating a font package and the suffix of PN is not equal to # the subdirectory of /usr/share/fonts/ it should install into, set diff --git a/eclass/xorg-3.eclass b/eclass/xorg-3.eclass index 811168ead986..7ed96c60848a 100644 --- a/eclass/xorg-3.eclass +++ b/eclass/xorg-3.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: xorg-3.eclass @@ -42,6 +42,7 @@ if [[ ${CATEGORY} = media-fonts ]]; then fi # @ECLASS-VARIABLE: XORG_MULTILIB +# @PRE_INHERIT # @DESCRIPTION: # If set to 'yes', the multilib support for package will be enabled. Set # before inheriting this eclass. @@ -67,18 +68,21 @@ EXPORT_FUNCTIONS ${EXPORTED_FUNCTIONS} IUSE="" # @ECLASS-VARIABLE: XORG_EAUTORECONF +# @PRE_INHERIT # @DESCRIPTION: # If set to 'yes' and configure.ac exists, eautoreconf will run. Set # before inheriting this eclass. : ${XORG_EAUTORECONF:="no"} # @ECLASS-VARIABLE: XORG_BASE_INDIVIDUAL_URI +# @PRE_INHERIT # @DESCRIPTION: # Set up SRC_URI for individual modular releases. If set to an empty # string, no SRC_URI will be provided by the eclass. : ${XORG_BASE_INDIVIDUAL_URI="https://www.x.org/releases/individual"} # @ECLASS-VARIABLE: XORG_MODULE +# @PRE_INHERIT # @DESCRIPTION: # The subdirectory to download source from. Possible settings are app, # doc, data, util, driver, font, lib, proto, xserver. Set above the @@ -99,6 +103,7 @@ if [[ ${XORG_MODULE} == auto ]]; then fi # @ECLASS-VARIABLE: XORG_PACKAGE_NAME +# @PRE_INHERIT # @DESCRIPTION: # For git checkout the git repository might differ from package name. # This variable can be used for proper directory specification @@ -107,6 +112,7 @@ fi HOMEPAGE="https://www.x.org/wiki/ https://gitlab.freedesktop.org/xorg/${XORG_MODULE}${XORG_PACKAGE_NAME}" # @ECLASS-VARIABLE: XORG_TARBALL_SUFFIX +# @PRE_INHERIT # @DESCRIPTION: # Most X11 projects provide tarballs as tar.bz2 or tar.xz. This eclass defaults # to bz2. @@ -156,6 +162,7 @@ if [[ ${FONT} == yes ]]; then BDEPEND+=" x11-apps/bdftopcf" # @ECLASS-VARIABLE: FONT_DIR + # @PRE_INHERIT # @DESCRIPTION: # If you're creating a font package and the suffix of PN is not equal to # the subdirectory of /usr/share/fonts/ it should install into, set @@ -172,6 +179,7 @@ fi BDEPEND+=" virtual/pkgconfig" # @ECLASS-VARIABLE: XORG_DRI +# @PRE_INHERIT # @DESCRIPTION: # Possible values are "always" or the value of the useflag DRI capabilities # are required for. Default value is "no" @@ -205,6 +213,7 @@ fi # @ECLASS-VARIABLE: XORG_DOC +# @PRE_INHERIT # @DESCRIPTION: # Possible values are "always" or the value of the useflag doc packages # are required for. Default value is "no" |