[PATCH] Documentation: Fix duplicate statement about raw_spinlock_t type

[PATCH] Documentation: Fix duplicate statement about raw_spinlock_t type

[Guilherme G. Piccoli]

Unless it was duplicate on purpose, to emphasize that a raw_spinlock_t
is always a spinning lock regardless of PREEMPT_RT or kernel config,
it's a bit odd that this text is duplicate. So, this patch just clean
it up, keeping the consistency with the other sections of the text.

Cc: Thomas Gleixner <tglx@linutronix.de>
Fixes: 919e9e6395cf ("Documentation: Add lock ordering and nesting documentation")
Signed-off-by: Guilherme G. Piccoli <gpiccoli@igalia.com>
---
 Documentation/locking/locktypes.rst | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/Documentation/locking/locktypes.rst b/Documentation/locking/locktypes.rst
index bfa75ea1b66a..9933faad4771 100644
--- a/Documentation/locking/locktypes.rst
+++ b/Documentation/locking/locktypes.rst
@@ -211,9 +211,6 @@ raw_spinlock_t and spinlock_t
 raw_spinlock_t
 --------------
 
-raw_spinlock_t is a strict spinning lock implementation regardless of the
-kernel configuration including PREEMPT_RT enabled kernels.
-
 raw_spinlock_t is a strict spinning lock implementation in all kernels,
 including PREEMPT_RT kernels.  Use raw_spinlock_t only in real critical
 core code, low-level interrupt handling and places where disabling
-- 
2.35.1

Re: [PATCH] Documentation: Fix duplicate statement about raw_spinlock_t type

[Jonathan Corbet]

"Guilherme G. Piccoli" <gpiccoli@igalia.com> writes:

> Unless it was duplicate on purpose, to emphasize that a raw_spinlock_t
> is always a spinning lock regardless of PREEMPT_RT or kernel config,
> it's a bit odd that this text is duplicate. So, this patch just clean
> it up, keeping the consistency with the other sections of the text.
>
> Cc: Thomas Gleixner <tglx@linutronix.de>
> Fixes: 919e9e6395cf ("Documentation: Add lock ordering and nesting documentation")
> Signed-off-by: Guilherme G. Piccoli <gpiccoli@igalia.com>
> ---
>  Documentation/locking/locktypes.rst | 3 ---
>  1 file changed, 3 deletions(-)
>
> diff --git a/Documentation/locking/locktypes.rst b/Documentation/locking/locktypes.rst
> index bfa75ea1b66a..9933faad4771 100644
> --- a/Documentation/locking/locktypes.rst
> +++ b/Documentation/locking/locktypes.rst
> @@ -211,9 +211,6 @@ raw_spinlock_t and spinlock_t
>  raw_spinlock_t
>  --------------
>  
> -raw_spinlock_t is a strict spinning lock implementation regardless of the
> -kernel configuration including PREEMPT_RT enabled kernels.
> -
>  raw_spinlock_t is a strict spinning lock implementation in all kernels,
>  including PREEMPT_RT kernels.  Use raw_spinlock_t only in real critical
>  core code, low-level interrupt handling and places where disabling

I don't think that was intentional.  Applied, thanks.

For future reference, a far better changelog would have been something
like:

	Remove the duplicated sentence from locktypes.rst

Thanks,

jon

Re: [PATCH] Documentation: Fix duplicate statement about raw_spinlock_t type

[Guilherme G. Piccoli]

On 25/03/2022 16:32, Jonathan Corbet wrote:
> "Guilherme G. Piccoli" <gpiccoli@igalia.com> writes:
> [...]
> For future reference, a far better changelog would have been something
> like:
> 
> 	Remove the duplicated sentence from locktypes.rst
> 
> Thanks,
> 
> jon

Thanks Jon, and feel free to change that when applying in case you
prefer, it's a good choice of words, better than mine.
Cheers,


Guilherme