2023-04-11 14:16:57

by Lin Yu Chen

[permalink] [raw]
Subject: [PATCH] docs: Fix typo in Documentation/RCU/checklist.rst

This commit corrects the spelling of "not" to "note" to accurately
convey the intended meaning.

Signed-off-by: Lin Yu Chen <[email protected]>
---
Documentation/RCU/checklist.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/RCU/checklist.rst b/Documentation/RCU/checklist.rst
index cc361fb01ed4..bd3c58c44bef 100644
--- a/Documentation/RCU/checklist.rst
+++ b/Documentation/RCU/checklist.rst
@@ -70,7 +70,7 @@ over a rather long period of time, but improvements are always welcome!
can serve as rcu_read_lock_sched(), but is less readable and
prevents lockdep from detecting locking issues.

- Please not that you *cannot* rely on code known to be built
+ Please note that you *cannot* rely on code known to be built
only in non-preemptible kernels. Such code can and will break,
especially in kernels built with CONFIG_PREEMPT_COUNT=y.

--
2.25.1


2023-04-12 04:54:51

by Paul E. McKenney

[permalink] [raw]
Subject: Re: [PATCH] docs: Fix typo in Documentation/RCU/checklist.rst

On Tue, Apr 11, 2023 at 07:13:41AM -0700, Lin Yu Chen wrote:
> This commit corrects the spelling of "not" to "note" to accurately
> convey the intended meaning.
>
> Signed-off-by: Lin Yu Chen <[email protected]>

Good eyes, thank you!

However, Qiuxu Zhuo beat you to this one, please see this commit
in the -rcu tree:

e5ad8b68f8d4 ("Documentation/RCU: s/not/note/ in checklist.rst")

Thanx, Paul

> ---
> Documentation/RCU/checklist.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/RCU/checklist.rst b/Documentation/RCU/checklist.rst
> index cc361fb01ed4..bd3c58c44bef 100644
> --- a/Documentation/RCU/checklist.rst
> +++ b/Documentation/RCU/checklist.rst
> @@ -70,7 +70,7 @@ over a rather long period of time, but improvements are always welcome!
> can serve as rcu_read_lock_sched(), but is less readable and
> prevents lockdep from detecting locking issues.
>
> - Please not that you *cannot* rely on code known to be built
> + Please note that you *cannot* rely on code known to be built
> only in non-preemptible kernels. Such code can and will break,
> especially in kernels built with CONFIG_PREEMPT_COUNT=y.
>
> --
> 2.25.1
>