From: Gopi Krishna Menon <krishnagopi487@gmail.com>
To: rostedt@goodmis.org, corbet@lwn.net
Cc: Gopi Krishna Menon <krishnagopi487@gmail.com>,
linux-trace-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, skhan@linuxfoundation.org,
david.hunter.linux@gmail.com, khalid@kernel.org,
linux-kernel-mentees@lists.linux.dev, crwood@redhat.com,
tglozar@redhat.com, costa.shul@redhat.com, jkacur@redhat.com,
Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH 5/8] Documentation/rtla: rename common_timerlat_description.rst
Date: Wed, 8 Oct 2025 00:24:54 +0530 [thread overview]
Message-ID: <20251007185508.40908-6-krishnagopi487@gmail.com> (raw)
In-Reply-To: <20251007185508.40908-1-krishnagopi487@gmail.com>
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
next prev parent reply other threads:[~2025-10-07 18:55 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
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 ` Gopi Krishna Menon [this message]
2025-10-08 0:09 ` [PATCH 5/8] Documentation/rtla: rename common_timerlat_description.rst 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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251007185508.40908-6-krishnagopi487@gmail.com \
--to=krishnagopi487@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=costa.shul@redhat.com \
--cc=crwood@redhat.com \
--cc=david.hunter.linux@gmail.com \
--cc=jkacur@redhat.com \
--cc=khalid@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linux.dev \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=rostedt@goodmis.org \
--cc=skhan@linuxfoundation.org \
--cc=tglozar@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox