Re: [PATCH v2] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt
From: Tomas Glozar <tglozar@redhat.com>
Date: 2025-10-09 14:27:12
Also in:
linux-doc, linux-kernel-mentees, lkml
st 8. 10. 2025 v 20:45 odesílatel Gopi Krishna Menon [off-list ref] napsal:
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. Suggested-by: Tomas Glozar <tglozar@redhat.com> Suggested-by: Bagas Sanjaya <redacted> Signed-off-by: Gopi Krishna Menon <redacted> ---
Looks good! Reviewed-by: Tomas Glozar <tglozar@redhat.com> Tomas