docs: locking: refer to the actual existing config names

[PATCH] docs: locking: refer to the actual existing config names

Posted by Lukas Bulwahn 2 years, 6 months ago

The config is actually called CONFIG_RT_MUTEXES, not CONFIG_RT_MUTEX.

The config CONFIG_LOCK_TORTURE_TEST should be connected by underscore, for
the sake of consistent referencing to configs in the kernel documentation.

Address those issues.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
 Documentation/locking/locktorture.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/locking/locktorture.rst b/Documentation/locking/locktorture.rst
index dfaf9fc883f4..7f56fc0d7c31 100644
--- a/Documentation/locking/locktorture.rst
+++ b/Documentation/locking/locktorture.rst
@@ -5,7 +5,7 @@ Kernel Lock Torture Test Operation
 CONFIG_LOCK_TORTURE_TEST
 ========================
 
-The CONFIG LOCK_TORTURE_TEST config option provides a kernel module
+The CONFIG_LOCK_TORTURE_TEST config option provides a kernel module
 that runs torture tests on core kernel locking primitives. The kernel
 module, 'locktorture', may be built after the fact on the running
 kernel to be tested, if desired. The tests periodically output status
@@ -67,7 +67,7 @@ torture_type
 
 		     - "rtmutex_lock":
 				rtmutex_lock() and rtmutex_unlock() pairs.
-				Kernel must have CONFIG_RT_MUTEX=y.
+				Kernel must have CONFIG_RT_MUTEXES=y.
 
 		     - "rwsem_lock":
 				read/write down() and up() semaphore pairs.
-- 
2.17.1

Re: [PATCH] docs: locking: refer to the actual existing config names

Posted by Jonathan Corbet 2 years, 6 months ago

Lukas Bulwahn <lukas.bulwahn@gmail.com> writes:

> The config is actually called CONFIG_RT_MUTEXES, not CONFIG_RT_MUTEX.
>
> The config CONFIG_LOCK_TORTURE_TEST should be connected by underscore, for
> the sake of consistent referencing to configs in the kernel documentation.
>
> Address those issues.
>
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> ---
>  Documentation/locking/locktorture.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/locking/locktorture.rst b/Documentation/locking/locktorture.rst
> index dfaf9fc883f4..7f56fc0d7c31 100644
> --- a/Documentation/locking/locktorture.rst
> +++ b/Documentation/locking/locktorture.rst
> @@ -5,7 +5,7 @@ Kernel Lock Torture Test Operation
>  CONFIG_LOCK_TORTURE_TEST
>  ========================
>  
> -The CONFIG LOCK_TORTURE_TEST config option provides a kernel module
> +The CONFIG_LOCK_TORTURE_TEST config option provides a kernel module
>  that runs torture tests on core kernel locking primitives. The kernel
>  module, 'locktorture', may be built after the fact on the running
>  kernel to be tested, if desired. The tests periodically output status
> @@ -67,7 +67,7 @@ torture_type
>  
>  		     - "rtmutex_lock":
>  				rtmutex_lock() and rtmutex_unlock() pairs.
> -				Kernel must have CONFIG_RT_MUTEX=y.
> +				Kernel must have CONFIG_RT_MUTEXES=y.
>  

Applied, thanks.

jon

Re: [PATCH] docs: locking: refer to the actual existing config names

Posted by Waiman Long 2 years, 6 months ago

On 2/20/23 11:57, Lukas Bulwahn wrote:
> The config is actually called CONFIG_RT_MUTEXES, not CONFIG_RT_MUTEX.
>
> The config CONFIG_LOCK_TORTURE_TEST should be connected by underscore, for
> the sake of consistent referencing to configs in the kernel documentation.
>
> Address those issues.
>
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> ---
>   Documentation/locking/locktorture.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/locking/locktorture.rst b/Documentation/locking/locktorture.rst
> index dfaf9fc883f4..7f56fc0d7c31 100644
> --- a/Documentation/locking/locktorture.rst
> +++ b/Documentation/locking/locktorture.rst
> @@ -5,7 +5,7 @@ Kernel Lock Torture Test Operation
>   CONFIG_LOCK_TORTURE_TEST
>   ========================
>   
> -The CONFIG LOCK_TORTURE_TEST config option provides a kernel module
> +The CONFIG_LOCK_TORTURE_TEST config option provides a kernel module
>   that runs torture tests on core kernel locking primitives. The kernel
>   module, 'locktorture', may be built after the fact on the running
>   kernel to be tested, if desired. The tests periodically output status
> @@ -67,7 +67,7 @@ torture_type
>   
>   		     - "rtmutex_lock":
>   				rtmutex_lock() and rtmutex_unlock() pairs.
> -				Kernel must have CONFIG_RT_MUTEX=y.
> +				Kernel must have CONFIG_RT_MUTEXES=y.
>   
>   		     - "rwsem_lock":
>   				read/write down() and up() semaphore pairs.
Acked-by: Waiman Long <longman@redhat.com>