3388 2012-11-05 15:49:06 +0000 perf: enable man pages for basic 'help' functionality 2021-07-30 15:26:00 +0000 1 1 7 Build System, Metadata & Runtime OE-Core kernel 3.3.3 x86 Multiple RESOLVED FIXED Medium normal 3.4 1 tom.zanussi michael.opdenacker bluelightning bruce.ashfield michael.opdenacker randy.macleod richard.purdie ross.burton sgw tom.zanussi --- --- Yes (doc changes required) oldest_to_newest 27237 0 tom.zanussi 2012-11-05 15:49:06 +0000 The help for perf subcommands that a user gets when using 'perf <subcommand> help' relies on manpage support for those subcommands. Support for 'man' isn't installed by default - we should add a dependency to add manpage support when perf is included in an image. root@crownbay:~# perf help record Warning: failed to exec 'man': No such file or directory Fatal: no man viewer handled the request 27240 1 bruce.ashfield 2012-11-05 22:10:50 +0000 I assume we'll make this optional on a flag somehow ? (sort of like the script support). I'm just thinking that some small images might want perf, but not man and it's dependencies .. but maybe it's really small and wouldn't make a difference. 27241 2 tom.zanussi 2012-11-05 22:16:13 +0000 Well, the manpages are pretty extensive so I wouldn't call them small, though I kind of assumed that images that included perf meant -sdk images mainly, where it wouldn't be much of an issue. But it wouldn't be a big deal to add an option that turned it off if - the fact that it you're mentioning it means it's likely to be important to someone, so let's consider such a flag as part of fixing this. 39875 3 ross.burton 2014-01-16 16:42:14 +0000 I just had a quick look at this in case it was trivial to at least get the man pages into perf-doc. It won't work out of the box: we'd need to copy (at least) xmlto from meta-oe, and add a recipe for asciidoc. 48451 4 bluelightning 2015-01-30 18:32:33 +0000 Minor update - we do at least have xmlto in OE-Core as of recently. 64517 5 dengke.du 2016-07-27 05:19:30 +0000 This is because that the help man pages of perf depends on the asciidoc tools. Steps: 1. Add the recipe for asciidoc. 2. Add the RDEPENDS_${PN}-doc += "man" for perf recipe. 3. Add the DEPENDS += "xmlto-native asciidoc-native" Explain: The first make sure the asciidco tools exist. The second make sure the man command when using 'perf help <subcommand>' The third make sure the man pages's correct produce. 90957 6 michael.opdenacker 2021-07-16 18:34:07 +0000 Can this bug be closed? The documentation still refers to it, and I would like to remove the reference to it... Thanks in advance Michael. 90963 7 michael.opdenacker 2021-07-21 13:21:12 +0000 Re-opening this bug. When I add "perf" to the image and its "manpages" feature to local.conf: IMAGE_INSTALL_append = " perf" PACKAGECONFIG_append_pn-perf = " manpages" Then I build core-image-minimal: bitbake core-image-minimal However, I still don't get the expected behaviour: root@qemux86-64:~# perf help record failed to exec 'man': No such file or directoryno man viewer handled the request But do we really want to add manpages to the image? We could also drop this idea. What do you think? 90964 8 michael.opdenacker 2021-07-21 13:24:28 +0000 Reset the default assigned as dengke.du@windriver.com doesn't seem to be active any more. Also added that a documentation change is needed (because this bug is referred to in the documentation) 90994 9 richard.purdie 2021-07-22 15:11:29 +0000 Did you add "api-documentation" to DISTRO_FEATURES? See manpages.bbclass 90995 10 sjolley.yp.pm 2021-07-22 15:13:39 +0000 See Richards question 91007 11 michael.opdenacker 2021-07-22 20:28:47 +0000 Just tried to add: DISTRO_FEATURES_append = " api-documentation" But getting the exact same error. Thanks for your help! 91038 12 michael.opdenacker 2021-07-28 14:57:57 +0000 Still stuck here, help appreciated. Thanks in advance Michael. 91049 13 bruce.ashfield 2021-07-29 13:46:32 +0000 I can have a look at this later in August (I'm heading on vacation), and confirm whether we can get this working, or just close the bug. 91050 14 michael.opdenacker 2021-07-29 13:48:20 +0000 Great, thanks Bruce! 91069 15 richard.purdie 2021-07-30 11:39:04 +0000 Shouldn't this be: IMAGE_INSTALL_append = " perf-doc" ? 91070 16 richard.purdie 2021-07-30 12:25:21 +0000 I confirmed that the configuration that makes this work is: IMAGE_INSTALL_append = " perf perf-doc" DISTRO_FEATURES_append = " api-documentation" 91071 17 michael.opdenacker 2021-07-30 15:26:00 +0000 I confirm that this solution works. I can close this bug and update the documentation. Many thanks!