From: Jerome Forissier <jerome.forissier@linaro.org>
Date: Fri, 13 Dec 2024 12:45:38 +0000 (+0100)
Subject: trace: document 'trace wipe'
X-Git-Tag: v2025.04-rc1~17^2~6^2
X-Git-Url: http://git.openpandora.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=edef0916668631b4fce956a9cfac252ffb2c0a9c;p=pandora-u-boot.git

trace: document 'trace wipe'

Add documentation for the 'trace wipe' command.

Signed-off-by: Jerome Forissier <jerome.forissier@linaro.org>
Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
---

diff --git a/doc/develop/trace.rst b/doc/develop/trace.rst
index 546862020b1..d3c8628d124 100644
--- a/doc/develop/trace.rst
+++ b/doc/develop/trace.rst
@@ -163,6 +163,17 @@ you will see the time taken by each function shown against its exit record.
               u-boot-1     [000]     3.116466: funcgraph_entry:        0.063 us   |        memset();
               u-boot-1     [000]     3.116539: funcgraph_exit:         0.143 us   |        }
 
+The `trace wipe` command may be used to clear the trace buffer. It leaves
+tracing in its current enable state. This command is convenient when tracing a
+single command, for example:
+
+.. code-block:: console
+
+   => trace pause; trace wipe
+   => trace resume; dhcp; trace pause
+   => trace stats
+   ...
+
 Flame graph
 -----------