kernel/linux
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/ synced 2026-11-10 20:48:12 +00:00
Code Issues Releases Packages Activity
linux/Documentation/tools/rtla
History
Gopi Krishna Menon ce1d0f5c7b Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 
commit 96b546c241 upstream.

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: 05b7e10687 ("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>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
History 2025-12-12 18:42:46 +01:00
..
common_appendix.txt Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
common_hist_options.txt Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
common_options.txt Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
common_osnoise_description.txt Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
common_osnoise_options.txt Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
common_timerlat_aa.txt Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
common_timerlat_description.txt Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
common_timerlat_options.txt Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
common_top_options.txt Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
index.rst Documentation/rtla: Add hwnoise man page 2023-02-13 23:56:46 -05:00
Makefile rtla/Makefile: Properly handle dependencies 2022-05-26 15:17:48 -04:00
rtla-hwnoise.rst Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
rtla-osnoise-hist.rst Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
rtla-osnoise-top.rst Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
rtla-osnoise.rst Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
rtla-timerlat-hist.rst Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
rtla-timerlat-top.rst Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
rtla-timerlat.rst Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00
rtla.rst Documentation/rtla: rename common_xxx.rst files to common_xxx.txt 2025-12-12 18:42:46 +01:00