Thread (24 messages) 24 messages, 3 authors, 2025-10-09

Re: [PATCH v2] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt

From: Bagas Sanjaya <hidden>
Date: 2025-10-08 23:19:27
Also in: linux-doc, linux-kernel-mentees, lkml

On Thu, Oct 09, 2025 at 12:14:27AM +0530, Gopi Krishna Menon wrote:
Running "make htmldocs" reports the following build errors for
common_options.rst:

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 intended to be included by other rtla documents
and are not meant to be built as a standalone document.
common_options.rst in particular contains substitutions that are only
resolved by other documents, so building it independently results in
'undefined substitution referenced' errors.

Rename all common_*.rst files to common_*.txt to prevent Sphinx from
building them as standalone documents and update all include references
accordingly.
Much better, thanks!

Fixes: 05b7e10687c6 ("tools/rtla: Add remaining support for osnoise actions")
Reviewed-by: Bagas Sanjaya <redacted>

-- 
An old man doll... just what I always wanted! - Clara

Attachments

Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help