2023-12-23 18:59:01

by Matthew Cassell

Subject: [PATCH] Documentation/trace: Fixed typos in the ftrace FLAGS section

Fixed typos in the FTRACE_OPS_FL_RECURSION flag description.

Signed-off-by: Matthew Cassell <[email protected]>
---
Documentation/trace/ftrace-uses.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/trace/ftrace-uses.rst b/Documentation/trace/ftrace-uses.rst
index f7d98ae5b885..e198854ace79 100644
--- a/Documentation/trace/ftrace-uses.rst
+++ b/Documentation/trace/ftrace-uses.rst
@@ -182,7 +182,7 @@ FTRACE_OPS_FL_SAVE_REGS_IF_SUPPORTED

FTRACE_OPS_FL_RECURSION
By default, it is expected that the callback can handle recursion.
- But if the callback is not that worried about overehead, then
+ But if the callback is not that worried about overhead, then
setting this bit will add the recursion protection around the
callback by calling a helper function that will do the recursion
protection and only call the callback if it did not recurse.
@@ -190,7 +190,7 @@ FTRACE_OPS_FL_RECURSION
Note, if this flag is not set, and recursion does occur, it could
cause the system to crash, and possibly reboot via a triple fault.

- Not, if this flag is set, then the callback will always be called
+ Note, 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.
--
2.34.1

2023-12-23 19:30:32

by Randy Dunlap

Subject: Re: [PATCH] Documentation/trace: Fixed typos in the ftrace FLAGS section

On 12/23/23 10:58, Matthew Cassell wrote:
> Fixed typos in the FTRACE_OPS_FL_RECURSION flag description.
>
> Signed-off-by: Matthew Cassell <[email protected]>

Reviewed-by: Randy Dunlap <[email protected]>

Thanks.

> ---
> Documentation/trace/ftrace-uses.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/trace/ftrace-uses.rst b/Documentation/trace/ftrace-uses.rst
> index f7d98ae5b885..e198854ace79 100644
> --- a/Documentation/trace/ftrace-uses.rst
> +++ b/Documentation/trace/ftrace-uses.rst
> @@ -182,7 +182,7 @@ FTRACE_OPS_FL_SAVE_REGS_IF_SUPPORTED
>
> FTRACE_OPS_FL_RECURSION
> By default, it is expected that the callback can handle recursion.
> - But if the callback is not that worried about overehead, then
> + But if the callback is not that worried about overhead, then
> setting this bit will add the recursion protection around the
> callback by calling a helper function that will do the recursion
> protection and only call the callback if it did not recurse.
> @@ -190,7 +190,7 @@ FTRACE_OPS_FL_RECURSION
> Note, if this flag is not set, and recursion does occur, it could
> cause the system to crash, and possibly reboot via a triple fault.
>
> - Not, if this flag is set, then the callback will always be called
> + Note, 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.

--
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html

2024-01-03 21:16:28

by Jonathan Corbet

Subject: Re: [PATCH] Documentation/trace: Fixed typos in the ftrace FLAGS section

Matthew Cassell <[email protected]> writes:

> Fixed typos in the FTRACE_OPS_FL_RECURSION flag description.
>
> Signed-off-by: Matthew Cassell <[email protected]>
> ---
> Documentation/trace/ftrace-uses.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)

Applied, thanks.

jon