linux-trace-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Documentation/rtla: fix htmldocs build error by renaming common_options.rst
@ 2025-10-07  8:32 Gopi Krishna Menon
  2025-10-07 11:47 ` Bagas Sanjaya
  2025-10-07 12:51 ` Bagas Sanjaya
  0 siblings, 2 replies; 24+ messages in thread
From: Gopi Krishna Menon @ 2025-10-07  8:32 UTC (permalink / raw)
  To: rostedt, corbet
  Cc: Gopi Krishna Menon, linux-trace-kernel, linux-doc, linux-kernel,
	skhan, david.hunter.linux, khalid, linux-kernel-mentees

Running "make htmldocs" generates 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_options.rst is intended to be included by other rtla documents
and is not meant to be built as a standalone document. It contains
substitutions that are only resolved by other documents, so building it
independently results in 'undefined substitution referenced' errors.

Rename common_options.rst to common_options.txt to prevent Sphinx from
building it as a standalone document and update the include references
accordingly.

Signed-off-by: Gopi Krishna Menon <krishnagopi487@gmail.com>
---

Note: reStructuredText substitutions -
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions

Tested by running "make htmldocs" before and after the change,
verifying that no substitution errors are generated and the 
output renders correctly in browsers.

 .../tools/rtla/{common_options.rst => common_options.txt}       | 0
 Documentation/tools/rtla/rtla-hwnoise.rst                       | 2 +-
 Documentation/tools/rtla/rtla-osnoise-hist.rst                  | 2 +-
 Documentation/tools/rtla/rtla-osnoise-top.rst                   | 2 +-
 Documentation/tools/rtla/rtla-timerlat-hist.rst                 | 2 +-
 Documentation/tools/rtla/rtla-timerlat-top.rst                  | 2 +-
 6 files changed, 5 insertions(+), 5 deletions(-)
 rename Documentation/tools/rtla/{common_options.rst => common_options.txt} (100%)

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/rtla-hwnoise.rst b/Documentation/tools/rtla/rtla-hwnoise.rst
index 3a7163c02ac8..cc2721315552 100644
--- a/Documentation/tools/rtla/rtla-hwnoise.rst
+++ b/Documentation/tools/rtla/rtla-hwnoise.rst
@@ -33,7 +33,7 @@ OPTIONS
 
 .. include:: common_top_options.rst
 
-.. include:: common_options.rst
+.. include:: common_options.txt
 
 EXAMPLE
 =======
diff --git a/Documentation/tools/rtla/rtla-osnoise-hist.rst b/Documentation/tools/rtla/rtla-osnoise-hist.rst
index 1fc60ef26106..a11c485f127a 100644
--- a/Documentation/tools/rtla/rtla-osnoise-hist.rst
+++ b/Documentation/tools/rtla/rtla-osnoise-hist.rst
@@ -28,7 +28,7 @@ OPTIONS
 
 .. include:: common_hist_options.rst
 
-.. include:: common_options.rst
+.. include:: common_options.txt
 
 EXAMPLE
 =======
diff --git a/Documentation/tools/rtla/rtla-osnoise-top.rst b/Documentation/tools/rtla/rtla-osnoise-top.rst
index b1cbd7bcd4ae..c7bc716b2899 100644
--- a/Documentation/tools/rtla/rtla-osnoise-top.rst
+++ b/Documentation/tools/rtla/rtla-osnoise-top.rst
@@ -30,7 +30,7 @@ OPTIONS
 
 .. include:: common_top_options.rst
 
-.. include:: common_options.rst
+.. include:: common_options.txt
 
 EXAMPLE
 =======
diff --git a/Documentation/tools/rtla/rtla-timerlat-hist.rst b/Documentation/tools/rtla/rtla-timerlat-hist.rst
index 4923a362129b..547dfc7ace58 100644
--- a/Documentation/tools/rtla/rtla-timerlat-hist.rst
+++ b/Documentation/tools/rtla/rtla-timerlat-hist.rst
@@ -29,7 +29,7 @@ OPTIONS
 
 .. include:: common_hist_options.rst
 
-.. include:: common_options.rst
+.. include:: common_options.txt
 
 .. include:: common_timerlat_aa.rst
 
diff --git a/Documentation/tools/rtla/rtla-timerlat-top.rst b/Documentation/tools/rtla/rtla-timerlat-top.rst
index 50968cdd2095..3740fd386ea8 100644
--- a/Documentation/tools/rtla/rtla-timerlat-top.rst
+++ b/Documentation/tools/rtla/rtla-timerlat-top.rst
@@ -30,7 +30,7 @@ OPTIONS
 
 .. include:: common_top_options.rst
 
-.. include:: common_options.rst
+.. include:: common_options.txt
 
 .. include:: common_timerlat_aa.rst
 
-- 
2.43.0


^ permalink raw reply related	[flat|nested] 24+ messages in thread

end of thread, other threads:[~2025-10-09 14:27 UTC | newest]

Thread overview: 24+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-07  8:32 [PATCH] Documentation/rtla: fix htmldocs build error by renaming common_options.rst Gopi Krishna Menon
2025-10-07 11:47 ` Bagas Sanjaya
2025-10-07 12:51 ` Bagas Sanjaya
2025-10-07 18:54   ` [PATCH 0/8] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt Gopi Krishna Menon
2025-10-07 18:54     ` [PATCH 1/8] Documentation/rtla: rename common_appendix.rst Gopi Krishna Menon
2025-10-08  0:01       ` Bagas Sanjaya
2025-10-08  8:51       ` Tomas Glozar
2025-10-08 18:44         ` [PATCH v2] Documentation/rtla: rename common_xxx.rst files to common_xxx.txt Gopi Krishna Menon
2025-10-08 23:19           ` Bagas Sanjaya
2025-10-09 14:26           ` Tomas Glozar
2025-10-07 18:54     ` [PATCH 2/8] Documentation/rtla: rename common_hist_options.rst Gopi Krishna Menon
2025-10-08  0:07       ` Bagas Sanjaya
2025-10-07 18:54     ` [PATCH 3/8] Documentation/rtla: rename common_osnoise_description.rst Gopi Krishna Menon
2025-10-08  0:07       ` Bagas Sanjaya
2025-10-07 18:54     ` [PATCH 4/8] Documentation/rtla: rename common_timerlat_aa.rst Gopi Krishna Menon
2025-10-08  0:08       ` Bagas Sanjaya
2025-10-07 18:54     ` [PATCH 5/8] Documentation/rtla: rename common_timerlat_description.rst Gopi Krishna Menon
2025-10-08  0:09       ` Bagas Sanjaya
2025-10-07 18:54     ` [PATCH 6/8] Documentation/rtla: rename common_timerlat_options.rst Gopi Krishna Menon
2025-10-08  0:10       ` Bagas Sanjaya
2025-10-07 18:54     ` [PATCH 7/8] Documentation/rtla: rename common_top_options.rst Gopi Krishna Menon
2025-10-08  0:10       ` Bagas Sanjaya
2025-10-07 18:54     ` [PATCH 8/8] Documentation/rtla: rename common_osnoise_options.rst Gopi Krishna Menon
2025-10-08  0:11       ` 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).