summaryrefslogtreecommitdiff
path: root/eclass
diff options
context:
space:
mode:
Diffstat (limited to 'eclass')
-rw-r--r--eclass/base.eclass5
-rw-r--r--eclass/flag-o-matic.eclass2
-rw-r--r--eclass/mysql-multilib-r1.eclass4
-rw-r--r--eclass/mysql-v2.eclass1
-rw-r--r--eclass/mysql_fx.eclass41
-rw-r--r--eclass/php-lib-r1.eclass4
-rw-r--r--eclass/php-pear-r1.eclass5
-rw-r--r--eclass/php-pear-r2.eclass5
-rw-r--r--eclass/ruby-ng.eclass1
-rw-r--r--eclass/ruby-single.eclass3
-rw-r--r--eclass/ruby-utils.eclass3
-rw-r--r--eclass/sgml-catalog.eclass4
12 files changed, 55 insertions, 23 deletions
diff --git a/eclass/base.eclass b/eclass/base.eclass
index 0a7db1d4992e..edb50a4184b3 100644
--- a/eclass/base.eclass
+++ b/eclass/base.eclass
@@ -1,4 +1,4 @@
-# Copyright 1999-2014 Gentoo Foundation
+# Copyright 1999-2017 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# DEPRECATED
@@ -41,18 +41,21 @@ esac
EXPORT_FUNCTIONS ${BASE_EXPF}
# @ECLASS-VARIABLE: DOCS
+# @DEFAULT_UNSET
# @DESCRIPTION:
# Array containing documents passed to dodoc command.
#
# DOCS=( "${S}/doc/document.txt" "${S}/doc/doc_folder/" )
# @ECLASS-VARIABLE: HTML_DOCS
+# @DEFAULT_UNSET
# @DESCRIPTION:
# Array containing documents passed to dohtml command.
#
# HTML_DOCS=( "${S}/doc/document.html" "${S}/doc/html_folder/" )
# @ECLASS-VARIABLE: PATCHES
+# @DEFAULT_UNSET
# @DESCRIPTION:
# PATCHES array variable containing all various patches to be applied.
# This variable is expected to be defined in global scope of ebuild.
diff --git a/eclass/flag-o-matic.eclass b/eclass/flag-o-matic.eclass
index 4e3cfff5afd5..d14221624d6d 100644
--- a/eclass/flag-o-matic.eclass
+++ b/eclass/flag-o-matic.eclass
@@ -16,7 +16,7 @@ inherit eutils toolchain-funcs multilib
# Return all the flag variables that our high level funcs operate on.
all-flag-vars() {
- echo {C,CPP,CXX,CCAS,F,FC,LD}FLAGS
+ echo {ADA,C,CPP,CXX,CCAS,F,FC,LD}FLAGS
}
# {C,CPP,CXX,CCAS,F,FC,LD}FLAGS that we allow in strip-flags
diff --git a/eclass/mysql-multilib-r1.eclass b/eclass/mysql-multilib-r1.eclass
index cfe684bc5db1..16f969a09266 100644
--- a/eclass/mysql-multilib-r1.eclass
+++ b/eclass/mysql-multilib-r1.eclass
@@ -20,20 +20,24 @@
MYSQL_EXTRAS=""
# @ECLASS-VARIABLE: MYSQL_EXTRAS_VER
+# @DEFAULT_UNSET
# @DESCRIPTION:
# The version of the MYSQL_EXTRAS repo to use to build mysql
# Use "none" to disable it's use
[[ ${MY_EXTRAS_VER} == "live" ]] && MYSQL_EXTRAS="git-r3"
# @ECLASS-VARIABLE: MYSQL_CMAKE_NATIVE_DEFINES
+# @DEFAULT_UNSET
# @DESCRIPTION:
# An array of extra CMake arguments for native multilib builds
# @ECLASS-VARIABLE: MYSQL_CMAKE_NONNATIVE_DEFINES
+# @DEFAULT_UNSET
# @DESCRIPTION:
# An array of extra CMake arguments for non-native multilib builds
# @ECLASS-VARIABLE: MYSQL_CMAKE_EXTRA_DEFINES
+# @DEFAULT_UNSET
# @DESCRIPTION:
# An array of CMake arguments added to native and non-native
diff --git a/eclass/mysql-v2.eclass b/eclass/mysql-v2.eclass
index 94a36dc43547..766d5641014a 100644
--- a/eclass/mysql-v2.eclass
+++ b/eclass/mysql-v2.eclass
@@ -41,6 +41,7 @@ esac
MYSQL_EXTRAS=""
# @ECLASS-VARIABLE: MYSQL_EXTRAS_VER
+# @DEFAULT_UNSET
# @DESCRIPTION:
# The version of the MYSQL_EXTRAS repo to use to build mysql
# Use "none" to disable it's use
diff --git a/eclass/mysql_fx.eclass b/eclass/mysql_fx.eclass
index ef9e36f58575..9d1e5967f673 100644
--- a/eclass/mysql_fx.eclass
+++ b/eclass/mysql_fx.eclass
@@ -1,17 +1,26 @@
-# Copyright 1999-2014 Gentoo Foundation
+# Copyright 1999-2017 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
-# Author: Francesco Riosa (Retired) <vivo@gentoo.org>
-# Maintainer:
+# DEPRECATED
+# Recent versions have begun deprecating this eclass.
+# Do not use it in new series.
+
+# @ECLASS: mysql_fx.eclass
+# @AUTHOR: Francesco Riosa (Retired) <vivo@gentoo.org>
+# @MAINTAINER:
# - MySQL Team <mysql-bugs@gentoo.org>
# - Luca Longinotti <chtekk@gentoo.org>
+# @BLURB: This eclass provides some helper functions for mysql ebuilds
+# @DESCRIPTION:
+# This eclass providers helpers to build mysql servers including patching
+# from an index and initializing certain variables as part of the build.
inherit multilib
-#
+# @FUNCTION: stripdots
+# @DESCRIPTION:
# Helper function, version (integer) may have sections separated by dots
# for readability.
-#
stripdots() {
local dotver=${1:-"0"}
local v=""
@@ -39,12 +48,12 @@ stripdots() {
fi
}
-#
+# @FUNCTION: mysql_check_version_range
+# @DESCRIPTION:
# Check if a version number falls inside a given range.
# The range includes the extremes and must be specified as
# "low_version to high_version" i.e. "4.1.2 to 5.1.99.99".
# Returns true if inside the range.
-#
mysql_check_version_range() {
local lbound="${1%% to *}" ; lbound=$(stripdots "${lbound}")
local rbound="${1#* to }" ; rbound=$(stripdots "${rbound}")
@@ -53,9 +62,10 @@ mysql_check_version_range() {
return 1
}
-#
+# @FUNCTION: _mysql_test_patch_ver_pn
+# @INTERNAL
+# @DESCRIPTION:
# True if at least one applicable range is found for the patch.
-#
_mysql_test_patch_ver_pn() {
local allelements=", version, package name"
# So that it fails the directory test if none of them exist
@@ -88,7 +98,8 @@ _mysql_test_patch_ver_pn() {
return 1
}
-#
+# @FUNCTION: mysql_mv_patches
+# @DESCRIPTION:
# Parse a "index_file" looking for patches to apply to the
# current MySQL version.
# If the patch applies, print its description.
@@ -119,6 +130,8 @@ mysql_mv_patches() {
_mysql_mv_patches "${index_file}" "${my_ver}" "${my_test_fx}"
}
+# @FUNCTION: _mysql_mv_patches
+# @INTERNAL
_mysql_mv_patches() {
local index_file="${1}"
local my_ver="${2}"
@@ -168,7 +181,8 @@ _mysql_mv_patches() {
&& for (( i=0 ; $i < $ndsc ; i++ )) ; do einfo "> ${dsc[$i]}" ; done
}
-#
+# @FUNCTION: mysql_version_is_at_least
+# @DESCRIPTION:
# Is $2 (defaults to $MYSQL_VERSION_ID) at least version $1?
# (nice) idea from versionator.eclass
#
@@ -178,9 +192,10 @@ mysql_version_is_at_least() {
[[ ${want_s} -le ${have_s} ]] && return 0 || return 1
}
-#
+# @FUNCTION: mysql_lib_symlinks
+# @DESCRIPTION:
# To be called on the live filesystem, reassigning symlinks of each MySQL
-# library to the best version available.
+# library to the best version available. (Obsolete)
#
mysql_lib_symlinks() {
diff --git a/eclass/php-lib-r1.eclass b/eclass/php-lib-r1.eclass
index a6bffabc6fbd..90edad61f9ca 100644
--- a/eclass/php-lib-r1.eclass
+++ b/eclass/php-lib-r1.eclass
@@ -1,6 +1,7 @@
-# Copyright 1999-2015 Gentoo Foundation
+# Copyright 1999-2017 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
+# @DEAD
# @ECLASS: php-lib-r1.eclass
# @MAINTAINER:
# Gentoo PHP team <php-bugs@gentoo.org>
@@ -37,6 +38,7 @@ RDEPEND="${DEPEND}"
# You have to pass in a list of the PHP files to install.
# @VARIABLE: DOCS
+# @DEFAULT_UNSET
# @DESCRIPTION:
# Set in ebuild if you wish to install additional, package-specific documentation.
diff --git a/eclass/php-pear-r1.eclass b/eclass/php-pear-r1.eclass
index 9e3071d605f4..aac801f79d4f 100644
--- a/eclass/php-pear-r1.eclass
+++ b/eclass/php-pear-r1.eclass
@@ -1,4 +1,4 @@
-# Copyright 1999-2016 Gentoo Foundation
+# Copyright 1999-2017 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# @ECLASS: php-pear-r1.eclass
@@ -42,7 +42,7 @@ RDEPEND="${DEPEND}"
[[ -z "${PHP_PEAR_PKG_NAME}" ]] && PHP_PEAR_PKG_NAME="${PN/PEAR-/}"
fix_PEAR_PV() {
- tmp="${PV}"
+ local tmp="${PV}"
tmp="${tmp/_/}"
tmp="${tmp/rc/RC}"
tmp="${tmp/beta/b}"
@@ -51,6 +51,7 @@ fix_PEAR_PV() {
}
# @ECLASS-VARIABLE: PEAR_PV
+# @DEFAULT: PV with _rc->RC, _beta->b, _alpha->a, _pre->pre, _p->p
# @DESCRIPTION:
# Set in ebuild if the eclass ${PV} mangling breaks SRC_URI for alpha/beta/rc versions
[[ -z "${PEAR_PV}" ]] && fix_PEAR_PV
diff --git a/eclass/php-pear-r2.eclass b/eclass/php-pear-r2.eclass
index dad075686bf3..11bb07388349 100644
--- a/eclass/php-pear-r2.eclass
+++ b/eclass/php-pear-r2.eclass
@@ -36,6 +36,9 @@ RDEPEND=">=dev-php/pear-1.8.1"
# Set in ebuild if the ${PV} breaks SRC_URI for alpha/beta/rc versions
: ${PEAR_PV:=${PV}}
+# @ECLASS-VARIABLE: PEAR-P
+# @INTERNAL
+# @DESCRIPTION: Combines PHP_PEAR_PKG_NAME and PEAR_PV
PEAR_P="${PHP_PEAR_PKG_NAME}-${PEAR_PV}"
# @ECLASS-VARIABLE: PHP_PEAR_DOMAIN
@@ -60,7 +63,7 @@ fi
S="${WORKDIR}/${PEAR_P}"
-# @FUNCTION php-pear-r2_install_packagexml
+# @FUNCTION: php-pear-r2_install_packagexml
# @DESCRIPTION:
# Copies the package2.xml or package.xml file and, optionally, the channel.xml
# file to a Gentoo-specific location so that pkg_postinst can install the package
diff --git a/eclass/ruby-ng.eclass b/eclass/ruby-ng.eclass
index 51ab397bb560..e9d0f33e5580 100644
--- a/eclass/ruby-ng.eclass
+++ b/eclass/ruby-ng.eclass
@@ -43,6 +43,7 @@
# A String or Array of filenames of patches to apply to all implementations.
# @ECLASS-VARIABLE: RUBY_OPTIONAL
+# @DEFAULT_UNSET
# @DESCRIPTION:
# Set the value to "yes" to make the dependency on a Ruby interpreter
# optional and then ruby_implementations_depend() to help populate
diff --git a/eclass/ruby-single.eclass b/eclass/ruby-single.eclass
index 17e174524444..c42b8911ef2d 100644
--- a/eclass/ruby-single.eclass
+++ b/eclass/ruby-single.eclass
@@ -1,4 +1,4 @@
-# Copyright 1999-2016 Gentoo Foundation
+# Copyright 1999-2017 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# @ECLASS: ruby-single.eclass
@@ -46,6 +46,7 @@ inherit ruby-utils
# @ECLASS-VARIABLE: RUBY_DEPS
+# @DEFAULT_UNSET
# @DESCRIPTION:
#
# This is an eclass-generated Ruby dependency string for all
diff --git a/eclass/ruby-utils.eclass b/eclass/ruby-utils.eclass
index 3c6a22e74dc5..854ce06ac050 100644
--- a/eclass/ruby-utils.eclass
+++ b/eclass/ruby-utils.eclass
@@ -1,4 +1,4 @@
-# Copyright 1999-2015 Gentoo Foundation
+# Copyright 1999-2017 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# @ECLASS: ruby-utils.eclass
@@ -19,6 +19,7 @@ if [[ ! ${_RUBY_UTILS} ]]; then
# @ECLASS-VARIABLE: RUBY_TARGETS_PREFERENCE
+# @INTERNAL
# @DESCRIPTION:
# This variable lists all the known ruby targets in preference of use as
# determined by the ruby team. By using this ordering rather than the
diff --git a/eclass/sgml-catalog.eclass b/eclass/sgml-catalog.eclass
index 08f78c59782f..7cc51fe3fdf4 100644
--- a/eclass/sgml-catalog.eclass
+++ b/eclass/sgml-catalog.eclass
@@ -1,9 +1,9 @@
-# Copyright 1999-2012 Gentoo Foundation
+# Copyright 1999-2017 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# @ECLASS: sgml-catalog.eclass
# @MAINTAINER:
-# SGML Herd <sgml@gentoo.org>
+# No maintainer <maintainer-needed@gentoo.org>
# @AUTHOR:
# Author Matthew Turk <satai@gentoo.org>
# @BLURB: Functions for installing SGML catalogs
generated by cgit v1.2.3 (git 2.25.1) at 2024-10-11 19:25:42 +0000