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

Bug 770997

Summary: app-emulation/qemu-5.2.0-r2[-doc]: man pages missing
Product: Gentoo Linux Reporter: Zulu Foxtrott <zulufoxtrott>
Component: Current packagesAssignee: Matthias Maier <tamiko>
Status: RESOLVED FIXED    
Severity: normal CC: ionen, sam, slyfox, virtualization
Priority: Normal    
Version: unspecified   
Hardware: All   
OS: Linux   
See Also: https://bugs.gentoo.org/show_bug.cgi?id=830088
https://bugs.gentoo.org/show_bug.cgi?id=784815
Whiteboard:
Package list:
Runtime testing required: ---
Attachments: emerge --info
build.log
emerge -pqv

Description Zulu Foxtrott 2021-02-16 20:40:05 UTC
Man pages are not installed for app-emulation/qemu-5.2.0-r2 (without the doc USE flag) on aarch64-gentoo-linux-musl.

Reproducible: Always

Actual Results:  
$ man qemu-img
No manual entry for qemu-img

$ man qemu-system-aarch64
No manual entry for qemu-system-aarch64

"find /usr/share/man/ -iname '*qemu*'" doesn't return anything
Comment 1 Zulu Foxtrott 2021-02-16 20:40:53 UTC
Created attachment 687003 [details]
emerge --info
Comment 2 Zulu Foxtrott 2021-02-16 20:44:39 UTC
Created attachment 687006 [details]
build.log
Comment 3 Zulu Foxtrott 2021-02-16 20:44:59 UTC
Created attachment 687009 [details]
emerge -pqv
Comment 4 Ionen Wolkens gentoo-dev 2021-02-16 22:12:13 UTC
This happens everywhere, man pages need sphinx and docs to be enabled to be generated.

And, while not up to me, I'd certainly prefer if qemu didn't start pulling sphinx unconditionally.

So, if not pulling but still fixing this, it'd need a maintainer-made man pages tarball used when USE=-doc
Comment 5 Sergei Trofimovich (RETIRED) gentoo-dev 2021-02-17 09:10:22 UTC
(In reply to Zulu Foxtrott from comment #0)
> Man pages are not installed for app-emulation/qemu-5.2.0-r2 (without the doc
> USE flag) on aarch64-gentoo-linux-musl.
> 
> Reproducible: Always
> 
> Actual Results:  
> $ man qemu-img
> No manual entry for qemu-img
> 
> $ man qemu-system-aarch64
> No manual entry for qemu-system-aarch64
> 
> "find /usr/share/man/ -iname '*qemu*'" doesn't return anything

This works as intended. What was your expectation?
Comment 6 Zulu Foxtrott 2021-02-17 14:34:46 UTC
I expected man pages to not count as "extra documentation" (description of the "doc" USE flag: "Add extra documentation (API, Javadoc, etc).") AFAIU most packages install man pages even when the "doc" USE flag is not set.
Comment 7 Sergei Trofimovich (RETIRED) gentoo-dev 2021-02-17 15:46:12 UTC
Would renaming use flag to USE=man make it more clear?
Comment 8 Ionen Wolkens gentoo-dev 2021-02-17 16:00:56 UTC
I thought about USE=man as well but USE=doc also provide other docs and build system doesn't support separating them, e.g. trades for "docs missing when USE=-man", plus qemu's option is named "docs".
Comment 9 Matthias Maier gentoo-dev 2021-02-17 17:05:19 UTC
(In reply to Ionen Wolkens from comment #8)
> [...] but USE=doc also provide other docs and build system doesn't support separating them

Yes, this is the underlying issue here.

I am not really sold on an additional USE=man toggle - I think the ebuild has already way too many use flags.

Renaming USE=doc to USE=man also doesn't sound particularly fitting - after all it installs a lot of additional documentation.

As a pragmatic workaround we could simply default-enable doc by setting it to +doc. This should solve the problem for 99% of the users... (and those who set USE=-doc in their global use flags should now what they're doing...).
Comment 10 Zulu Foxtrott 2021-02-17 19:20:04 UTC
Default enabling sounds good. Given time permits I'll document this behaviour on wgo.
Comment 11 Larry the Git Cow gentoo-dev 2021-04-04 19:31:32 UTC
The bug has been closed via the following commit(s):

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

commit 3994226b8f5bf85ec349ab2ad33e5b0c18b086af
Author:     Matthias Maier <tamiko@gentoo.org>
AuthorDate: 2021-04-04 19:30:37 +0000
Commit:     Matthias Maier <tamiko@gentoo.org>
CommitDate: 2021-04-04 19:31:00 +0000

    app-emulation/qemu: default enable USE=+doc
    
    Closes: https://bugs.gentoo.org/770997
    Package-Manager: Portage-3.0.18, Repoman-3.0.3
    Signed-off-by: Matthias Maier <tamiko@gentoo.org>

 app-emulation/qemu/qemu-5.2.0-r2.ebuild | 2 +-
 app-emulation/qemu/qemu-5.2.0-r3.ebuild | 2 +-
 app-emulation/qemu/qemu-9999.ebuild     | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)