From: Costa Shulyupin <costa.shul@redhat.com>
To: Daniel Bristot de Oliveira <bristot@kernel.org>,
Steven Rostedt <rostedt@goodmis.org>,
Jonathan Corbet <corbet@lwn.net>,
linux-trace-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Cc: Costa Shulyupin <costa.shul@redhat.com>
Subject: [PATCH] docs: rtla: replace dashes with spaces in titles
Date: Wed, 2 Aug 2023 06:50:36 +0300 [thread overview]
Message-ID: <20230802035037.404230-1-costa.shul@redhat.com> (raw)
because
- Titles containing spaces offer better readability compared
to those with dashes
- Commands and their described subcommands are separated by spaces
- Ensure that the titles are identical to the commands with subcommands
Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
---
Documentation/tools/rtla/rtla-hwnoise.rst | 2 +-
Documentation/tools/rtla/rtla-osnoise-hist.rst | 2 +-
Documentation/tools/rtla/rtla-osnoise-top.rst | 1 -
Documentation/tools/rtla/rtla-osnoise.rst | 2 +-
Documentation/tools/rtla/rtla-timerlat-hist.rst | 2 +-
Documentation/tools/rtla/rtla-timerlat-top.rst | 2 +-
Documentation/tools/rtla/rtla-timerlat.rst | 2 +-
7 files changed, 6 insertions(+), 7 deletions(-)
diff --git a/Documentation/tools/rtla/rtla-hwnoise.rst b/Documentation/tools/rtla/rtla-hwnoise.rst
index fb1c52bbc00b..1ed4ceeb4660 100644
--- a/Documentation/tools/rtla/rtla-hwnoise.rst
+++ b/Documentation/tools/rtla/rtla-hwnoise.rst
@@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0
============
-rtla-hwnoise
+rtla hwnoise
============
------------------------------------------
Detect and quantify hardware-related noise
diff --git a/Documentation/tools/rtla/rtla-osnoise-hist.rst b/Documentation/tools/rtla/rtla-osnoise-hist.rst
index f2e79d22c4c4..c15ab9be07e9 100644
--- a/Documentation/tools/rtla/rtla-osnoise-hist.rst
+++ b/Documentation/tools/rtla/rtla-osnoise-hist.rst
@@ -1,6 +1,6 @@
===================
-rtla-osnoise-hist
===================
+rtla osnoise hist
------------------------------------------------------
Display a histogram of the osnoise tracer samples
------------------------------------------------------
diff --git a/Documentation/tools/rtla/rtla-osnoise-top.rst b/Documentation/tools/rtla/rtla-osnoise-top.rst
index 5d75d1394516..464459e55a17 100644
--- a/Documentation/tools/rtla/rtla-osnoise-top.rst
+++ b/Documentation/tools/rtla/rtla-osnoise-top.rst
@@ -1,5 +1,4 @@
===================
-rtla-osnoise-top
===================
-----------------------------------------------
Display a summary of the operating system noise
diff --git a/Documentation/tools/rtla/rtla-osnoise.rst b/Documentation/tools/rtla/rtla-osnoise.rst
index c129b206ce34..8a2e0504d737 100644
--- a/Documentation/tools/rtla/rtla-osnoise.rst
+++ b/Documentation/tools/rtla/rtla-osnoise.rst
@@ -1,7 +1,7 @@
===============
-rtla-osnoise
===============
------------------------------------------------------------------
+rtla osnoise
Measure the operating system noise
------------------------------------------------------------------
diff --git a/Documentation/tools/rtla/rtla-timerlat-hist.rst b/Documentation/tools/rtla/rtla-timerlat-hist.rst
index 057db78d4095..84ab9f542ebb 100644
--- a/Documentation/tools/rtla/rtla-timerlat-hist.rst
+++ b/Documentation/tools/rtla/rtla-timerlat-hist.rst
@@ -1,6 +1,6 @@
=====================
-rtla-timerlat-hist
=====================
+rtla timerlat hist
------------------------------------------------
Histograms of the operating system timer latency
------------------------------------------------
diff --git a/Documentation/tools/rtla/rtla-timerlat-top.rst b/Documentation/tools/rtla/rtla-timerlat-top.rst
index 1b7cf4e3eafe..8be4ccaff898 100644
--- a/Documentation/tools/rtla/rtla-timerlat-top.rst
+++ b/Documentation/tools/rtla/rtla-timerlat-top.rst
@@ -1,6 +1,6 @@
====================
-rtla-timerlat-top
====================
+rtla timerlat top
-------------------------------------------
Measures the operating system timer latency
-------------------------------------------
diff --git a/Documentation/tools/rtla/rtla-timerlat.rst b/Documentation/tools/rtla/rtla-timerlat.rst
index 44a49e6f302b..eceb3a16af08 100644
--- a/Documentation/tools/rtla/rtla-timerlat.rst
+++ b/Documentation/tools/rtla/rtla-timerlat.rst
@@ -1,6 +1,6 @@
================
-rtla-timerlat
================
+rtla timerlat
-------------------------------------------
Measures the operating system timer latency
-------------------------------------------
--
2.41.0
next reply other threads:[~2023-08-02 3:51 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-02 3:50 Costa Shulyupin [this message]
2023-08-02 7:12 ` Daniel Bristot de Oliveira
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=20230802035037.404230-1-costa.shul@redhat.com \
--to=costa.shul@redhat.com \
--cc=bristot@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=rostedt@goodmis.org \
/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
all inboxes | Powered by JetHome®