[libcamera-devel] guides: tracing: Mention where to find the trace file
diff mbox series

Message ID 20211126074219.3930973-1-paul.elder@ideasonboard.com
State Accepted
Commit 8acc82ec0d317b2d8cae6ba57904fbd3811f89e0
Headers show
Series
  • [libcamera-devel] guides: tracing: Mention where to find the trace file
Related show

Commit Message

Paul Elder Nov. 26, 2021, 7:42 a.m. UTC
Add a couple sentences describing where to find the trace file, and how
to view it even after the tracing session is destroyed.

Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>
---
 Documentation/guides/tracing.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Kieran Bingham Nov. 26, 2021, 8:01 a.m. UTC | #1
Quoting Paul Elder (2021-11-26 07:42:19)
> Add a couple sentences describing where to find the trace file, and how
> to view it even after the tracing session is destroyed.
> 
> Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>
> ---
>  Documentation/guides/tracing.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/guides/tracing.rst b/Documentation/guides/tracing.rst
> index 9c688b93..ae960d85 100644
> --- a/Documentation/guides/tracing.rst
> +++ b/Documentation/guides/tracing.rst
> @@ -117,6 +117,12 @@ A trace can be collected fairly simply from lttng:
>  
>  See the `lttng documentation <https://lttng.org/docs/>`_ for further details.
>  
> +The location of the trace file is printed when running
> +``lttng create $SESSION_NAME``. After destroying the session, it can still be
> +viewed by: ``lttng view -t $PATH_TO_TRACE``, where ``$PATH_TO_TRACE`` is the
> +path that was printed when the session was created. This is the same path that
> +is used when analyzing traces programatically, as described in the next section.
> +

Aha - thanks that helps me now. And now I've gone deeper I can see we
can specify a path to save it too, which would be useful.

 lttng create --output=PATH

will let a user (script) choose where to save the trace.

It might be helpful to add something about that, but even without:


Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>


>  Analyzing a trace
>  -----------------
>  
> -- 
> 2.27.0
>
Laurent Pinchart Nov. 30, 2021, 4:39 a.m. UTC | #2
Hi Paul,

Thank you for the patch.

On Fri, Nov 26, 2021 at 08:01:42AM +0000, Kieran Bingham wrote:
> Quoting Paul Elder (2021-11-26 07:42:19)
> > Add a couple sentences describing where to find the trace file, and how
> > to view it even after the tracing session is destroyed.
> > 
> > Signed-off-by: Paul Elder <paul.elder@ideasonboard.com>
> > ---
> >  Documentation/guides/tracing.rst | 6 ++++++
> >  1 file changed, 6 insertions(+)
> > 
> > diff --git a/Documentation/guides/tracing.rst b/Documentation/guides/tracing.rst
> > index 9c688b93..ae960d85 100644
> > --- a/Documentation/guides/tracing.rst
> > +++ b/Documentation/guides/tracing.rst
> > @@ -117,6 +117,12 @@ A trace can be collected fairly simply from lttng:
> >  
> >  See the `lttng documentation <https://lttng.org/docs/>`_ for further details.
> >  
> > +The location of the trace file is printed when running
> > +``lttng create $SESSION_NAME``. After destroying the session, it can still be
> > +viewed by: ``lttng view -t $PATH_TO_TRACE``, where ``$PATH_TO_TRACE`` is the
> > +path that was printed when the session was created. This is the same path that
> > +is used when analyzing traces programatically, as described in the next section.
> > +
> 
> Aha - thanks that helps me now. And now I've gone deeper I can see we
> can specify a path to save it too, which would be useful.
> 
>  lttng create --output=PATH
> 
> will let a user (script) choose where to save the trace.
> 
> It might be helpful to add something about that, but even without:
> 
> 
> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> >  Analyzing a trace
> >  -----------------
> >

Patch
diff mbox series

diff --git a/Documentation/guides/tracing.rst b/Documentation/guides/tracing.rst
index 9c688b93..ae960d85 100644
--- a/Documentation/guides/tracing.rst
+++ b/Documentation/guides/tracing.rst
@@ -117,6 +117,12 @@  A trace can be collected fairly simply from lttng:
 
 See the `lttng documentation <https://lttng.org/docs/>`_ for further details.
 
+The location of the trace file is printed when running
+``lttng create $SESSION_NAME``. After destroying the session, it can still be
+viewed by: ``lttng view -t $PATH_TO_TRACE``, where ``$PATH_TO_TRACE`` is the
+path that was printed when the session was created. This is the same path that
+is used when analyzing traces programatically, as described in the next section.
+
 Analyzing a trace
 -----------------