diff mbox series

docs: locking: refer to the actual existing config names

Message ID 20230220165749.12850-1-lukas.bulwahn@gmail.com
State New
Headers
Series docs: locking: refer to the actual existing config names |

Commit Message

Lukas Bulwahn Feb. 20, 2023, 4:57 p.m. UTC 
  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(-)

Comments

Waiman Long Feb. 20, 2023, 5:18 p.m. UTC | #1 
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>
Jonathan Corbet Feb. 23, 2023, 7:27 p.m. UTC | #2 
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
diff mbox series

Patch

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.