| Message ID | 20230802035037.404230-1-costa.shul@redhat.com (mailing list archive) |
|---|---|
| State | Changes Requested |
| Headers | show |
| Series | docs: rtla: replace dashes with spaces in titles | expand |
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>
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 -------------------------------------------
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(-)