Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 937966 - dev-debug/bpftrace: does not install man page for bpftrace(8)
Summary: dev-debug/bpftrace: does not install man page for bpftrace(8)
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All Linux
: Normal normal
Assignee: Holger Hoffstätte
URL:
Whiteboard:
Keywords: PullRequest
Depends on:
Blocks:
 
Reported: 2024-08-15 08:52 UTC by Holger Hoffstätte
Modified: 2024-08-16 03:00 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 Holger Hoffstätte 2024-08-15 08:52:09 UTC
The bpftrace build tries to install two kinds of man pages:
- existing man pages in troff format, which the ebuild installs correctly
- the man page for bpftrace in asciidoc format, which the build tries to process via asciidoctor

The latter is currently skipped when asciidoctor is not found. Since the ebuild does not depend on asciidoctor, this leads to a missing man page when asciidoctor is not yet installed on the build host.

Unfortunately asciidoctor implies a pretty large dependency on ruby, which may not be great on development/debugging systems. Using asciidoc (the original python processor) does not work as it cannot process the input correctly, due to format changes.

Luckily bpftrace publishes a man page archive as part of their release process, which means we can easily use the preprocessed bpftrace(8) page without having to pull in asciidoctor.
Comment 1 Holger Hoffstätte 2024-08-15 08:53:39 UTC
While bpftrace has helpful output via its -h option, the man page is much more detailed and really should be installed.
Comment 2 Holger Hoffstätte 2024-08-15 09:35:10 UTC
As it turns out the man page is _never_ installed for some reason, even when asciidoctor exists. This makes the fix even more important. :)
Comment 3 Larry the Git Cow gentoo-dev 2024-08-16 03:00:18 UTC
The bug has been closed via the following commit(s):

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

commit eda1b56db5cde357633e7db66045c6d337971663
Author:     Holger Hoffstätte <holger@applied-asynchrony.com>
AuthorDate: 2024-08-15 09:00:43 +0000
Commit:     Yixun Lan <dlan@gentoo.org>
CommitDate: 2024-08-16 02:51:14 +0000

    dev-debug/bpftrace: properly install bpftrace man page
    
    Closes: https://bugs.gentoo.org/937966
    Closes: https://github.com/gentoo/gentoo/pull/38160
    Signed-off-by: Holger Hoffstätte <holger@applied-asynchrony.com>
    Signed-off-by: Yixun Lan <dlan@gentoo.org>

 dev-debug/bpftrace/Manifest                                            | 1 +
 .../bpftrace/{bpftrace-0.21.2.ebuild => bpftrace-0.21.2-r1.ebuild}     | 3 +++
 2 files changed, 4 insertions(+)