commit:     f80b0acf7f78971b601aabb913e067a0dde70268
Author:     Matt Whitlock <gentoo <AT> mattwhitlock <DOT> name>
AuthorDate: Fri Mar 18 21:44:05 2022 +0000
Commit:     Michał Górny <mgorny <AT> gentoo <DOT> org>
CommitDate: Sat Aug 19 18:28:11 2023 +0000
URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=f80b0acf

python{,-any}-r1.eclass: use python_has_version in examples

The python_check_deps() examples given in the documentation of several
functions and variables in python-r1.eclass and python-any-r1.eclass are
incorrect. The default behavior of has_version() is to check the
*runtime* system (RDEPEND), but python_check_deps() is meant to check
that the *build* system (BDEPEND) has a suitable Python environment. The
examples fail to do this and thus likely are leading developers to write
incorrect python_check_deps() functions in their ebuilds. Thankfully,
python-utils-r1.eclass supplies a python_has_version() function that
defaults to checking the build system and implements some other
enhancements that make it nicer for use in python_check_deps(). Change
the examples to use python_has_version.

Closes: https://bugs.gentoo.org/835462
Signed-off-by: Matt Whitlock <gentoo <AT> mattwhitlock.name>
Signed-off-by: Michał Górny <mgorny <AT> gentoo.org>

 eclass/python-any-r1.eclass |  6 +++---
 eclass/python-r1.eclass     | 10 +++++-----
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/eclass/python-any-r1.eclass b/eclass/python-any-r1.eclass
index 4e2e12e228ad..a21df8e89498 100644
--- a/eclass/python-any-r1.eclass
+++ b/eclass/python-any-r1.eclass
@@ -221,9 +221,9 @@ unset -f _python_any_set_globals
 #              dev-python/baz[${PYTHON_USEDEP}] )')"
 #
 # python_check_deps() {
-#      python_has_version "dev-python/foo[${PYTHON_SINGLE_USEDEP}]" \
-#              && { python_has_version "dev-python/bar[${PYTHON_USEDEP}]" \
-#                      || python_has_version 
"dev-python/baz[${PYTHON_USEDEP}]"; }
+#      python_has_version "dev-python/foo[${PYTHON_SINGLE_USEDEP}]" &&
+#              { python_has_version "dev-python/bar[${PYTHON_USEDEP}]" ||
+#                      python_has_version "dev-python/baz[${PYTHON_USEDEP}]"; }
 # }
 # @CODE
 #

diff --git a/eclass/python-r1.eclass b/eclass/python-r1.eclass
index b816e3b6f855..303737e41589 100644
--- a/eclass/python-r1.eclass
+++ b/eclass/python-r1.eclass
@@ -156,7 +156,7 @@ inherit multibuild python-utils-r1
 # Example use:
 # @CODE
 # python_check_deps() {
-#      has_version "dev-python/bar[${PYTHON_SINGLE_USEDEP}]"
+#      python_has_version "dev-python/bar[${PYTHON_SINGLE_USEDEP}]"
 # }
 # @CODE
 #
@@ -474,9 +474,9 @@ python_gen_impl_dep() {
 #              dev-python/baz[${PYTHON_USEDEP}] )' -2)"
 #
 # python_check_deps() {
-#      has_version "dev-python/foo[${PYTHON_SINGLE_USEDEP}]" \
-#              && { has_version "dev-python/bar[${PYTHON_USEDEP}]" \
-#                      || has_version "dev-python/baz[${PYTHON_USEDEP}]"; }
+#      python_has_version "dev-python/foo[${PYTHON_SINGLE_USEDEP}]" &&
+#              { python_has_version "dev-python/bar[${PYTHON_USEDEP}]" ||
+#                      python_has_version "dev-python/baz[${PYTHON_USEDEP}]"; }
 # }
 #
 # src_compile() {
@@ -692,7 +692,7 @@ python_foreach_impl() {
 #      $(python_gen_any_dep 'dev-python/epydoc[${PYTHON_USEDEP}]' 'python2*') 
)"
 #
 # python_check_deps() {
-#      has_version "dev-python/epydoc[${PYTHON_USEDEP}]"
+#      use !doc || python_has_version "dev-python/epydoc[${PYTHON_USEDEP}]"
 # }
 #
 # src_compile() {

Reply via email to