Re: [docs] [PATCH] profile-manual: document how to build perf manpages on target

["Quentin Schulz" <quentin.schulz@theobroma-systems.com>]

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