Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!

Bug 932802

Summary: distutils-r1.eclass mentions dohtml although it no longer supports EAPI 6
Product: Gentoo Linux Reporter: Ulrich Müller <ulm>
Component: EclassesAssignee: Python Gentoo Team <python>
Status: RESOLVED FIXED    
Severity: normal CC: mgorny
Priority: Normal Keywords: PullRequest
Version: unspecified   
Hardware: All   
OS: Linux   
See Also: https://github.com/gentoo/gentoo/pull/36945
Whiteboard:
Package list:
Runtime testing required: ---

Description Ulrich Müller gentoo-dev 2024-05-26 16:05:29 UTC
There is no dohtml in EAPIs 7 and later, but the eclassdoc of variable HTML_DOCS still says:

# An array containing documents installed using dohtml. The files
# and directories listed there must exist in the directory from which
# distutils-r1_python_install_all() is run (${S} by default).
#
# If unset, no HTML docs will be installed.


Also, it is questionable whether DOCS and HTML_DOCS should be documented as eclass variables at all. The eclass does nothing special for them, so they just have their standard meaning.
Comment 1 Ulrich Müller gentoo-dev 2024-05-26 16:07:02 UTC
(In reply to Ulrich Müller from comment #0)
> Also, it is questionable whether DOCS and HTML_DOCS should be documented as
> eclass variables at all. The eclass does nothing special for them, so they
> just have their standard meaning.

Same for PATCHES.
Comment 2 Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2024-05-27 04:13:08 UTC
I suppose we ought to remove them, but I don't think it's really worth another cache update.  I'll try to remember about it when we have something else to change.

Perhaps when we can remove distutils_install_for_testing (*wink wink*).
Comment 3 Larry the Git Cow gentoo-dev 2024-06-14 12:26:23 UTC
The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=a3266609c65361d1dc2e7c1be9c91721c899750a

commit a3266609c65361d1dc2e7c1be9c91721c899750a
Author:     Michał Górny <mgorny@gentoo.org>
AuthorDate: 2024-06-01 09:09:37 +0000
Commit:     Michał Górny <mgorny@gentoo.org>
CommitDate: 2024-06-14 12:26:04 +0000

    distutils-r1.eclass: Remove doc for DOCS, HTML_DOCS and PATCHES
    
    Remove the redundant (and outdated) documentation for the DOCS,
    HTML_DOCS and PATCHES variables.  All these variables are handled
    through the default EAPI functions.
    
    Closes: https://bugs.gentoo.org/932802
    Signed-off-by: Michał Górny <mgorny@gentoo.org>

 eclass/distutils-r1.eclass | 46 ----------------------------------------------
 1 file changed, 46 deletions(-)