summaryrefslogtreecommitdiffstats
path: root/documentation/profile-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-07-30 18:02:54 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-08-02 17:46:39 +0100
commit355171f4e305b39662090ba07536f439d4cc18c1 (patch)
tree5c75fa8cb97ee7898902bbc75dad295d8dbb16a8 /documentation/profile-manual
parent9ca793696a4129bef96157126f951b07f40dc7d3 (diff)
downloadpoky-355171f4e305b39662090ba07536f439d4cc18c1.tar.gz
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 <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/profile-manual')
-rw-r--r--documentation/profile-manual/usage.rst11
1 files changed, 6 insertions, 5 deletions
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:
1157Normally, you should be able to invoke the man pages via perf itself 1157Normally, you should be able to invoke the man pages via perf itself
1158e.g. 'perf help' or 'perf help record'. 1158e.g. 'perf help' or 'perf help record'.
1159 1159
1160However, by default Yocto doesn't install man pages, but perf invokes 1160To have the perf manpages installed on your target, modify your
1161the man pages for most help functionality. This is a bug and is being 1161configuration as follows::
1162addressed by a Yocto bug: :yocto_bugs:`Bug 3388 - perf: enable man pages for 1162
1163basic 'help' functionality </show_bug.cgi?id=3388>`. 1163 IMAGE_INSTALL:append = " perf perf-doc"
1164 DISTRO_FEATURES:append = " api-documentation"
1164 1165
1165The man pages in text form, along with some other files, such as a set 1166The man pages in text form, along with some other files, such as a set
1166of examples, can be found in the 'perf' directory of the kernel tree:: 1167of examples, can also be found in the 'perf' directory of the kernel tree::
1167 1168
1168 tools/perf/Documentation 1169 tools/perf/Documentation
1169 1170