[PATCH] tracing: Fix inconsistent style of mini-HOWTO

[PATCH] tracing: Fix inconsistent style of mini-HOWTO

[Oscar Shiang]

Each description should start with a hyphen and a space. Insert
spaces to fix it.

Signed-off-by: Oscar Shiang <oscar0225@livemail.tw>
---
 kernel/trace/trace.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/kernel/trace/trace.c b/kernel/trace/trace.c
index 7c2578efd..a0d10e949 100644
--- a/kernel/trace/trace.c
+++ b/kernel/trace/trace.c
@@ -5458,7 +5458,7 @@ static const char readme_msg[] =
        "  error_log\t- error log for failed commands (that support it)\n"
        "  buffer_size_kb\t- view and modify size of per cpu buffer\n"
        "  buffer_total_size_kb  - view total size of all cpu buffers\n\n"
-       "  trace_clock\t\t-change the clock used to order events\n"
+       "  trace_clock\t\t- change the clock used to order events\n"
        "       local:   Per cpu clock but may not be synced across CPUs\n"
        "      global:   Synced across CPUs but slows tracing down.\n"
        "     counter:   Not a clock, but just an increment\n"
@@ -5467,7 +5467,7 @@ static const char readme_msg[] =
 #ifdef CONFIG_X86_64
        "     x86-tsc:   TSC cycle counter\n"
 #endif
-       "\n  timestamp_mode\t-view the mode used to timestamp events\n"
+       "\n  timestamp_mode\t- view the mode used to timestamp events\n"
        "       delta:   Delta difference against a buffer-wide timestamp\n"
        "    absolute:   Absolute (standalone) timestamp\n"
        "\n  trace_marker\t\t- Writes into this file writes into the kernel buffer\n"
--
2.25.1

Re: [PATCH] tracing: Fix inconsistent style of mini-HOWTO

[Steven Rostedt]

On Thu, 17 Feb 2022 00:50:06 +0800
Oscar Shiang <oscar0225@livemail.tw> wrote:

> Each description should start with a hyphen and a space. Insert
> spaces to fix it.
> 

I can take this, but there's a possibility that it will be reverted. The
output of the README in the tracefs file is an API. That is, the content of
the text is used to determine what version and what options of tracing is
enabled.

If something is scanning for the trace_clock or timestamp_mode lines, doing
an exact match of the entire context, this could break that code. If
there's any report of that happening (and we should look for anything that
might do that), then this will need to be reverted.

-- Steve


> Signed-off-by: Oscar Shiang <oscar0225@livemail.tw>
> ---
>  kernel/trace/trace.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/kernel/trace/trace.c b/kernel/trace/trace.c
> index 7c2578efd..a0d10e949 100644
> --- a/kernel/trace/trace.c
> +++ b/kernel/trace/trace.c
> @@ -5458,7 +5458,7 @@ static const char readme_msg[] =
>         "  error_log\t- error log for failed commands (that support it)\n"
>         "  buffer_size_kb\t- view and modify size of per cpu buffer\n"
>         "  buffer_total_size_kb  - view total size of all cpu buffers\n\n"
> -       "  trace_clock\t\t-change the clock used to order events\n"
> +       "  trace_clock\t\t- change the clock used to order events\n"
>         "       local:   Per cpu clock but may not be synced across CPUs\n"
>         "      global:   Synced across CPUs but slows tracing down.\n"
>         "     counter:   Not a clock, but just an increment\n"
> @@ -5467,7 +5467,7 @@ static const char readme_msg[] =
>  #ifdef CONFIG_X86_64
>         "     x86-tsc:   TSC cycle counter\n"
>  #endif
> -       "\n  timestamp_mode\t-view the mode used to timestamp events\n"
> +       "\n  timestamp_mode\t- view the mode used to timestamp events\n"
>         "       delta:   Delta difference against a buffer-wide timestamp\n"
>         "    absolute:   Absolute (standalone) timestamp\n"
>         "\n  trace_marker\t\t- Writes into this file writes into the kernel buffer\n"
> --
> 2.25.1