tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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>

authored by

Gopi Krishna Menon and committed by
Jonathan Corbet 96b546c2 22605d25

+31 -31
Documentation/tools/rtla/common_appendix.rst Documentation/tools/rtla/common_appendix.txt
Documentation/tools/rtla/common_hist_options.rst Documentation/tools/rtla/common_hist_options.txt
Documentation/tools/rtla/common_options.rst Documentation/tools/rtla/common_options.txt
Documentation/tools/rtla/common_osnoise_description.rst Documentation/tools/rtla/common_osnoise_description.txt
Documentation/tools/rtla/common_osnoise_options.rst Documentation/tools/rtla/common_osnoise_options.txt
Documentation/tools/rtla/common_timerlat_aa.rst Documentation/tools/rtla/common_timerlat_aa.txt
Documentation/tools/rtla/common_timerlat_description.rst Documentation/tools/rtla/common_timerlat_description.txt
Documentation/tools/rtla/common_timerlat_options.rst Documentation/tools/rtla/common_timerlat_options.txt
Documentation/tools/rtla/common_top_options.rst Documentation/tools/rtla/common_top_options.txt
+4 -4
Documentation/tools/rtla/rtla-hwnoise.rst
··· 29 29 30 30 OPTIONS 31 31 ======= 32 - .. include:: common_osnoise_options.rst 32 + .. include:: common_osnoise_options.txt 33 33 34 - .. include:: common_top_options.rst 34 + .. include:: common_top_options.txt 35 35 36 - .. include:: common_options.rst 36 + .. include:: common_options.txt 37 37 38 38 EXAMPLE 39 39 ======= ··· 106 106 ====== 107 107 Written by Daniel Bristot de Oliveira <bristot@kernel.org> 108 108 109 - .. include:: common_appendix.rst 109 + .. include:: common_appendix.txt
+5 -5
Documentation/tools/rtla/rtla-osnoise-hist.rst
··· 15 15 16 16 DESCRIPTION 17 17 =========== 18 - .. include:: common_osnoise_description.rst 18 + .. include:: common_osnoise_description.txt 19 19 20 20 The **rtla osnoise hist** tool collects all **osnoise:sample_threshold** 21 21 occurrence in a histogram, displaying the results in a user-friendly way. ··· 24 24 25 25 OPTIONS 26 26 ======= 27 - .. include:: common_osnoise_options.rst 27 + .. include:: common_osnoise_options.txt 28 28 29 - .. include:: common_hist_options.rst 29 + .. include:: common_hist_options.txt 30 30 31 - .. include:: common_options.rst 31 + .. include:: common_options.txt 32 32 33 33 EXAMPLE 34 34 ======= ··· 65 65 ====== 66 66 Written by Daniel Bristot de Oliveira <bristot@kernel.org> 67 67 68 - .. include:: common_appendix.rst 68 + .. include:: common_appendix.txt
+5 -5
Documentation/tools/rtla/rtla-osnoise-top.rst
··· 15 15 16 16 DESCRIPTION 17 17 =========== 18 - .. include:: common_osnoise_description.rst 18 + .. include:: common_osnoise_description.txt 19 19 20 20 **rtla osnoise top** collects the periodic summary from the *osnoise* tracer, 21 21 including the counters of the occurrence of the interference source, ··· 26 26 27 27 OPTIONS 28 28 ======= 29 - .. include:: common_osnoise_options.rst 29 + .. include:: common_osnoise_options.txt 30 30 31 - .. include:: common_top_options.rst 31 + .. include:: common_top_options.txt 32 32 33 - .. include:: common_options.rst 33 + .. include:: common_options.txt 34 34 35 35 EXAMPLE 36 36 ======= ··· 60 60 ====== 61 61 Written by Daniel Bristot de Oliveira <bristot@kernel.org> 62 62 63 - .. include:: common_appendix.rst 63 + .. include:: common_appendix.txt
+2 -2
Documentation/tools/rtla/rtla-osnoise.rst
··· 14 14 DESCRIPTION 15 15 =========== 16 16 17 - .. include:: common_osnoise_description.rst 17 + .. include:: common_osnoise_description.txt 18 18 19 19 The *osnoise* tracer outputs information in two ways. It periodically prints 20 20 a summary of the noise of the operating system, including the counters of ··· 56 56 ====== 57 57 Written by Daniel Bristot de Oliveira <bristot@kernel.org> 58 58 59 - .. include:: common_appendix.rst 59 + .. include:: common_appendix.txt
+6 -6
Documentation/tools/rtla/rtla-timerlat-hist.rst
··· 16 16 DESCRIPTION 17 17 =========== 18 18 19 - .. include:: common_timerlat_description.rst 19 + .. include:: common_timerlat_description.txt 20 20 21 21 The **rtla timerlat hist** displays a histogram of each tracer event 22 22 occurrence. This tool uses the periodic information, and the ··· 25 25 OPTIONS 26 26 ======= 27 27 28 - .. include:: common_timerlat_options.rst 28 + .. include:: common_timerlat_options.txt 29 29 30 - .. include:: common_hist_options.rst 30 + .. include:: common_hist_options.txt 31 31 32 - .. include:: common_options.rst 32 + .. include:: common_options.txt 33 33 34 - .. include:: common_timerlat_aa.rst 34 + .. include:: common_timerlat_aa.txt 35 35 36 36 EXAMPLE 37 37 ======= ··· 110 110 ====== 111 111 Written by Daniel Bristot de Oliveira <bristot@kernel.org> 112 112 113 - .. include:: common_appendix.rst 113 + .. include:: common_appendix.txt
+6 -6
Documentation/tools/rtla/rtla-timerlat-top.rst
··· 16 16 DESCRIPTION 17 17 =========== 18 18 19 - .. include:: common_timerlat_description.rst 19 + .. include:: common_timerlat_description.txt 20 20 21 21 The **rtla timerlat top** displays a summary of the periodic output 22 22 from the *timerlat* tracer. It also provides information for each ··· 26 26 OPTIONS 27 27 ======= 28 28 29 - .. include:: common_timerlat_options.rst 29 + .. include:: common_timerlat_options.txt 30 30 31 - .. include:: common_top_options.rst 31 + .. include:: common_top_options.txt 32 32 33 - .. include:: common_options.rst 33 + .. include:: common_options.txt 34 34 35 - .. include:: common_timerlat_aa.rst 35 + .. include:: common_timerlat_aa.txt 36 36 37 37 **--aa-only** *us* 38 38 ··· 133 133 ------ 134 134 Written by Daniel Bristot de Oliveira <bristot@kernel.org> 135 135 136 - .. include:: common_appendix.rst 136 + .. include:: common_appendix.txt
+2 -2
Documentation/tools/rtla/rtla-timerlat.rst
··· 14 14 DESCRIPTION 15 15 =========== 16 16 17 - .. include:: common_timerlat_description.rst 17 + .. include:: common_timerlat_description.txt 18 18 19 19 The **rtla timerlat top** mode displays a summary of the periodic output 20 20 from the *timerlat* tracer. The **rtla timerlat hist** mode displays ··· 51 51 ====== 52 52 Written by Daniel Bristot de Oliveira <bristot@kernel.org> 53 53 54 - .. include:: common_appendix.rst 54 + .. include:: common_appendix.txt
+1 -1
Documentation/tools/rtla/rtla.rst
··· 45 45 ====== 46 46 Daniel Bristot de Oliveira <bristot@kernel.org> 47 47 48 - .. include:: common_appendix.rst 48 + .. include:: common_appendix.txt