]> git.ipfire.org Git - thirdparty/linux.git/commit
Documentation/rtla: rename common_xxx.rst files to common_xxx.txt
authorGopi Krishna Menon <krishnagopi487@gmail.com>
Mon, 13 Oct 2025 09:27:20 +0000 (16:27 +0700)
committerJonathan Corbet <corbet@lwn.net>
Fri, 17 Oct 2025 20:25:12 +0000 (14:25 -0600)
commit96b546c241b11a97ba1247580208c554458e7866
treed380c7dceb347ef906a59aa0687e65f364646f77
parent22605d257bcfcca33e2e5fab4ff43a018b996bc8
Documentation/rtla: rename common_xxx.rst files to common_xxx.txt

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: 05b7e10687c6 ("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>
17 files changed:
Documentation/tools/rtla/common_appendix.txt [moved from Documentation/tools/rtla/common_appendix.rst with 100% similarity]
Documentation/tools/rtla/common_hist_options.txt [moved from Documentation/tools/rtla/common_hist_options.rst with 100% similarity]
Documentation/tools/rtla/common_options.txt [moved from Documentation/tools/rtla/common_options.rst with 100% similarity]
Documentation/tools/rtla/common_osnoise_description.txt [moved from Documentation/tools/rtla/common_osnoise_description.rst with 100% similarity]
Documentation/tools/rtla/common_osnoise_options.txt [moved from Documentation/tools/rtla/common_osnoise_options.rst with 100% similarity]
Documentation/tools/rtla/common_timerlat_aa.txt [moved from Documentation/tools/rtla/common_timerlat_aa.rst with 100% similarity]
Documentation/tools/rtla/common_timerlat_description.txt [moved from Documentation/tools/rtla/common_timerlat_description.rst with 100% similarity]
Documentation/tools/rtla/common_timerlat_options.txt [moved from Documentation/tools/rtla/common_timerlat_options.rst with 100% similarity]
Documentation/tools/rtla/common_top_options.txt [moved from Documentation/tools/rtla/common_top_options.rst with 100% similarity]
Documentation/tools/rtla/rtla-hwnoise.rst
Documentation/tools/rtla/rtla-osnoise-hist.rst
Documentation/tools/rtla/rtla-osnoise-top.rst
Documentation/tools/rtla/rtla-osnoise.rst
Documentation/tools/rtla/rtla-timerlat-hist.rst
Documentation/tools/rtla/rtla-timerlat-top.rst
Documentation/tools/rtla/rtla-timerlat.rst
Documentation/tools/rtla/rtla.rst