* [PATCH] profile-manual: document how to build perf manpages on target
@ 2021-07-30 16:06 Michael Opdenacker
2021-08-02 9:38 ` [docs] " Quentin Schulz
0 siblings, 1 reply; 6+ messages in thread
From: Michael Opdenacker @ 2021-07-30 16:06 UTC (permalink / raw)
To: docs; +Cc: Michael Opdenacker
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(-)
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
--
2.25.1
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [docs] [PATCH] profile-manual: document how to build perf manpages on target
2021-07-30 16:06 [PATCH] profile-manual: document how to build perf manpages on target Michael Opdenacker
@ 2021-08-02 9:38 ` Quentin Schulz
2021-08-02 12:43 ` Richard Purdie
2021-08-02 13:05 ` Michael Opdenacker
0 siblings, 2 replies; 6+ messages in thread
From: Quentin Schulz @ 2021-08-02 9:38 UTC (permalink / raw)
To: Michael Opdenacker; +Cc: docs
Hi Michael,
On Fri, Jul 30, 2021 at 06:06:17PM +0200, Michael Opdenacker wrote:
> 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(-)
>
> 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
s/perf/``perf``/ ?
> +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
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [docs] [PATCH] profile-manual: document how to build perf manpages on target
2021-08-02 9:38 ` [docs] " Quentin Schulz
@ 2021-08-02 12:43 ` Richard Purdie
2021-08-02 13:13 ` Michael Opdenacker
[not found] ` <16977F8E4C0D2875.17923@lists.yoctoproject.org>
2021-08-02 13:05 ` Michael Opdenacker
1 sibling, 2 replies; 6+ messages in thread
From: Richard Purdie @ 2021-08-02 12:43 UTC (permalink / raw)
To: Quentin Schulz, Michael Opdenacker; +Cc: docs
On Mon, 2021-08-02 at 11:38 +0200, Quentin Schulz wrote:
> Hi Michael,
>
> On Fri, Jul 30, 2021 at 06:06:17PM +0200, Michael Opdenacker wrote:
> > 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(-)
> >
> > 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
>
> s/perf/``perf``/ ?
>
> > +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.
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
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [docs] [PATCH] profile-manual: document how to build perf manpages on target
2021-08-02 12:43 ` Richard Purdie
@ 2021-08-02 13:13 ` Michael Opdenacker
[not found] ` <16977F8E4C0D2875.17923@lists.yoctoproject.org>
1 sibling, 0 replies; 6+ messages in thread
From: Michael Opdenacker @ 2021-08-02 13:13 UTC (permalink / raw)
To: Richard Purdie, Quentin Schulz; +Cc: docs
Hi Richard,
Thank you for the review!
On 8/2/21 2:43 PM, Richard Purdie wrote:
> On Mon, 2021-08-02 at 11:38 +0200, Quentin Schulz wrote:\
>> 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
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 6+ messages in thread[parent not found: <16977F8E4C0D2875.17923@lists.yoctoproject.org>]
* Re: [docs] [PATCH] profile-manual: document how to build perf manpages on target
[not found] ` <16977F8E4C0D2875.17923@lists.yoctoproject.org>
@ 2021-08-02 16:23 ` Michael Opdenacker
0 siblings, 0 replies; 6+ messages in thread
From: Michael Opdenacker @ 2021-08-02 16:23 UTC (permalink / raw)
To: Richard Purdie, Quentin Schulz; +Cc: docs
On 8/2/21 3:13 PM, Michael Opdenacker wrote:
> Hi Richard,
>
> Thank you for the review!
>
> On 8/2/21 2:43 PM, Richard Purdie wrote:
>> On Mon, 2021-08-02 at 11:38 +0200, Quentin Schulz wrote:\
>>> 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
I merged this change in master-next. Thanks again for your reviews!
Michael.
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [docs] [PATCH] profile-manual: document how to build perf manpages on target
2021-08-02 9:38 ` [docs] " Quentin Schulz
2021-08-02 12:43 ` Richard Purdie
@ 2021-08-02 13:05 ` Michael Opdenacker
1 sibling, 0 replies; 6+ messages in thread
From: Michael Opdenacker @ 2021-08-02 13:05 UTC (permalink / raw)
To: Quentin Schulz; +Cc: docs
Hi Quentin,
Many thanks for the review!
On 8/2/21 11:38 AM, Quentin Schulz wrote:
> Hi Michael,
>
> On Fri, Jul 30, 2021 at 06:06:17PM +0200, Michael Opdenacker wrote:
>> 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(-)
>>
>> 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
> 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.
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-08-02 16:23 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-07-30 16:06 [PATCH] profile-manual: document how to build perf manpages on target Michael Opdenacker
2021-08-02 9:38 ` [docs] " Quentin Schulz
2021-08-02 12:43 ` Richard Purdie
2021-08-02 13:13 ` Michael Opdenacker
[not found] ` <16977F8E4C0D2875.17923@lists.yoctoproject.org>
2021-08-02 16:23 ` Michael Opdenacker
2021-08-02 13:05 ` Michael Opdenacker
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox