Re: [PATCH] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt
From: Jonathan Corbet <corbet@lwn.net>
Date: 2025-10-17 20:27:03
Also in:
linux-doc, lkml
From: Jonathan Corbet <corbet@lwn.net>
Date: 2025-10-17 20:27:03
Also in:
linux-doc, lkml
Bagas Sanjaya [off-list ref] writes:
From: Gopi Krishna Menon <redacted> 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.
Applied, thanks. jon