From:   Jonathan Corbet <corbet@lwn.net>
To:     Lukas Bulwahn <lukas.bulwahn@gmail.com>,
        Peter Zijlstra <peterz@infradead.org>,
        Ingo Molnar <mingo@redhat.com>, Will Deacon <will@kernel.org>,
        Waiman Long <longman@redhat.com>,
        Boqun Feng <boqun.feng@gmail.com>, linux-doc@vger.kernel.org
Cc:     kernel-janitors@vger.kernel.org, linux-kernel@vger.kernel.org,
        Lukas Bulwahn <lukas.bulwahn@gmail.com>
Subject: Re: [PATCH] docs: locking: refer to the actual existing config names
In-Reply-To: <20230220165749.12850-1-lukas.bulwahn@gmail.com>
References: <20230220165749.12850-1-lukas.bulwahn@gmail.com>
Date:   Thu, 23 Feb 2023 12:27:02 -0700
Message-ID: <877cw85gjd.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: bulk

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