mirror of
https://github.com/torvalds/linux.git
synced 2026-03-08 05:44:45 +01:00
96b546c241
Sphinx reports htmldocs errors:
Documentation/tools/rtla/common_options.rst:58: ERROR: Undefined substitution referenced: "threshold".
Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substitution referenced: "tool".
Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substitution referenced: "thresharg".
Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substitution referenced: "tracer".
Documentation/tools/rtla/common_options.rst:92: ERROR: Undefined substitution referenced: "tracer".
Documentation/tools/rtla/common_options.rst:98: ERROR: Undefined substitution referenced: "actionsperf".
Documentation/tools/rtla/common_options.rst:113: ERROR: Undefined substitution referenced: "tool".
common_*.rst files are snippets that are intended to be included by rtla
docs (rtla*.rst). common_options.rst in particular contains
substitutions which depend on other common_* includes, so building it
independently as reST source results in above errors.
Rename all common_*.rst files to common_*.txt to prevent Sphinx from
building these snippets as standalone reST source and update all include
references accordingly.
Link: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions
Suggested-by: Tomas Glozar <tglozar@redhat.com>
Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Gopi Krishna Menon <krishnagopi487@gmail.com>
Reviewed-by: Tomas Glozar <tglozar@redhat.com>
Fixes: 05b7e10687 ("tools/rtla: Add remaining support for osnoise actions")
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Link: https://lore.kernel.org/r/20251008184522.13201-1-krishnagopi487@gmail.com
[Bagas: massage commit message and apply trailers]
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251013092719.30780-2-bagasdotme@gmail.com>
18 lines
1,010 B
Text
18 lines
1,010 B
Text
The **rtla timerlat** tool is an interface for the *timerlat* tracer. The
|
|
*timerlat* tracer dispatches a kernel thread per-cpu. These threads
|
|
set a periodic timer to wake themselves up and go back to sleep. After
|
|
the wakeup, they collect and generate useful information for the
|
|
debugging of operating system timer latency.
|
|
|
|
The *timerlat* tracer outputs information in two ways. It periodically
|
|
prints the timer latency at the timer *IRQ* handler and the *Thread*
|
|
handler. It also enables the trace of the most relevant information via
|
|
**osnoise:** tracepoints.
|
|
|
|
The **rtla timerlat** tool sets the options of the *timerlat* tracer
|
|
and collects and displays a summary of the results. By default,
|
|
the collection is done synchronously in kernel space using a dedicated
|
|
BPF program attached to the *timerlat* tracer. If either BPF or
|
|
the **osnoise:timerlat_sample** tracepoint it attaches to is
|
|
unavailable, the **rtla timerlat** tool falls back to using tracefs to
|
|
process the data asynchronously in user space.
|