[PATCH 5/8] Documentation/rtla: rename common_timerlat_description.rst

Gopi Krishna Menon
2025-10-07T18:55:59Z

common_timerlat_description.rst is intended to be included by other rtla
documents and is not meant to be built as a standalone document.

Rename common_timerlat_description.rst to
common_timerlat_description.txt to maintain consistency with other
common_*.txt files and prevent Sphinx from building it as a standalone
document. Update all include references accordingly.

Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Gopi Krishna Menon <krishnagopi487@gmail.com>
---
...timerlat_description.rst => common_timerlat_description.txt} | 0
Documentation/tools/rtla/rtla-timerlat-hist.rst | 2 +-
Documentation/tools/rtla/rtla-timerlat-top.rst | 2 +-
Documentation/tools/rtla/rtla-timerlat.rst | 2 +-
4 files changed, 3 insertions(+), 3 deletions(-)
rename Documentation/tools/rtla/{common_timerlat_description.rst => common_timerlat_description.txt} (100%)

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/rtla-timerlat-hist.rst b/Documentation/tools/rtla/rtla-timerlat-hist.rst
index ae1638bb9a99..61b5b55be96e 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
diff --git a/Documentation/tools/rtla/rtla-timerlat-top.rst b/Documentation/tools/rtla/rtla-timerlat-top.rst
index 19cb5d203845..6f09f30c74f0 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
diff --git a/Documentation/tools/rtla/rtla-timerlat.rst b/Documentation/tools/rtla/rtla-timerlat.rst
index e66d2588a416..ce9f57e038c3 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
--
2.43.0