[PATCH] D49527: [llvm-mca][docs][WIP] Describe the Timeline View. NFC

[Andrea Di Biagio via Phabricator via llvm-commits]

andreadb accepted this revision.
andreadb added a comment.
This revision is now accepted and ready to land.

In https://reviews.llvm.org/D49527#1167784, @andreadb wrote:

> Overall, it looks good to me.
>
> As you wrote, the "VIEW DESCRIPTIONS" section should be improved.
>  Also, it should probably have a more informative/different name (not sure which one though... I am not good with names).


On a second thought,

you can just commit this patch, as long as you replace section "VIEW DESCRIPTIONS" with the equivalent of section "How the tool works" from the RFC.
Ideally, we should use the same structure of the original llvm-mca RFC.

The "how the tool works" section would be mostly a copy-paste of what is written in the original RFC (modulo changes to the instruction-info view, and the example).

Future documentation patches:

1. Pipeline statistics: things like `SchedulerStatistics`, `RetireControlUnitStatistics`, `RegisterFileStatistics` etc. should go there.
2. LLVM-MCA instruction flow
3. your patch related to the MCA internals.

Again, we should try to keep the same structure as the original RFC.
Patch 1. is basically a porting of section "Extra statistics to further diagnose performance issues" (we can even keep that title for simplicity).
Patch 2. should describe the composition of the "default pipeline", and what is done by each stage. This is also similar to section "LLVM-MCA instruction flow" from the RFC.
Patch 3. would be just at the end of all of this.

I hope it makes sense
-Andrea


https://reviews.llvm.org/D49527