docs: rtla: replace dashes with spaces in titles
Commit Message
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(-)
Comments
On 8/2/23 05:50, Costa Shulyupin wrote:
> 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
I added the - because that is how we call the man-pages:
man rtla-osnoise-top
--------------- %< ----------------------
RTLA-OSNOISE-TOP(1) RTLA-OSNOISE-TOP(1)
NAME
rtla-osnoise-top - Display a summary of the operating system noise
SYNOPSIS
rtla osnoise top [OPTIONS]
--------------- %< ----------------------
and it is also inline with other kernel tools, like perf:
man perf-record
--------------- %< ----------------------
PERF-RECORD(1) perf Manual PERF-RECORD(1)
NAME
perf-record - Run a command and record its profile into perf.data
SYNOPSIS
perf record [-e <EVENT> | --event=EVENT] [-a] <command>
perf record [-e <EVENT> | --event=EVENT] [-a] -- <command> [<options>]
--------------- %< ----------------------
also...
[bristot@x1 rtla]$ make
rst2man --verbose rtla-hwnoise.rst > rtla-hwnoise.1
rst2man --verbose rtla-osnoise-hist.rst > rtla-osnoise-hist.1
rtla-osnoise-hist.rst:1: (ERROR/3) Invalid section title or transition marker.
===================
===================
rst2man --verbose rtla-osnoise.rst > rtla-osnoise.1
rtla-osnoise.rst:1: (ERROR/3) Invalid section title or transition marker.
===============
===============
rtla-osnoise.rst:3: (SEVERE/4) Missing matching underline for section title overline.
------------------------------------------------------------------
rtla osnoise
Measure the operating system noise
Exiting due to level-4 (SEVERE) system message.
make: *** [Makefile:36: rtla-osnoise.1] Error 1
[bristot@x1 rtla]$
> Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
@@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0
============
-rtla-hwnoise
+rtla hwnoise
============
------------------------------------------
Detect and quantify hardware-related noise
@@ -1,6 +1,6 @@
===================
-rtla-osnoise-hist
===================
+rtla osnoise hist
------------------------------------------------------
Display a histogram of the osnoise tracer samples
------------------------------------------------------
@@ -1,5 +1,4 @@
===================
-rtla-osnoise-top
===================
-----------------------------------------------
Display a summary of the operating system noise
@@ -1,7 +1,7 @@
===============
-rtla-osnoise
===============
------------------------------------------------------------------
+rtla osnoise
Measure the operating system noise
------------------------------------------------------------------
@@ -1,6 +1,6 @@
=====================
-rtla-timerlat-hist
=====================
+rtla timerlat hist
------------------------------------------------
Histograms of the operating system timer latency
------------------------------------------------
@@ -1,6 +1,6 @@
====================
-rtla-timerlat-top
====================
+rtla timerlat top
-------------------------------------------
Measures the operating system timer latency
-------------------------------------------
@@ -1,6 +1,6 @@
================
-rtla-timerlat
================
+rtla timerlat
-------------------------------------------
Measures the operating system timer latency
-------------------------------------------