Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 581750 - media-libs/giflib-5.1.4 does not install important documentation and install docs unconditionally
Summary: media-libs/giflib-5.1.4 does not install important documentation and install ...
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: [OLD] Library (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Gentoo Graphics Project
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2016-05-01 19:13 UTC by Andrew Savchenko
Modified: 2016-11-20 07:15 UTC (History)
1 user (show)

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


Attachments
giflib-5.1.4.ebuild.patch (giflib-5.1.4.ebuild.patch,1.35 KB, patch)
2016-05-01 19:13 UTC, Andrew Savchenko
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Andrew Savchenko gentoo-dev 2016-05-01 19:13:39 UTC
Created attachment 432864 [details, diff]
giflib-5.1.4.ebuild.patch

Hi,

giflib doesn't install all docs, including gif_lib.html — API and compatibility documentation vital for development, actually I spotted this bug while porting another package to giflib-5.

Thus I added full documentation build and installation and made html/txt docs optional via USE="doc".

Please see attached patch for these fixes.
Comment 1 SpanKY gentoo-dev 2016-05-05 03:58:43 UTC
Comment on attachment 432864 [details, diff]
giflib-5.1.4.ebuild.patch

>+	if use doc && multilib_is_native_abi; then
>+		docinto html
>+		dodoc doc/*.html
>+	fi

why dodoc ?  shouldn't this be dohtml ?  that's where we want to install all html files after all.

>+	docinto

did you forget something ?

-	dodoc AUTHORS BUGS ChangeLog NEWS README TODO doc/*.txt
>+	dodoc AUTHORS BUGS ChangeLog NEWS README TODO
>+	if use doc; then
>+		dodoc doc/*.txt

the txt files are tiny.  i think they're fine to leave on the dodoc line.
Comment 2 Andrew Savchenko gentoo-dev 2016-05-05 10:48:18 UTC
(In reply to SpanKY from comment #1)
> Comment on attachment 432864 [details, diff] [details, diff]
> giflib-5.1.4.ebuild.patch
> 
> >+	if use doc && multilib_is_native_abi; then
> >+		docinto html
> >+		dodoc doc/*.html
> >+	fi
> 
> why dodoc ?  shouldn't this be dohtml ?  that's where we want to install all
> html files after all.

Because this is EAPI 6, dohtml is deprecated here and will be banned in EAPI 7:
https://blogs.gentoo.org/mgorny/2015/11/13/the-ultimate-guide-to-eapi-6/

> >+	docinto
> 
> did you forget something ?

No, I didn't. Because in case of USE="doc" at this point docdir will point to html subdirectory (please read multilib_src_install() code above) and what is needed here is to install docs to a base location, this is exactly what is done when docinto have no argument, please read man 5 ebuild for details.

> -	dodoc AUTHORS BUGS ChangeLog NEWS README TODO doc/*.txt
> >+	dodoc AUTHORS BUGS ChangeLog NEWS README TODO
> >+	if use doc; then
> >+		dodoc doc/*.txt
> 
> the txt files are tiny.  i think they're fine to leave on the dodoc line.

These files are useless without full docs, I don't see a point to drag garbage just because its small. We have docs selector here anyway (USE="doc").
Comment 3 Andrew Savchenko gentoo-dev 2016-06-01 16:01:37 UTC
@media-gfx, looks like I answered all questions. Any more thoughts? I do not have a strong opinion on small *.txt files, if you insist on installing them unconditionally, I'm fine with this.


As usual, I'll wait for at least two weeks for reply before committing.
Comment 4 Andrew Savchenko gentoo-dev 2016-06-19 10:16:10 UTC
(In reply to Andrew Savchenko from comment #3)

> As usual, I'll wait for at least two weeks for reply before committing.

No comments for 1.5 month => applied in tree.
Comment 5 Michael Palimaka (kensington) gentoo-dev 2016-11-20 07:15:52 UTC
This was landed in 8846a53e588bf0d52d7159b0a492c7bb907e61a4.