[gentoo-dev] [PATCH] distutils-r1.eclass: Namespace & doc _clean_egg_info

[gentoo-dev] [PATCH] distutils-r1.eclass: Namespace & doc _clean_egg_info

[Michał Górny]

Prefix the _clean_egg_info function with an appropriate namespace,
and document its purpose with eclassdoc format. Be more verbose
on the exact problem being solved; remove URL to old upstream bug
tracker that no longer exists.
---
 eclass/distutils-r1.eclass | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

** REVIEW NOTE **

Do we still need this hack? Is there any chance the issue has been
fixed upstream? Can someone test it and find a bug upstream and/or
re-report it?

diff --git a/eclass/distutils-r1.eclass b/eclass/distutils-r1.eclass
index 5df7234332d3..1376326c9579 100644
--- a/eclass/distutils-r1.eclass
+++ b/eclass/distutils-r1.eclass
@@ -770,10 +770,14 @@ distutils-r1_src_compile() {
 	fi
 }
 
-_clean_egg_info() {
-	# Work around for setuptools test behavior (bug 534058).
-	# https://bitbucket.org/pypa/setuptools/issue/292
-	rm -rf "${BUILD_DIR}"/lib/*.egg-info
+# @FUNCTION: _distutils-r1_clean_egg_info
+# @INTERNAL
+# @DESCRIPTION:
+# Clean up potential stray egg-info files left by setuptools test phase.
+# Those files ended up being unversioned, and caused issues:
+# https://bugs.gentoo.org/534058
+_distutils-r1_clean_egg_info() {
+	rm -rf "${BUILD_DIR}"/lib/*.egg-info || die
 }
 
 distutils-r1_src_test() {
@@ -781,7 +785,7 @@ distutils-r1_src_test() {
 
 	if declare -f python_test >/dev/null; then
 		_distutils-r1_run_foreach_impl python_test
-		_distutils-r1_run_foreach_impl _clean_egg_info
+		_distutils-r1_run_foreach_impl _distutils-r1_clean_egg_info
 	fi
 
 	if declare -f python_test_all >/dev/null; then
-- 
2.13.0.rc1

Re: [gentoo-dev] [PATCH] distutils-r1.eclass: Namespace & doc _clean_egg_info

[Michał Górny]

[-- Attachment #1: Type: text/plain, Size: 1817 bytes --]

On pią, 2017-05-05 at 23:28 +0200, Michał Górny wrote:
> Prefix the _clean_egg_info function with an appropriate namespace,
> and document its purpose with eclassdoc format. Be more verbose
> on the exact problem being solved; remove URL to old upstream bug
> tracker that no longer exists.
> ---
>  eclass/distutils-r1.eclass | 14 +++++++++-----
>  1 file changed, 9 insertions(+), 5 deletions(-)
> 
> ** REVIEW NOTE **
> 
> Do we still need this hack? Is there any chance the issue has been
> fixed upstream? Can someone test it and find a bug upstream and/or
> re-report it?
> 
> diff --git a/eclass/distutils-r1.eclass b/eclass/distutils-r1.eclass
> index 5df7234332d3..1376326c9579 100644
> --- a/eclass/distutils-r1.eclass
> +++ b/eclass/distutils-r1.eclass
> @@ -770,10 +770,14 @@ distutils-r1_src_compile() {
>  	fi
>  }
>  
> -_clean_egg_info() {
> -	# Work around for setuptools test behavior (bug 534058).
> -	# https://bitbucket.org/pypa/setuptools/issue/292
> -	rm -rf "${BUILD_DIR}"/lib/*.egg-info
> +# @FUNCTION: _distutils-r1_clean_egg_info
> +# @INTERNAL
> +# @DESCRIPTION:
> +# Clean up potential stray egg-info files left by setuptools test phase.
> +# Those files ended up being unversioned, and caused issues:
> +# https://bugs.gentoo.org/534058
> +_distutils-r1_clean_egg_info() {
> +	rm -rf "${BUILD_DIR}"/lib/*.egg-info || die
>  }
>  
>  distutils-r1_src_test() {
> @@ -781,7 +785,7 @@ distutils-r1_src_test() {
>  
>  	if declare -f python_test >/dev/null; then
>  		_distutils-r1_run_foreach_impl python_test
> -		_distutils-r1_run_foreach_impl _clean_egg_info
> +		_distutils-r1_run_foreach_impl _distutils-r1_clean_egg_info
>  	fi
>  
>  	if declare -f python_test_all >/dev/null; then

Committed.

-- 
Best regards,
Michał Górny

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 963 bytes --]