Skip to contentSkip to conversation

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

PATCH In review Michael Opdenacker 3 participants 6 messages Jul 30, 2021 – Aug 2, 2021 1 message not in the archive

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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

---
 documentation/profile-manual/usage.rst | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
documentation/profile-manual/usage.rst +6 -5
index 825290c3f8..ae4efa7f4c 100644
@@ -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
 
Signature · 1 line
2.25.1
#1 lore raw

Hi Michael,

Quoted 13 lines · Michael Opdenacker

Thanks to closing yocto bug #3388, there is now a simple way to build the perf manpages for use on the target

---
 documentation/profile-manual/usage.rst | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
documentation/profile-manual/usage.rst +0 -0
index 825290c3f8..ae4efa7f4c 100644

documentation/profile-manual/usage.rst section can be found here: · line 1160

Quoted 8 lines
documentation/profile-manual/usage.rst +1 -4
@@ -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

s/perf/``perf``/ ?

documentation/profile-manual/usage.rst section can be found here: · line 1163

Quoted 3 lines
documentation/profile-manual/usage.rst +3 -0
+configuration as follows::
+
+   IMAGE_INSTALL:append = " perf perf-doc"

Should perf-doc not be the only package added to IMAGE_INSTALL? I assume one wants perf-doc only if they need perf so they would already have it in their image?

s/perf // is what I suggest here.

Cheers,
Quentin

#2 lore raw
Quoted 38 lines · Quentin Schulz

Hi Michael,

Quoted 19 lines · Michael Opdenacker

Thanks to closing yocto bug #3388, there is now a simple way to build the perf manpages for use on the target

---
 documentation/profile-manual/usage.rst | 11 ++++++-----

 1 file changed, 6 insertions(+), 5 deletions(-)
documentation/profile-manual/usage.rst +0 -0
index 825290c3f8..ae4efa7f4c 100644
@@ -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'.

documentation/profile-manual/usage.rst section can be found here: · line 1160

Quoted 5 lines
documentation/profile-manual/usage.rst +1 -4
-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

s/perf/``perf``/ ?

documentation/profile-manual/usage.rst section can be found here: · line 1163

Quoted 3 lines
documentation/profile-manual/usage.rst +3 -0
+configuration as follows::
+
+   IMAGE_INSTALL:append = " perf perf-doc"

Should perf-doc not be the only package added to IMAGE_INSTALL? I assume one wants perf-doc only if they need perf so they would already have it in their image?

Quoted 1 line

s/perf // is what I suggest here.

Personally, I think it is better to be specific. I did end up just installing the doc package when I first attempted to test this and if I can do that... :/.

Cheers,

Richard

#3 lore raw

Hi Richard,

Thank you for the review!

Quoted 8 lines · Richard Purdie

On Mon, 2021-08-02 at 11:38 +0200, Quentin Schulz wrote:\

Quoted 5 lines

Should perf-doc not be the only package added to IMAGE_INSTALL? I assume one wants perf-doc only if they need perf so they would already have it in their image?

s/perf // is what I suggest here.

Personally, I think it is better to be specific. I did end up just installing the doc package when I first attempted to test this and if I can do that... :/.

LOL! We promise we will continue to improve the documentation to make your user life easier!

Thanks again,
Michael

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

A message that is not in the archive (sent off-list or not yet received): [email protected]

author Applied
#5 lore raw
Quoted 10 lines · Michael Opdenacker

Hi Richard,

Thank you for the review!

Quoted 5 lines · Richard Purdie

On Mon, 2021-08-02 at 11:38 +0200, Quentin Schulz wrote:\

Quoted 4 lines

Should perf-doc not be the only package added to IMAGE_INSTALL? I assume one wants perf-doc only if they need perf so they would already have it in their image?

Quoted 8 lines
Quoted 3 lines
Quoted 1 line

s/perf // is what I suggest here.

Personally, I think it is better to be specific. I did end up just installing the doc package when I first attempted to test this and if I can do that... :/.

LOL! We promise we will continue to improve the documentation to make your user life easier!

Thanks again,
Michael

I merged this change in master-next. Thanks again for your reviews! Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#6 lore raw
In reply to Quentin Schulz

Hi Quentin,

Many thanks for the review!

Quoted 19 lines · Quentin Schulz

Hi Michael,

Quoted 16 lines · Michael Opdenacker

Thanks to closing yocto bug #3388, there is now a simple way to build the perf manpages for use on the target

---
 documentation/profile-manual/usage.rst | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
documentation/profile-manual/usage.rst +0 -0
index 825290c3f8..ae4efa7f4c 100644
@@ -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'.
 
Quoted 6 lines

documentation/profile-manual/usage.rst section can be found here: · line 1160

Quoted 5 lines
documentation/profile-manual/usage.rst +1 -4
-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

s/perf/``perf``/ ?

While I tend to agree here, I believe this change should be made in another commit. You have many other instances of the "perf" word in this chapter, like instances of "ftrace" and other tool names.

Let me first propose a coding style for documentation, and once we agree on one, we'll be able to roll it out progressively on the various documents.

Cheers,

Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com