From 355171f4e305b39662090ba07536f439d4cc18c1 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Fri, 30 Jul 2021 18:02:54 +0200 Subject: profile-manual: document how to build perf manpages on target Thanks to closing yocto bug #3388, there is now a simple way to build the perf manpages for use on the target (From yocto-docs rev: 12dd3ecb054c1668cdccc220ca21b88635531784) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/profile-manual/usage.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'documentation/profile-manual') diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index 825290c3f8..ae4efa7f4c 100644 --- a/documentation/profile-manual/usage.rst +++ b/documentation/profile-manual/usage.rst @@ -1157,13 +1157,14 @@ section can be found here: Normally, you should be able to invoke the man pages via perf itself e.g. 'perf help' or 'perf help record'. -However, by default Yocto doesn't install man pages, but perf invokes -the man pages for most help functionality. This is a bug and is being -addressed by a Yocto bug: :yocto_bugs:`Bug 3388 - perf: enable man pages for -basic 'help' functionality `. +To have the perf manpages installed on your target, modify your +configuration as follows:: + + IMAGE_INSTALL:append = " perf perf-doc" + DISTRO_FEATURES:append = " api-documentation" The man pages in text form, along with some other files, such as a set -of examples, can be found in the 'perf' directory of the kernel tree:: +of examples, can also be found in the 'perf' directory of the kernel tree:: tools/perf/Documentation -- cgit v1.2.3-54-g00ecf