Bug 1640

Summary: [DOC] Tracing/profiling HOWTOs
Product: [Build System, Metadata & Runtime] Meta-yocto Reporter: Song Liu <song.liu>
Component: meta-yoctoAssignee: Tom Zanussi <tom.zanussi>
Status: VERIFIED FIXED QA Contact:
Severity: enhancement    
Priority: Medium+ CC: alexandru.c.georgescu, dvhart, jessica.zhang, mhalstead, poky.bs.watcher, poky.watcher, richard.purdie, sgw, tom.zanussi
Version: unspecified   
Target Milestone: 1.4   
Hardware: x86   
OS: Multiple   
Whiteboard: (10D+5D)
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: ---

Description Song Liu 2011-10-04 22:24:38 UTC
Create a document or extend the current Yocto tracing wiki page to explain in detail how to use all the tracing tools in Yocto. It should detail not only how to use each tool individually, but also how to use them in conjunction with each other, highlighting situations in which each is most useful. There should also be some extensive worked examples of real-life use-cases and how they could be investigated using the Yocto tracing/profiling tools.
Comment 1 Tom Zanussi 2011-10-06 11:50:44 UTC
We have all these great tracing and profiling tools in Yocto, but it's not clear how and when to use them – we need to remedy that.

The Tracing and Profiling section on the wiki is a start (https://wiki.yoctoproject.org/wiki/Tracing_and_Profiling), but it should really have a section in the Yocto Developer's Manual.

We shouldn't be trying to be a primer on tracing and profiling, just an overview of what's available in Yocto and basic usage.  Small examples covering each use case.

Beyond the basics, a well-chosen end-to-end example or two that makes use of all the tools would be especially useful.  One area that I think would be especially fruitful would be graphics:

- Covers both kernel and user space
- Very complex, tracing it would be educational
- People are really interested in graphics performance
- Could be an area for upstreaming (perf scripts)
- The kernel is already instrumented, or at least i915 is.
Comment 2 Darren Hart 2012-09-20 15:13:55 UTC
The current plan is to complete these post code-freeze as they are to be published via the wiki. They will still make the 1.3 release time-frame.
Comment 3 Darren Hart 2012-10-08 18:15:30 UTC
Bumping to M5.
Comment 4 Tom Zanussi 2012-11-15 05:05:52 UTC
The finished version can be found here:

https://wiki.yoctoproject.org/wiki/Tracing_and_Profiling
Comment 5 Alexandru Georgescu 2013-03-13 10:49:36 UTC
Verified as per last comment.
Comment 6 Alexandru Georgescu 2013-03-14 10:34:01 UTC
verified.