[PATCH] Documentation/rtla: fix htmldocs build error by renaming common_options.rst

Gopi Krishna Menon
2025-10-07T08:32:38Z

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