Re: [PATCH 31/35] Documentation: trace: correct spelling

Mukesh Ojha
2023-01-27T07:05:45Z

On 1/27/2023 12:10 PM, Randy Dunlap wrote:
> Correct spelling problems for Documentation/trace/ as reported
> by codespell.
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Steven Rostedt <rostedt@goodmis.org>
> Cc: Masami Hiramatsu <mhiramat@kernel.org>
> Cc: Daniel Bristot de Oliveira <bristot@kernel.org>
> Cc: linux-trace-kernel@vger.kernel.org
> Cc: Mathieu Poirier <mathieu.poirier@linaro.org>
> Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
> Cc: coresight@lists.linaro.org
> Cc: linux-arm-kernel@lists.infradead.org
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> ---
> Documentation/trace/coresight/coresight-etm4x-reference.rst | 2 +-
> Documentation/trace/events.rst | 6 +++---
> Documentation/trace/fprobe.rst | 2 +-
> Documentation/trace/ftrace-uses.rst | 2 +-
> Documentation/trace/hwlat_detector.rst | 2 +-
> Documentation/trace/rv/runtime-verification.rst | 2 +-
> Documentation/trace/uprobetracer.rst | 2 +-
> 7 files changed, 9 insertions(+), 9 deletions(-)
>
> diff -- a/Documentation/trace/coresight/coresight-etm4x-reference.rst b/Documentation/trace/coresight/coresight-etm4x-reference.rst
> --- a/Documentation/trace/coresight/coresight-etm4x-reference.rst
> +++ b/Documentation/trace/coresight/coresight-etm4x-reference.rst
> @@ -675,7 +675,7 @@ Bit assignments shown below:-
> reconstructed using only conditional branches.
>
> There is currently no support in Perf for supplying modified binaries to the decoder, so this
> - feature is only inteded to be used for debugging purposes or with a 3rd party tool.
> + feature is only intended to be used for debugging purposes or with a 3rd party tool.
>
> Choosing this option will result in a significant increase in the amount of trace generated -
> possible danger of overflows, or fewer instructions covered. Note, that this option also
> diff -- a/Documentation/trace/events.rst b/Documentation/trace/events.rst
> --- a/Documentation/trace/events.rst
> +++ b/Documentation/trace/events.rst
> @@ -903,7 +903,7 @@ functions can be used.
>
> To create a kprobe event, an empty or partially empty kprobe event
> should first be created using kprobe_event_gen_cmd_start(). The name
> -of the event and the probe location should be specfied along with one
> +of the event and the probe location should be specified along with one
> or args each representing a probe field should be supplied to this
> function. Before calling kprobe_event_gen_cmd_start(), the user
> should create and initialize a dynevent_cmd object using
> @@ -983,7 +983,7 @@ The basic idea is simple and amounts to
> layer that can be used to generate trace event commands. The
> generated command strings can then be passed to the command-parsing
> and event creation code that already exists in the trace event
> -subystem for creating the corresponding trace events.
> +subsystem for creating the corresponding trace events.
>
> In a nutshell, the way it works is that the higher-level interface
> code creates a struct dynevent_cmd object, then uses a couple
> @@ -1056,7 +1056,7 @@ to add an operator between the pair (her
> appended onto the end of the arg pair (here ';').
>
> There's also a dynevent_str_add() function that can be used to simply
> -add a string as-is, with no spaces, delimeters, or arg check.
> +add a string as-is, with no spaces, delimiters, or arg check.
>
> Any number of dynevent_*_add() calls can be made to build up the string
> (until its length surpasses cmd->maxlen). When all the arguments have
> diff -- a/Documentation/trace/fprobe.rst b/Documentation/trace/fprobe.rst
> --- a/Documentation/trace/fprobe.rst
> +++ b/Documentation/trace/fprobe.rst
> @@ -111,7 +111,7 @@ saved at function entry and passed to ex
> the instruction pointer of @regs may be different from the @entry_ip
> in the entry_handler. If you need traced instruction pointer, you need
> to use @entry_ip. On the other hand, in the exit_handler, the instruction
> - pointer of @regs is set to the currect return address.
> + pointer of @regs is set to the correct return address.
>
> Share the callbacks with kprobes
> ================================
> diff -- a/Documentation/trace/ftrace-uses.rst b/Documentation/trace/ftrace-uses.rst
> --- a/Documentation/trace/ftrace-uses.rst
> +++ b/Documentation/trace/ftrace-uses.rst
> @@ -193,7 +193,7 @@ FTRACE_OPS_FL_RECURSION
> Not, if this flag is set, then the callback will always be called
> with preemption disabled. If it is not set, then it is possible
> (but not guaranteed) that the callback will be called in
> - preemptable context.
> + preemptible context.
>
> FTRACE_OPS_FL_IPMODIFY
> Requires FTRACE_OPS_FL_SAVE_REGS set. If the callback is to "hijack"
> diff -- a/Documentation/trace/hwlat_detector.rst b/Documentation/trace/hwlat_detector.rst
> --- a/Documentation/trace/hwlat_detector.rst
> +++ b/Documentation/trace/hwlat_detector.rst
> @@ -14,7 +14,7 @@ originally written for use by the "RT" p
> kernel is highly latency sensitive.
>
> SMIs are not serviced by the Linux kernel, which means that it does not
> -even know that they are occuring. SMIs are instead set up by BIOS code
> +even know that they are occurring. SMIs are instead set up by BIOS code
> and are serviced by BIOS code, usually for "critical" events such as
> management of thermal sensors and fans. Sometimes though, SMIs are used for
> other tasks and those tasks can spend an inordinate amount of time in the
> diff -- a/Documentation/trace/rv/runtime-verification.rst b/Documentation/trace/rv/runtime-verification.rst
> --- a/Documentation/trace/rv/runtime-verification.rst
> +++ b/Documentation/trace/rv/runtime-verification.rst
> @@ -31,7 +31,7 @@ In Linux terms, the runtime verification
> *RV monitor* abstraction. A *RV monitor* includes a reference model of the
> system, a set of instances of the monitor (per-cpu monitor, per-task monitor,
> and so on), and the helper functions that glue the monitor to the system via
> -trace, as depicted bellow::
> +trace, as depicted below::
>
> Linux +---- RV Monitor ----------------------------------+ Formal
> Realm | | Realm
> diff -- a/Documentation/trace/uprobetracer.rst b/Documentation/trace/uprobetracer.rst
> --- a/Documentation/trace/uprobetracer.rst
> +++ b/Documentation/trace/uprobetracer.rst
> @@ -55,7 +55,7 @@ Synopsis of uprobe_tracer
>
> (\*1) only for return probe.
> (\*2) this is useful for fetching a field of data structures.
> - (\*3) Unlike kprobe event, "u" prefix will just be ignored, becuse uprobe
> + (\*3) Unlike kprobe event, "u" prefix will just be ignored, because uprobe
> events can access only user-space memory.
>
> Types

Reviewed-by: Mukesh Ojha <quic_mojha@quicinc.com>

-Mukesh
>
> _______________________________________________
> linux-arm-kernel mailing list
> linux-arm-kernel@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-arm-kernel