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/distutils-r1.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/distutils-r1.eclass')
-rw-r--r--eclass/distutils-r1.eclass37
1 files changed, 0 insertions, 37 deletions
diff --git a/eclass/distutils-r1.eclass b/eclass/distutils-r1.eclass
index d626d816369c..5ffc91be479c 100644
--- a/eclass/distutils-r1.eclass
+++ b/eclass/distutils-r1.eclass
@@ -95,11 +95,6 @@ esac
# It needs to be set before the inherit line.
: ${DISTUTILS_USE_SETUPTOOLS:=bdepend}
-# @VARIABLE: _DISTUTILS_R1
-# @INTERNAL
-# @DESCRIPTION:
-# Please document me
-
if [[ ! ${_DISTUTILS_R1} ]]; then
[[ ${EAPI} == [456] ]] && inherit eutils
@@ -1198,66 +1193,34 @@ distutils-r1_src_install() {
# -- distutils.eclass functions --
-# @FUNCTION: distutils_get_intermediate_installation_image
-# @INTERNAL
-# @DESCRIPTION:
-# Die and warn when function from previous distutils is called
distutils_get_intermediate_installation_image() {
die "${FUNCNAME}() is invalid for distutils-r1"
}
-# @FUNCTION: distutils_src_unpack
-# @INTERNAL
-# @DESCRIPTION:
-# Die and warn when function from previous distutils is called
distutils_src_unpack() {
die "${FUNCNAME}() is invalid for distutils-r1, and you don't want it in EAPI ${EAPI} anyway"
}
-# @FUNCTION: distutils_src_prepare
-# @INTERNAL
-# @DESCRIPTION:
-# Die and warn when function from previous distutils is called
distutils_src_prepare() {
die "${FUNCNAME}() is invalid for distutils-r1, you probably want: ${FUNCNAME/_/-r1_}"
}
-# @FUNCTION: distutils_src_compile
-# @INTERNAL
-# @DESCRIPTION:
-# Die and warn when function from previous distutils is called
distutils_src_compile() {
die "${FUNCNAME}() is invalid for distutils-r1, you probably want: ${FUNCNAME/_/-r1_}"
}
-# @FUNCTION: distutils_src_test
-# @INTERNAL
-# @DESCRIPTION:
-# Die and warn when function from previous distutils is called
distutils_src_test() {
die "${FUNCNAME}() is invalid for distutils-r1, you probably want: ${FUNCNAME/_/-r1_}"
}
-# @FUNCTION: distutils_src_install
-# @INTERNAL
-# @DESCRIPTION:
-# Die and warn when function from previous distutils is called
distutils_src_install() {
die "${FUNCNAME}() is invalid for distutils-r1, you probably want: ${FUNCNAME/_/-r1_}"
}
-# @FUNCTION: distutils_pkg_postinst
-# @INTERNAL
-# @DESCRIPTION:
-# Die and warn when function from previous distutils is called
distutils_pkg_postinst() {
die "${FUNCNAME}() is invalid for distutils-r1, and pkg_postinst is unnecessary"
}
-# @FUNCTION: distutils_pkg_postrm
-# @INTERNAL
-# @DESCRIPTION:
-# Die and warn when function from previous distutils is called
distutils_pkg_postrm() {
die "${FUNCNAME}() is invalid for distutils-r1, and pkg_postrm is unnecessary"
}