Mesa (main): docs: put a list of commands to setup perfetto

[GitLab Mirror]

Module: Mesa
Branch: main
Commit: 127863ddd3e9aa43cea7c9de8c452460a0dcd5de
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=127863ddd3e9aa43cea7c9de8c452460a0dcd5de

Author: Lionel Landwerlin <lionel.g.landwerlin at intel.com>
Date:   Thu Oct 28 00:15:33 2021 +0300

docs: put a list of commands to setup perfetto

Signed-off-by: Lionel Landwerlin <lionel.g.landwerlin at intel.com>
Reviewed-by: Antonio Caggiano <antonio.caggiano at collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/13571>

---

 docs/perfetto.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/docs/perfetto.rst b/docs/perfetto.rst
index 7fc20a68954..dd78db564b4 100644
--- a/docs/perfetto.rst
+++ b/docs/perfetto.rst
@@ -80,6 +80,30 @@ To capture a trace with perfetto you need to take the following steps:
 8. Alternatively you can open the trace in `AGI <https://gpuinspector.dev/>`__
    (which despite the name can be used to view non-android traces).
 
+To be a bit more explicit, here is a listing of commands reproducing
+the steps above :
+
+.. code-block:: console
+
+   # Configure Mesa with perfetto
+   mesa $ meson . build -Dperfetto=true -Dvulkan-drivers=intel,broadcom -Dgallium-drivers=
+   # Build mesa
+   mesa $ ninja -C build
+
+   # Within the Mesa repo, build perfetto
+   mesa $ cd subprojects/perfetto
+   perfetto $ ./tools/install-build-deps
+   perfetto $ ./tools/gn gen --args='is_debug=false' out/linux
+   perfetto $ ./tools/ninja -C out/linux
+
+   # Start perfetto
+   perfetto $ CONFIG=../../src/tool/pps/cfg/gpu.cfg OUT=out/linux/ ./tools/tmux -n
+
+   # In parallel from the Mesa repo, start the PPS producer
+   mesa $ ./build/src/tool/pps/pps-producer
+
+   # Back in the perfetto tmux, press enter to start the capture
+
 Driver Specifics
 ~~~~~~~~~~~~~~~~