Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 935686 - dev-util/perf: doesn't conform to man page QA policy
Summary: dev-util/perf: doesn't conform to man page QA policy
Status: CONFIRMED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All Linux
: Normal normal
Assignee: Guilherme Amadio
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-07-07 01:22 UTC by Sam James
Modified: 2025-02-02 22:10 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 Sam James archtester Gentoo Infrastructure gentoo-dev Security 2024-07-07 01:22:35 UTC
```
>>> Running pre-merge checks for dev-util/perf-6.9
 * Without the doc USE flag you won't get any documentation nor man pages.
 * And without man pages, you won't get any --help output for perf and its
 * sub-tools.
```

See https://projects.gentoo.org/qa/policy-guide/installed-files.html#pg0305. It should unconditionally install man pages, ideally. Especially as the deps don't seem heavy either.
Comment 1 Guilherme Amadio gentoo-dev 2024-08-06 12:19:07 UTC
Hi Sam,

In IUSE, we have +doc, so it should be enabled by default. My intention is to allow people that don't want the extra dependencies to compile just the tool if they want (i.e. in an embedded environment or other low spec device). Both asciidoc and xmlto have quite a few dependencies that people may not want to install. However, I understand the policy, so if you want to remove the flag and have it always enabled, you can go ahead or let me know and I'll do it.

Cheers,
-Guilherme
Comment 2 Yixun Lan archtester gentoo-dev 2024-08-09 02:55:34 UTC
(In reply to Guilherme Amadio from comment #1)
> Hi Sam,
> 
> In IUSE, we have +doc, so it should be enabled by default. My intention is
> to allow people that don't want the extra dependencies to compile just the
> tool if they want (i.e. in an embedded environment or other low spec
> device). Both asciidoc and xmlto have quite a few dependencies that people
> may not want to install. However, I understand the policy, so if you want to
> remove the flag and have it always enabled, you can go ahead or let me know
> and I'll do it.
> 
> Cheers,
> -Guilherme

+1 from my side, I'd agree with @amadio here, perf is quite useful in embedded area, and people may not want to pull extra dependencies.. making it enabled by default, and also providing an IUSE=doc to let them disable it would be helpful

in addition to this, there is a warning in pkg_pretend() to let users aware this
Comment 3 Sam James archtester Gentoo Infrastructure gentoo-dev Security 2024-08-16 04:06:57 UTC
(In reply to Guilherme Amadio from comment #1)
> Hi Sam,
> 

Hi!

> In IUSE, we have +doc, so it should be enabled by default.

Does it control only man pages? If so, could we rename it to USE=man if we decide to keep the USE?

> My intention is to allow people that don't want the extra dependencies to compile just the tool if they want (i.e. in an embedded environment or other low spec device). Both asciidoc and xmlto have quite a few dependencies that people
> may not want to install. 

But they're build dependencies - surely in such environments, one would use their own binpkgs, or use emerge --root?

The other option of course is to pre-generate them... I do that for a bunch of packages like qemu and have a script which makes it pretty easy to do.
Comment 4 Guilherme Amadio gentoo-dev 2025-02-02 13:16:41 UTC
No, the option controls more than just manpages, like the output of --help.
If we want to be compliant, I'd go ahead and remove the USE flag, making it always enabled, but I still think this is worse than the current status quo, which allows people to disable it if they really want. So, I suggest we either close this one as won't fix and leave things as they are, or proceed to drop USE=doc (making it always enabled) to comply with man page QA policy. What do others prefer?
Comment 5 Holger Hoffstätte 2025-02-02 22:10:23 UTC
(In reply to Guilherme Amadio from comment #4)
> No, the option controls more than just manpages, like the output of --help.
> If we want to be compliant, I'd go ahead and remove the USE flag, making it
> always enabled, but I still think this is worse than the current status quo,
> which allows people to disable it if they really want. So, I suggest we
> either close this one as won't fix and leave things as they are, or proceed
> to drop USE=doc (making it always enabled) to comply with man page QA
> policy. What do others prefer?

perf is complicated enough and I cannot imagine having to use
it without --help or man page. The few dependencies are mostly python-based (asciidoc) and not too large. Right now we have +doc default-enabled, so IMHO you might as well remove/always-enable it.