linux-toradex.git/Documentation/tools, branch v6.16-rc1

Documentation/rtla: Include BPF sample collection

2025-04-14T16:42:55+00:00

Add dependencies needed to build rtla with BPF sample collection support
to README, and document both ways of sample collection in the manpages.

Signed-off-by: Tomas Glozar 
Acked-by: Steven Rostedt (Google) 
Reviewed-by: Luis Claudio R. Goncalves 
Signed-off-by: Jonathan Corbet 
Link: https://lore.kernel.org/r/20250311114936.148012-5-tglozar@redhat.com

Documentation/rtla: Fix typo in common_timerlat_description.rst

2025-04-14T16:42:55+00:00

Fix "it enable" to "it enables".

Fixes: 29380d4055e5 ("rtla: Add rtla timerlat documentation")
Signed-off-by: Tomas Glozar 
Reviewed-by: Luis Claudio R. Goncalves 
Signed-off-by: Jonathan Corbet 
Link: https://lore.kernel.org/r/20250311114936.148012-4-tglozar@redhat.com

Documentation/rtla: Fix typo in rtla-timerlat.rst

2025-04-14T16:42:55+00:00

The file says "rtla hist hist mode" instead of "rtla timerlat hist
mode".

Fix the typo.

Fixes: 29380d4055e5 ("rtla: Add rtla timerlat documentation")
Signed-off-by: Tomas Glozar 
Reviewed-by: Luis Claudio R. Goncalves 
Signed-off-by: Jonathan Corbet 
Link: https://lore.kernel.org/r/20250311114936.148012-3-tglozar@redhat.com

Documentation/rtla: Fix duplicate text about timerlat tracer

2025-04-14T16:42:55+00:00

A passage about how the timerlat tracer outputs information is included
in both common_timerlat_description.rst and rtla-timerlat.rst, leading
it to be displayed twice in the rtla-timerlat page.

Remove the duplicate passage from rtla-timerlat.rst.

Fixes: 29380d4055e5 ("rtla: Add rtla timerlat documentation")
Signed-off-by: Tomas Glozar 
Reviewed-by: Luis Claudio R. Goncalves 
Signed-off-by: Jonathan Corbet 
Link: https://lore.kernel.org/r/20250311114936.148012-2-tglozar@redhat.com

Documentation/rv: Add sched pages to the indices

2025-03-27T16:02:38+00:00

The pages Documentation/tools/rv/rv-mon-sched.rst and
Documentation/trace/rv/monitor_sched.rst were introduced but not
included in any index.

Add them to the respective indices.

Cc: Jonathan Corbet 
Link: https://lore.kernel.org/20250327081240.46422-1-gmonaco@redhat.com
Reported-by: Stephen Rothwell 
Fixes: 03abeaa63c08 ("Documentation/rv: Add docs for the sched monitors")
Signed-off-by: Gabriele Monaco 
Signed-off-by: Steven Rostedt (Google)

Documentation/rv: Add docs for the sched monitors

2025-03-24T21:27:40+00:00

Add man page and kernel documentation for the sched monitors, as sched
is a container of other monitors, document all in the same page.
sched is the first nested monitor, also explain what is a nested monitor
and how enabling containers or children monitors work.

To: Ingo Molnar 
To: Peter Zijlstra 
Cc: Juri Lelli 
Cc: Ingo Molnar 
Cc: Peter Zijlstra 
Cc: Jonathan Corbet 
Cc: John Kacur 
Cc: Clark Williams 
Link: https://lore.kernel.org/20250305140406.350227-9-gmonaco@redhat.com
Signed-off-by: Gabriele Monaco 
Signed-off-by: Steven Rostedt (Google)

rtla: Documentation: Mention --deepest-idle-state

2024-10-17T21:13:16+00:00

Add --deepest-idle-state to manpage and mention libcpupower dependency
in README.txt.

Link: https://lore.kernel.org/20241017140914.3200454-7-tglozar@redhat.com
Signed-off-by: Tomas Glozar 
Signed-off-by: Steven Rostedt (Google)

Documentation/tools/rv: fix document header

2024-07-03T22:36:21+00:00

align header of document with filename and rest of the content

Signed-off-by: Jiri Kastner 
Signed-off-by: Jonathan Corbet 
Link: https://lore.kernel.org/r/20240626203906.191841-1-cz172638@gmail.com

rtla: Documentation: Fix -t, --trace

2024-05-16T14:52:16+00:00

Move -t, --trace from common_options.rst to
common_osnoise_options.rst and
common_timerlat_options.rst

so that it will appear in the man pages

rtla-timerlat-hist.1
rtla-timerlat-top.1
rtla-osnoise-hist.1
rtla-osnoise-top.1

Remove the equals ('=') sign and add a space.

Link: https://lkml.kernel.org/r/20240516143121.12614-1-jkacur@redhat.com

Cc: Daniel Bristot de Oliveria 
Signed-off-by: John Kacur 
Signed-off-by: Daniel Bristot de Oliveira

rtla: Add --trace-buffer-size option

2024-05-16T14:44:34+00:00

Add the option allow the users to set a different buffer size for the
trace. For example, in large systems, the user might be interested on
reducing the trace buffer to avoid large tracing files.

The buffer size is specified in kB, and it is only affecting
the tracing instance.

The function trace_set_buffer_size() appears on libtracefs v1.6,
so increase the minimum required version on Makefile.config.

Link: https://lkml.kernel.org/r/e7c9ca5b3865f28e131a49ec3b984fadf2d056c6.1715860611.git.bristot@kernel.org

Cc: Jonathan Corbet 
Cc: Juri Lelli 
Cc: John Kacur 
Signed-off-by: Daniel Bristot de Oliveira