profile-manual: document how to build perf manpages on target

Submitted by Michael Opdenacker on July 30, 2021, 4:06 p.m. | Patch ID: 180014

Details

Message ID 20210730160617.185319-1-michael.opdenacker@bootlin.com
State New
Headers show

Commit Message

Michael Opdenacker July 30, 2021, 4:06 p.m.
Thanks to closing yocto bug #3388, there is now a simple way
to build the perf manpages for use on the target

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/profile-manual/usage.rst | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

Patch hide | download patch | download mbox

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 </show_bug.cgi?id=3388>`.
+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