diff mbox series

[v2,3/3] trace: document 'trace wipe'

Message ID 1833d3884f623ef66b81443be87b773b1e896498.1734093566.git.jerome.forissier@linaro.org
State New
Headers show
Series Add 'trace wipe' | expand

Commit Message

Jerome Forissier Dec. 13, 2024, 12:45 p.m. UTC
Add documentation for the 'trace wipe' command.

Signed-off-by: Jerome Forissier <jerome.forissier@linaro.org>
---
 doc/develop/trace.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

Comments

Ilias Apalodimas Dec. 15, 2024, 9:20 a.m. UTC | #1
On Fri, 13 Dec 2024 at 14:46, Jerome Forissier
<jerome.forissier@linaro.org> wrote:
>
> Add documentation for the 'trace wipe' command.
>
> Signed-off-by: Jerome Forissier <jerome.forissier@linaro.org>
> ---
>  doc/develop/trace.rst | 11 +++++++++++
>  1 file changed, 11 insertions(+)
>
> 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
>  -----------
>
> --
> 2.43.0
>

Acked-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
diff mbox series

Patch

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
 -----------