Re: [PATCH] Documentation/rtla: fix htmldocs build error by renaming common_options.rst

Bagas Sanjaya
2025-10-07T12:51:25Z

[-- Attachment #1: Type: text/plain, Size: 1508 bytes --]

On Tue, Oct 07, 2025 at 02:02:26PM +0530, Gopi Krishna Menon wrote:
> Running "make htmldocs" generates 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_options.rst is intended to be included by other rtla documents
> and is not meant to be built as a standalone document. It contains
> substitutions that are only resolved by other documents, so building it
> independently results in 'undefined substitution referenced' errors.
>
> Rename common_options.rst to common_options.txt to prevent Sphinx from
> building it as a standalone document and update the include references
> accordingly.

Fixes: 05b7e10687c6 ("tools/rtla: Add remaining support for osnoise actions")

Thanks.

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]