Re: [PATCH] tracing: Fix various typos in comments

[Randy Dunlap]

Hi Ingo,

A few comments for you:

On 3/22/21 3:45 PM, Ingo Molnar wrote:
> 
> Fix ~59 single-word typos in the tracing code comments.
> 
> Signed-off-by: Ingo Molnar <mingo@xxxxxxxxxx>
> Cc: Steven Rostedt <rostedt@xxxxxxxxxxx>
> Cc: linux-kernel@xxxxxxxxxxxxxxx
> ---
>  arch/microblaze/include/asm/ftrace.h |  2 +-
>  arch/nds32/kernel/ftrace.c           |  2 +-
>  arch/powerpc/include/asm/ftrace.h    |  4 ++--
>  arch/sh/kernel/ftrace.c              |  2 +-
>  arch/sparc/include/asm/ftrace.h      |  2 +-
>  fs/tracefs/inode.c                   |  2 +-
>  include/linux/ftrace.h               |  4 ++--
>  include/linux/trace_events.h         |  2 +-
>  include/linux/tracepoint.h           |  2 +-
>  include/trace/events/io_uring.h      |  2 +-
>  include/trace/events/rcu.h           |  2 +-
>  include/trace/events/sched.h         |  2 +-
>  include/trace/events/timer.h         |  2 +-
>  kernel/trace/bpf_trace.c             |  4 ++--
>  kernel/trace/fgraph.c                |  4 ++--
>  kernel/trace/ftrace.c                |  8 ++++----
>  kernel/trace/ring_buffer.c           |  2 +-
>  kernel/trace/synth_event_gen_test.c  |  2 +-
>  kernel/trace/trace.c                 | 18 +++++++++---------
>  kernel/trace/trace.h                 |  4 ++--
>  kernel/trace/trace_event_perf.c      |  2 +-
>  kernel/trace/trace_events.c          |  4 ++--
>  kernel/trace/trace_events_filter.c   |  4 ++--
>  kernel/trace/trace_events_synth.c    |  2 +-
>  kernel/trace/trace_functions_graph.c |  2 +-
>  kernel/trace/trace_hwlat.c           |  4 ++--
>  kernel/trace/trace_kprobe.c          |  2 +-
>  kernel/trace/trace_probe.c           |  6 +++---
>  kernel/trace/trace_probe.h           |  2 +-
>  kernel/trace/trace_probe_tmpl.h      |  2 +-
>  kernel/trace/trace_selftest.c        |  4 ++--
>  kernel/trace/trace_seq.c             | 12 ++++++------
>  32 files changed, 59 insertions(+), 59 deletions(-)
> 

> diff --git a/kernel/trace/bpf_trace.c b/kernel/trace/bpf_trace.c
> index b0c45d923f0f..2214cba56e6f 100644
> --- a/kernel/trace/bpf_trace.c
> +++ b/kernel/trace/bpf_trace.c

> @@ -748,7 +748,7 @@ BPF_CALL_5(bpf_seq_printf, struct seq_file *, m, char *, fmt, u32, fmt_size,
>  		fmt_cnt++;
>  	}
>  
> -	/* Maximumly we can have MAX_SEQ_PRINTF_VARARGS parameter, just give
> +	/* Maximum we can have MAX_SEQ_PRINTF_VARARGS parameter, just give

That's awkward either way IMO. How about:

	/* The maximum we can have is MAX_SEQ_PRINTF_VARARGS parameters, so just give

>  	 * all of them to seq_printf().
>  	 */
>  	seq_printf(m, fmt, params[0], params[1], params[2], params[3],
> diff --git a/kernel/trace/fgraph.c b/kernel/trace/fgraph.c
> index 29a6ebeebc9e..dc0506314e2e 100644
> --- a/kernel/trace/fgraph.c
> +++ b/kernel/trace/fgraph.c
> @@ -117,7 +117,7 @@ int function_graph_enter(unsigned long ret, unsigned long func,
>  
>  	/*
>  	 * Skip graph tracing if the return location is served by direct trampoline,
> -	 * since call sequence and return addresses is unpredicatable anymore.
> +	 * since call sequence and return addresses is unpredictable anymore.

	                                            are

>  	 * Ex: BPF trampoline may call original function and may skip frame
>  	 * depending on type of BPF programs attached.
>  	 */

> diff --git a/kernel/trace/trace.c b/kernel/trace/trace.c
> index eccb4e1187cc..b7738d21d840 100644
> --- a/kernel/trace/trace.c
> +++ b/kernel/trace/trace.c
> @@ -3367,7 +3367,7 @@ int trace_array_vprintk(struct trace_array *tr,
>   * buffer (use trace_printk() for that), as writing into the top level
>   * buffer should only have events that can be individually disabled.
>   * trace_printk() is only used for debugging a kernel, and should not
> - * be ever encorporated in normal use.
> + * be ever incorporated in normal use.

preferably
    * ever be

>   *
>   * trace_array_printk() can be used, as it will not add noise to the
>   * top level tracing buffer.

and at first I skipped over these, but I'll go back and mention them anyway:

diff --git a/kernel/trace/trace.h b/kernel/trace/trace.h
index a6446c03cfbc..557ec9ce88c6 100644
--- a/kernel/trace/trace.h
+++ b/kernel/trace/trace.h
@@ -1343,7 +1343,7 @@ __event_trigger_test_discard(struct trace_event_file *file,
 
 /**
  * event_trigger_unlock_commit - handle triggers and finish event commit
- * @file: The file pointer assoctiated to the event
+ * @file: The file pointer associated to the event

                            associated with the event

  * @buffer: The ring buffer that the event is being written to
  * @event: The event meta data in the ring buffer
  * @entry: The event itself
@@ -1370,7 +1370,7 @@ event_trigger_unlock_commit(struct trace_event_file *file,
 
 /**
  * event_trigger_unlock_commit_regs - handle triggers and finish event commit
- * @file: The file pointer assoctiated to the event
+ * @file: The file pointer associated to the event

                            associated with the event

  * @buffer: The ring buffer that the event is being written to
  * @event: The event meta data in the ring buffer
  * @entry: The event itself


thanks.
-- 
~Randy