Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 789582 - java-pkg-simple.eclass should install content of DOCS and HTML_DOCS arrays without adding "default"
Summary: java-pkg-simple.eclass should install content of DOCS and HTML_DOCS arrays wi...
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Eclasses (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Java team
URL:
Whiteboard:
Keywords: PullRequest
Depends on:
Blocks:
 
Reported: 2021-05-12 06:36 UTC by Volkmar W. Pogatzki
Modified: 2022-07-06 08:14 UTC (History)
3 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Volkmar W. Pogatzki 2021-05-12 06:36:42 UTC
Applies to java-pkg-simple.eclass

Presently, to get the contents of DOCS / HTML_DOCS arrays installed it is necessary to have src_install() with "default" defined in the ebuild even if not needed for anything else.

src_install() {
   default
}
Comment 1 Volkmar W. Pogatzki 2021-05-13 11:10:19 UTC
for i in $(git --no-pager grep -ne '^inherit.*java-pkg-simple.*' | cut -d':' -f 1); do grep -He '^DOCS=\|^HTML_DOCS=' $i; done

dev-java/antlr/antlr-2.7.7-r8.ebuild:DOCS=( CHANGES.txt README.txt )
dev-java/commons-lang/commons-lang-3.11-r1.ebuild:DOCS=( CONTRIBUTING.md NOTICE.txt RELEASE-NOTES.txt LICENSE.txt README.md )
dev-java/hamcrest-core/hamcrest-core-1.3-r2.ebuild:DOCS=( {CHANGES,LICENSE,README}.txt )
dev-java/hamcrest-library/hamcrest-library-1.3-r2.ebuild:DOCS=( {CHANGES,LICENSE,README}.txt )
dev-java/higlayout/higlayout-1.0-r3.ebuild:DOCS=( Changes.txt readme.txt )
dev-java/jaxen/jaxen-1.2.0-r1.ebuild:DOCS=( "${P}"/{LICENSE.txt,README.md} )
dev-java/jcifs/jcifs-1.3.17-r2.ebuild:DOCS=( README.txt )
dev-java/jcifs/jcifs-1.3.19.ebuild:DOCS=( README.txt )
dev-java/jgoodies-binding/jgoodies-binding-1.1.2-r2.ebuild:DOCS=( RELEASE-NOTES.txt README.html )
dev-java/jgraph/jgraph-5.12.0.4-r1.ebuild:DOCS=( README WHATSNEW LICENSE ChangeLog )
dev-java/jsr173/jsr173-1.0-r4.ebuild:DOCS=( README.txt jsr173_1.0.pdf )
dev-java/junit/junit-3.8.2-r2.ebuild:DOCS=( README.html cpl-v10.html )
dev-java/microba/microba-0.4.4.3-r1.ebuild:DOCS=(
dev-java/relaxng-datatype/relaxng-datatype-1.0-r2.ebuild:DOCS=( README.txt )
dev-java/xml-commons-resolver/xml-commons-resolver-1.2-r1.ebuild:DOCS=( KEYS LICENSE.resolver.txt NOTICE-resolver.txt )
dev-java/xz-java/xz-java-1.8-r1.ebuild:DOCS=( README NEWS COPYING THANKS )
Comment 2 Florian Schmaus gentoo-dev 2022-07-04 09:56:55 UTC
I am not sure, but I believe the best (and only?) way to introduce this behavior is on a EAPI bump to the eclass. Otherwise, the only option is to call einstalldocs with nonfatal by the eclass, because you can't know if it has already been called, which is far from ideal.

If we have zero EAPI 8 builds using this eclass *and* DOCS/HTML_DOCS currently in ::gentoo, then it maybe could be considered to change the behavior for EAPI 8 (even though it could break ebuilds on overlays).

As you side note: I currently see a lot of ebuilds with

src_install() {
	default # https://bugs.gentoo.org/789582
	java-pkg-simple_src_install
}

I suggest to replace 'default' with 'einstalldocs' to make it clear what is being called/needed.

src_install() {
	java-pkg-simple_src_install
        einstalldocs
}
Comment 3 Larry the Git Cow gentoo-dev 2022-07-06 07:03:34 UTC
The bug has been closed via the following commit(s):

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

commit 4457e74e96d2e956b1b76856b2b238cd356c8312
Author:     Florian Schmaus <flow@gentoo.org>
AuthorDate: 2022-07-04 10:07:49 +0000
Commit:     Florian Schmaus <flow@gentoo.org>
CommitDate: 2022-07-06 07:03:18 +0000

    java-pkg-simple.eclass: invoke einstalldocs
    
    On EAPI 6, or newer, invoke einstalldocs in
    java-pkg-simple_src_install.
    
    Closes: https://bugs.gentoo.org/789582
    Closes: https://github.com/gentoo/gentoo/pull/26216
    Signed-off-by: Florian Schmaus <flow@gentoo.org>

 eclass/java-pkg-simple.eclass | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)
Comment 4 Volkmar W. Pogatzki 2022-07-06 07:57:30 UTC
And it would be very nice to get at least READMO.md getting installed also without DOCS array.

Otherwise we need to keep putting either src_install() or DOCS even in very besic cases.
Comment 5 Volkmar W. Pogatzki 2022-07-06 08:14:32 UTC
(In reply to Volkmar W. Pogatzki from comment #4)
> And it would be very nice to get at least READMO.md getting installed also
> without DOCS array.
> 
> Otherwise we need to keep putting either src_install() or DOCS even in very
> besic cases.

Please disregard that comment.  It works. Re-closing.