* [PATCH] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt
@ 2025-10-13 9:27 Bagas Sanjaya
2025-10-14 3:39 ` Randy Dunlap
2025-10-17 20:27 ` Jonathan Corbet
0 siblings, 2 replies; 6+ messages in thread
From: Bagas Sanjaya @ 2025-10-13 9:27 UTC (permalink / raw)
To: Linux Kernel Mailing List, Linux Documentation,
Linux Kernel Tracing
Cc: Daniel Bristot de Oliveira, Steven Rostedt, Jonathan Corbet,
Tomas Glozar, Crystal Wood, Bagas Sanjaya, Gopi Krishna Menon
From: Gopi Krishna Menon <krishnagopi487@gmail.com>
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>
---
This patch targets trace/fixes branch of linux-trace.git tree.
.../{common_appendix.rst => common_appendix.txt} | 0
...mmon_hist_options.rst => common_hist_options.txt} | 0
.../rtla/{common_options.rst => common_options.txt} | 0
...escription.rst => common_osnoise_description.txt} | 0
...snoise_options.rst => common_osnoise_options.txt} | 0
...common_timerlat_aa.rst => common_timerlat_aa.txt} | 0
...scription.rst => common_timerlat_description.txt} | 0
...erlat_options.rst => common_timerlat_options.txt} | 0
...common_top_options.rst => common_top_options.txt} | 0
Documentation/tools/rtla/rtla-hwnoise.rst | 8 ++++----
Documentation/tools/rtla/rtla-osnoise-hist.rst | 10 +++++-----
Documentation/tools/rtla/rtla-osnoise-top.rst | 10 +++++-----
Documentation/tools/rtla/rtla-osnoise.rst | 4 ++--
Documentation/tools/rtla/rtla-timerlat-hist.rst | 12 ++++++------
Documentation/tools/rtla/rtla-timerlat-top.rst | 12 ++++++------
Documentation/tools/rtla/rtla-timerlat.rst | 4 ++--
Documentation/tools/rtla/rtla.rst | 2 +-
17 files changed, 31 insertions(+), 31 deletions(-)
rename Documentation/tools/rtla/{common_appendix.rst => common_appendix.txt} (100%)
rename Documentation/tools/rtla/{common_hist_options.rst => common_hist_options.txt} (100%)
rename Documentation/tools/rtla/{common_options.rst => common_options.txt} (100%)
rename Documentation/tools/rtla/{common_osnoise_description.rst => common_osnoise_description.txt} (100%)
rename Documentation/tools/rtla/{common_osnoise_options.rst => common_osnoise_options.txt} (100%)
rename Documentation/tools/rtla/{common_timerlat_aa.rst => common_timerlat_aa.txt} (100%)
rename Documentation/tools/rtla/{common_timerlat_description.rst => common_timerlat_description.txt} (100%)
rename Documentation/tools/rtla/{common_timerlat_options.rst => common_timerlat_options.txt} (100%)
rename Documentation/tools/rtla/{common_top_options.rst => common_top_options.txt} (100%)
diff --git a/Documentation/tools/rtla/common_appendix.rst b/Documentation/tools/rtla/common_appendix.txt
similarity index 100%
rename from Documentation/tools/rtla/common_appendix.rst
rename to Documentation/tools/rtla/common_appendix.txt
diff --git a/Documentation/tools/rtla/common_hist_options.rst b/Documentation/tools/rtla/common_hist_options.txt
similarity index 100%
rename from Documentation/tools/rtla/common_hist_options.rst
rename to Documentation/tools/rtla/common_hist_options.txt
diff --git a/Documentation/tools/rtla/common_options.rst b/Documentation/tools/rtla/common_options.txt
similarity index 100%
rename from Documentation/tools/rtla/common_options.rst
rename to Documentation/tools/rtla/common_options.txt
diff --git a/Documentation/tools/rtla/common_osnoise_description.rst b/Documentation/tools/rtla/common_osnoise_description.txt
similarity index 100%
rename from Documentation/tools/rtla/common_osnoise_description.rst
rename to Documentation/tools/rtla/common_osnoise_description.txt
diff --git a/Documentation/tools/rtla/common_osnoise_options.rst b/Documentation/tools/rtla/common_osnoise_options.txt
similarity index 100%
rename from Documentation/tools/rtla/common_osnoise_options.rst
rename to Documentation/tools/rtla/common_osnoise_options.txt
diff --git a/Documentation/tools/rtla/common_timerlat_aa.rst b/Documentation/tools/rtla/common_timerlat_aa.txt
similarity index 100%
rename from Documentation/tools/rtla/common_timerlat_aa.rst
rename to Documentation/tools/rtla/common_timerlat_aa.txt
diff --git a/Documentation/tools/rtla/common_timerlat_description.rst b/Documentation/tools/rtla/common_timerlat_description.txt
similarity index 100%
rename from Documentation/tools/rtla/common_timerlat_description.rst
rename to Documentation/tools/rtla/common_timerlat_description.txt
diff --git a/Documentation/tools/rtla/common_timerlat_options.rst b/Documentation/tools/rtla/common_timerlat_options.txt
similarity index 100%
rename from Documentation/tools/rtla/common_timerlat_options.rst
rename to Documentation/tools/rtla/common_timerlat_options.txt
diff --git a/Documentation/tools/rtla/common_top_options.rst b/Documentation/tools/rtla/common_top_options.txt
similarity index 100%
rename from Documentation/tools/rtla/common_top_options.rst
rename to Documentation/tools/rtla/common_top_options.txt
diff --git a/Documentation/tools/rtla/rtla-hwnoise.rst b/Documentation/tools/rtla/rtla-hwnoise.rst
index 3a7163c02ac8e8..26512b15fe7ba5 100644
--- a/Documentation/tools/rtla/rtla-hwnoise.rst
+++ b/Documentation/tools/rtla/rtla-hwnoise.rst
@@ -29,11 +29,11 @@ collection of the tracer output.
OPTIONS
=======
-.. include:: common_osnoise_options.rst
+.. include:: common_osnoise_options.txt
-.. include:: common_top_options.rst
+.. include:: common_top_options.txt
-.. include:: common_options.rst
+.. include:: common_options.txt
EXAMPLE
=======
@@ -106,4 +106,4 @@ AUTHOR
======
Written by Daniel Bristot de Oliveira <bristot@kernel.org>
-.. include:: common_appendix.rst
+.. include:: common_appendix.txt
diff --git a/Documentation/tools/rtla/rtla-osnoise-hist.rst b/Documentation/tools/rtla/rtla-osnoise-hist.rst
index 1fc60ef2610677..007521c865d97e 100644
--- a/Documentation/tools/rtla/rtla-osnoise-hist.rst
+++ b/Documentation/tools/rtla/rtla-osnoise-hist.rst
@@ -15,7 +15,7 @@ SYNOPSIS
DESCRIPTION
===========
-.. include:: common_osnoise_description.rst
+.. include:: common_osnoise_description.txt
The **rtla osnoise hist** tool collects all **osnoise:sample_threshold**
occurrence in a histogram, displaying the results in a user-friendly way.
@@ -24,11 +24,11 @@ collection of the tracer output.
OPTIONS
=======
-.. include:: common_osnoise_options.rst
+.. include:: common_osnoise_options.txt
-.. include:: common_hist_options.rst
+.. include:: common_hist_options.txt
-.. include:: common_options.rst
+.. include:: common_options.txt
EXAMPLE
=======
@@ -65,4 +65,4 @@ AUTHOR
======
Written by Daniel Bristot de Oliveira <bristot@kernel.org>
-.. include:: common_appendix.rst
+.. include:: common_appendix.txt
diff --git a/Documentation/tools/rtla/rtla-osnoise-top.rst b/Documentation/tools/rtla/rtla-osnoise-top.rst
index b1cbd7bcd4aed2..6ccadae3894570 100644
--- a/Documentation/tools/rtla/rtla-osnoise-top.rst
+++ b/Documentation/tools/rtla/rtla-osnoise-top.rst
@@ -15,7 +15,7 @@ SYNOPSIS
DESCRIPTION
===========
-.. include:: common_osnoise_description.rst
+.. include:: common_osnoise_description.txt
**rtla osnoise top** collects the periodic summary from the *osnoise* tracer,
including the counters of the occurrence of the interference source,
@@ -26,11 +26,11 @@ collection of the tracer output.
OPTIONS
=======
-.. include:: common_osnoise_options.rst
+.. include:: common_osnoise_options.txt
-.. include:: common_top_options.rst
+.. include:: common_top_options.txt
-.. include:: common_options.rst
+.. include:: common_options.txt
EXAMPLE
=======
@@ -60,4 +60,4 @@ AUTHOR
======
Written by Daniel Bristot de Oliveira <bristot@kernel.org>
-.. include:: common_appendix.rst
+.. include:: common_appendix.txt
diff --git a/Documentation/tools/rtla/rtla-osnoise.rst b/Documentation/tools/rtla/rtla-osnoise.rst
index c129b206ce3484..540d2bf6c15247 100644
--- a/Documentation/tools/rtla/rtla-osnoise.rst
+++ b/Documentation/tools/rtla/rtla-osnoise.rst
@@ -14,7 +14,7 @@ SYNOPSIS
DESCRIPTION
===========
-.. include:: common_osnoise_description.rst
+.. include:: common_osnoise_description.txt
The *osnoise* tracer outputs information in two ways. It periodically prints
a summary of the noise of the operating system, including the counters of
@@ -56,4 +56,4 @@ AUTHOR
======
Written by Daniel Bristot de Oliveira <bristot@kernel.org>
-.. include:: common_appendix.rst
+.. include:: common_appendix.txt
diff --git a/Documentation/tools/rtla/rtla-timerlat-hist.rst b/Documentation/tools/rtla/rtla-timerlat-hist.rst
index 4923a362129bbd..f56fe546411bd4 100644
--- a/Documentation/tools/rtla/rtla-timerlat-hist.rst
+++ b/Documentation/tools/rtla/rtla-timerlat-hist.rst
@@ -16,7 +16,7 @@ SYNOPSIS
DESCRIPTION
===========
-.. include:: common_timerlat_description.rst
+.. include:: common_timerlat_description.txt
The **rtla timerlat hist** displays a histogram of each tracer event
occurrence. This tool uses the periodic information, and the
@@ -25,13 +25,13 @@ occurrence. This tool uses the periodic information, and the
OPTIONS
=======
-.. include:: common_timerlat_options.rst
+.. include:: common_timerlat_options.txt
-.. include:: common_hist_options.rst
+.. include:: common_hist_options.txt
-.. include:: common_options.rst
+.. include:: common_options.txt
-.. include:: common_timerlat_aa.rst
+.. include:: common_timerlat_aa.txt
EXAMPLE
=======
@@ -110,4 +110,4 @@ AUTHOR
======
Written by Daniel Bristot de Oliveira <bristot@kernel.org>
-.. include:: common_appendix.rst
+.. include:: common_appendix.txt
diff --git a/Documentation/tools/rtla/rtla-timerlat-top.rst b/Documentation/tools/rtla/rtla-timerlat-top.rst
index 50968cdd2095a1..7dbe625d0c4243 100644
--- a/Documentation/tools/rtla/rtla-timerlat-top.rst
+++ b/Documentation/tools/rtla/rtla-timerlat-top.rst
@@ -16,7 +16,7 @@ SYNOPSIS
DESCRIPTION
===========
-.. include:: common_timerlat_description.rst
+.. include:: common_timerlat_description.txt
The **rtla timerlat top** displays a summary of the periodic output
from the *timerlat* tracer. It also provides information for each
@@ -26,13 +26,13 @@ seem with the option **-T**.
OPTIONS
=======
-.. include:: common_timerlat_options.rst
+.. include:: common_timerlat_options.txt
-.. include:: common_top_options.rst
+.. include:: common_top_options.txt
-.. include:: common_options.rst
+.. include:: common_options.txt
-.. include:: common_timerlat_aa.rst
+.. include:: common_timerlat_aa.txt
**--aa-only** *us*
@@ -133,4 +133,4 @@ AUTHOR
------
Written by Daniel Bristot de Oliveira <bristot@kernel.org>
-.. include:: common_appendix.rst
+.. include:: common_appendix.txt
diff --git a/Documentation/tools/rtla/rtla-timerlat.rst b/Documentation/tools/rtla/rtla-timerlat.rst
index 20e2d259467fd0..ce9f57e038c37f 100644
--- a/Documentation/tools/rtla/rtla-timerlat.rst
+++ b/Documentation/tools/rtla/rtla-timerlat.rst
@@ -14,7 +14,7 @@ SYNOPSIS
DESCRIPTION
===========
-.. include:: common_timerlat_description.rst
+.. include:: common_timerlat_description.txt
The **rtla timerlat top** mode displays a summary of the periodic output
from the *timerlat* tracer. The **rtla timerlat hist** mode displays
@@ -51,4 +51,4 @@ AUTHOR
======
Written by Daniel Bristot de Oliveira <bristot@kernel.org>
-.. include:: common_appendix.rst
+.. include:: common_appendix.txt
diff --git a/Documentation/tools/rtla/rtla.rst b/Documentation/tools/rtla/rtla.rst
index fc0d233efcd5df..2a5fb7004ad448 100644
--- a/Documentation/tools/rtla/rtla.rst
+++ b/Documentation/tools/rtla/rtla.rst
@@ -45,4 +45,4 @@ AUTHOR
======
Daniel Bristot de Oliveira <bristot@kernel.org>
-.. include:: common_appendix.rst
+.. include:: common_appendix.txt
base-commit: 3a8660878839faadb4f1a6dd72c3179c1df56787
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt
2025-10-13 9:27 [PATCH] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt Bagas Sanjaya
@ 2025-10-14 3:39 ` Randy Dunlap
2025-10-17 20:27 ` Jonathan Corbet
1 sibling, 0 replies; 6+ messages in thread
From: Randy Dunlap @ 2025-10-14 3:39 UTC (permalink / raw)
To: Bagas Sanjaya, Linux Kernel Mailing List, Linux Documentation,
Linux Kernel Tracing
Cc: Daniel Bristot de Oliveira, Steven Rostedt, Jonathan Corbet,
Tomas Glozar, Crystal Wood, Gopi Krishna Menon
On 10/13/25 2:27 AM, Bagas Sanjaya wrote:
> From: Gopi Krishna Menon <krishnagopi487@gmail.com>
>
> 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>
Thanks.
> ---
> This patch targets trace/fixes branch of linux-trace.git tree.
>
> .../{common_appendix.rst => common_appendix.txt} | 0
> ...mmon_hist_options.rst => common_hist_options.txt} | 0
> .../rtla/{common_options.rst => common_options.txt} | 0
> ...escription.rst => common_osnoise_description.txt} | 0
> ...snoise_options.rst => common_osnoise_options.txt} | 0
> ...common_timerlat_aa.rst => common_timerlat_aa.txt} | 0
> ...scription.rst => common_timerlat_description.txt} | 0
> ...erlat_options.rst => common_timerlat_options.txt} | 0
> ...common_top_options.rst => common_top_options.txt} | 0
> Documentation/tools/rtla/rtla-hwnoise.rst | 8 ++++----
> Documentation/tools/rtla/rtla-osnoise-hist.rst | 10 +++++-----
> Documentation/tools/rtla/rtla-osnoise-top.rst | 10 +++++-----
> Documentation/tools/rtla/rtla-osnoise.rst | 4 ++--
> Documentation/tools/rtla/rtla-timerlat-hist.rst | 12 ++++++------
> Documentation/tools/rtla/rtla-timerlat-top.rst | 12 ++++++------
> Documentation/tools/rtla/rtla-timerlat.rst | 4 ++--
> Documentation/tools/rtla/rtla.rst | 2 +-
> 17 files changed, 31 insertions(+), 31 deletions(-)
> rename Documentation/tools/rtla/{common_appendix.rst => common_appendix.txt} (100%)
> rename Documentation/tools/rtla/{common_hist_options.rst => common_hist_options.txt} (100%)
> rename Documentation/tools/rtla/{common_options.rst => common_options.txt} (100%)
> rename Documentation/tools/rtla/{common_osnoise_description.rst => common_osnoise_description.txt} (100%)
> rename Documentation/tools/rtla/{common_osnoise_options.rst => common_osnoise_options.txt} (100%)
> rename Documentation/tools/rtla/{common_timerlat_aa.rst => common_timerlat_aa.txt} (100%)
> rename Documentation/tools/rtla/{common_timerlat_description.rst => common_timerlat_description.txt} (100%)
> rename Documentation/tools/rtla/{common_timerlat_options.rst => common_timerlat_options.txt} (100%)
> rename Documentation/tools/rtla/{common_top_options.rst => common_top_options.txt} (100%)
--
~Randy
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt
2025-10-13 9:27 [PATCH] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt Bagas Sanjaya
2025-10-14 3:39 ` Randy Dunlap
@ 2025-10-17 20:27 ` Jonathan Corbet
2025-10-18 5:49 ` Bagas Sanjaya
1 sibling, 1 reply; 6+ messages in thread
From: Jonathan Corbet @ 2025-10-17 20:27 UTC (permalink / raw)
To: Bagas Sanjaya, Linux Kernel Mailing List, Linux Documentation,
Linux Kernel Tracing
Cc: Steven Rostedt, Tomas Glozar, Crystal Wood, Bagas Sanjaya,
Gopi Krishna Menon
Bagas Sanjaya <bagasdotme@gmail.com> writes:
> From: Gopi Krishna Menon <krishnagopi487@gmail.com>
>
> 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.
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt
2025-10-17 20:27 ` Jonathan Corbet
@ 2025-10-18 5:49 ` Bagas Sanjaya
2025-10-18 14:20 ` Jonathan Corbet
0 siblings, 1 reply; 6+ messages in thread
From: Bagas Sanjaya @ 2025-10-18 5:49 UTC (permalink / raw)
To: Jonathan Corbet, Linux Kernel Mailing List, Linux Documentation,
Linux Kernel Tracing
Cc: Steven Rostedt, Tomas Glozar, Crystal Wood, Gopi Krishna Menon
[-- Attachment #1: Type: text/plain, Size: 1634 bytes --]
On Fri, Oct 17, 2025 at 02:27:01PM -0600, Jonathan Corbet wrote:
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
>
> > From: Gopi Krishna Menon <krishnagopi487@gmail.com>
> >
> > 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.
>
> Applied, thanks.
Shouldn't this more appropriate as a fix for current cycle (6.18)? I see
the warnings on Linus's tree, though.
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt
2025-10-18 5:49 ` Bagas Sanjaya
@ 2025-10-18 14:20 ` Jonathan Corbet
2025-10-18 14:30 ` Bagas Sanjaya
0 siblings, 1 reply; 6+ messages in thread
From: Jonathan Corbet @ 2025-10-18 14:20 UTC (permalink / raw)
To: Bagas Sanjaya, Linux Kernel Mailing List, Linux Documentation,
Linux Kernel Tracing
Cc: Steven Rostedt, Tomas Glozar, Crystal Wood, Gopi Krishna Menon
Bagas Sanjaya <bagasdotme@gmail.com> writes:
> On Fri, Oct 17, 2025 at 02:27:01PM -0600, Jonathan Corbet wrote:
>> Bagas Sanjaya <bagasdotme@gmail.com> writes:
>>
>> > From: Gopi Krishna Menon <krishnagopi487@gmail.com>
>> >
>> > 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.
>>
>> Applied, thanks.
>
> Shouldn't this more appropriate as a fix for current cycle (6.18)? I see
> the warnings on Linus's tree, though.
As a general rule, I don't see warning fixes as being important enough
to send outside of the merge window; the next cycle isn't that far away.
jon
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt
2025-10-18 14:20 ` Jonathan Corbet
@ 2025-10-18 14:30 ` Bagas Sanjaya
0 siblings, 0 replies; 6+ messages in thread
From: Bagas Sanjaya @ 2025-10-18 14:30 UTC (permalink / raw)
To: Jonathan Corbet, Linux Kernel Mailing List, Linux Documentation,
Linux Kernel Tracing
Cc: Steven Rostedt, Tomas Glozar, Crystal Wood, Gopi Krishna Menon
[-- Attachment #1: Type: text/plain, Size: 470 bytes --]
On Sat, Oct 18, 2025 at 08:20:34AM -0600, Jonathan Corbet wrote:
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
>
> > Shouldn't this more appropriate as a fix for current cycle (6.18)? I see
> > the warnings on Linus's tree, though.
>
> As a general rule, I don't see warning fixes as being important enough
> to send outside of the merge window; the next cycle isn't that far away.
OK, thanks!
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2025-10-18 14:30 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-13 9:27 [PATCH] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt Bagas Sanjaya
2025-10-14 3:39 ` Randy Dunlap
2025-10-17 20:27 ` Jonathan Corbet
2025-10-18 5:49 ` Bagas Sanjaya
2025-10-18 14:20 ` Jonathan Corbet
2025-10-18 14:30 ` Bagas Sanjaya
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).