linux-kernel - [PATCH] docs: rtla: replace dashes with spaces in titles

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date:   Wed,  2 Aug 2023 06:50:36 +0300
From:   Costa Shulyupin <costa.shul@...hat.com>
To:     Daniel Bristot de Oliveira <bristot@...nel.org>,
        Steven Rostedt <rostedt@...dmis.org>,
        Jonathan Corbet <corbet@....net>,
        linux-trace-kernel@...r.kernel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Cc:     Costa Shulyupin <costa.shul@...hat.com>
Subject: [PATCH] docs: rtla: replace dashes with spaces in titles

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@...hat.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