2024-05-01 23:37:23

by Saurav Shah

[permalink] [raw]
Subject: [PATCH] Documentation: tracing: Fix spelling mistakes

Fix spelling mistakes in the documentation.

Signed-off-by: Saurav Shah <[email protected]>
---
Documentation/trace/fprobetrace.rst | 4 ++--
Documentation/trace/ftrace.rst | 2 +-
Documentation/trace/kprobetrace.rst | 2 +-
3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/trace/fprobetrace.rst b/Documentation/trace/fprobetrace.rst
index 0f187e3796e4..b4c2ca3d02c1 100644
--- a/Documentation/trace/fprobetrace.rst
+++ b/Documentation/trace/fprobetrace.rst
@@ -74,7 +74,7 @@ Function arguments at exit
--------------------------
Function arguments can be accessed at exit probe using $arg<N> fetcharg. This
is useful to record the function parameter and return value at once, and
-trace the difference of structure fields (for debuging a function whether it
+trace the difference of structure fields (for debugging a function whether it
correctly updates the given data structure or not)
See the :ref:`sample<fprobetrace_exit_args_sample>` below for how it works.

@@ -248,4 +248,4 @@ mode. You can trace that changes with return probe.
cat-143 [007] ...1. 1945.720616: vfs_open__entry: (vfs_open+0x4/0x40) mode=0x1 inode=0x0
cat-143 [007] ...1. 1945.728263: vfs_open__exit: (do_open+0x274/0x3d0 <- vfs_open) mode=0xa800d inode=0xffff888004ada8d8

-You can see the `file::f_mode` and `file::f_inode` are upated in `vfs_open()`.
+You can see the `file::f_mode` and `file::f_inode` are updated in `vfs_open()`.
diff --git a/Documentation/trace/ftrace.rst b/Documentation/trace/ftrace.rst
index 7e7b8ec17934..5aba74872ba7 100644
--- a/Documentation/trace/ftrace.rst
+++ b/Documentation/trace/ftrace.rst
@@ -1968,7 +1968,7 @@ wakeup
One common case that people are interested in tracing is the
time it takes for a task that is woken to actually wake up.
Now for non Real-Time tasks, this can be arbitrary. But tracing
-it none the less can be interesting.
+it nonetheless can be interesting.

Without function tracing::

diff --git a/Documentation/trace/kprobetrace.rst b/Documentation/trace/kprobetrace.rst
index a49662ccd53c..69cb7776ae99 100644
--- a/Documentation/trace/kprobetrace.rst
+++ b/Documentation/trace/kprobetrace.rst
@@ -74,7 +74,7 @@ Function arguments at kretprobe
-------------------------------
Function arguments can be accessed at kretprobe using $arg<N> fetcharg. This
is useful to record the function parameter and return value at once, and
-trace the difference of structure fields (for debuging a function whether it
+trace the difference of structure fields (for debugging a function whether it
correctly updates the given data structure or not).
See the :ref:`sample<fprobetrace_exit_args_sample>` in fprobe event for how
it works.
--
2.34.1



2024-05-02 00:39:09

by Bagas Sanjaya

[permalink] [raw]
Subject: Re: [PATCH] Documentation: tracing: Fix spelling mistakes

On Thu, May 02, 2024 at 05:06:59AM +0530, Saurav Shah wrote:
> diff --git a/Documentation/trace/fprobetrace.rst b/Documentation/trace/fprobetrace.rst
> index 0f187e3796e4..b4c2ca3d02c1 100644
> --- a/Documentation/trace/fprobetrace.rst
> +++ b/Documentation/trace/fprobetrace.rst
> @@ -74,7 +74,7 @@ Function arguments at exit
> --------------------------
> Function arguments can be accessed at exit probe using $arg<N> fetcharg. This
> is useful to record the function parameter and return value at once, and
> -trace the difference of structure fields (for debuging a function whether it
> +trace the difference of structure fields (for debugging a function whether it
> correctly updates the given data structure or not)
> See the :ref:`sample<fprobetrace_exit_args_sample>` below for how it works.
>
> @@ -248,4 +248,4 @@ mode. You can trace that changes with return probe.
> cat-143 [007] ...1. 1945.720616: vfs_open__entry: (vfs_open+0x4/0x40) mode=0x1 inode=0x0
> cat-143 [007] ...1. 1945.728263: vfs_open__exit: (do_open+0x274/0x3d0 <- vfs_open) mode=0xa800d inode=0xffff888004ada8d8
>
> -You can see the `file::f_mode` and `file::f_inode` are upated in `vfs_open()`.
> +You can see the `file::f_mode` and `file::f_inode` are updated in `vfs_open()`.
> diff --git a/Documentation/trace/ftrace.rst b/Documentation/trace/ftrace.rst
> index 7e7b8ec17934..5aba74872ba7 100644
> --- a/Documentation/trace/ftrace.rst
> +++ b/Documentation/trace/ftrace.rst
> @@ -1968,7 +1968,7 @@ wakeup
> One common case that people are interested in tracing is the
> time it takes for a task that is woken to actually wake up.
> Now for non Real-Time tasks, this can be arbitrary. But tracing
> -it none the less can be interesting.
> +it nonetheless can be interesting.
>
> Without function tracing::
>
> diff --git a/Documentation/trace/kprobetrace.rst b/Documentation/trace/kprobetrace.rst
> index a49662ccd53c..69cb7776ae99 100644
> --- a/Documentation/trace/kprobetrace.rst
> +++ b/Documentation/trace/kprobetrace.rst
> @@ -74,7 +74,7 @@ Function arguments at kretprobe
> -------------------------------
> Function arguments can be accessed at kretprobe using $arg<N> fetcharg. This
> is useful to record the function parameter and return value at once, and
> -trace the difference of structure fields (for debuging a function whether it
> +trace the difference of structure fields (for debugging a function whether it
> correctly updates the given data structure or not).
> See the :ref:`sample<fprobetrace_exit_args_sample>` in fprobe event for how
> it works.

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <[email protected]>

--
An old man doll... just what I always wanted! - Clara


Attachments:
(No filename) (2.73 kB)
signature.asc (235.00 B)
Download all attachments

2024-05-07 14:00:59

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH] Documentation: tracing: Fix spelling mistakes

Saurav Shah <[email protected]> writes:

> Fix spelling mistakes in the documentation.
>
> Signed-off-by: Saurav Shah <[email protected]>
> ---
> Documentation/trace/fprobetrace.rst | 4 ++--
> Documentation/trace/ftrace.rst | 2 +-
> Documentation/trace/kprobetrace.rst | 2 +-
> 3 files changed, 4 insertions(+), 4 deletions(-)

Applied, thanks.

jon