Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Jonathan Corbet <corbet@lwn.net>
To:     Lukas Bulwahn <lukas.bulwahn@gmail.com>,
        Catalin Marinas <catalin.marinas@arm.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: kmemleak: adjust to config renaming
In-Reply-To: <20230414061241.12754-1-lukas.bulwahn@gmail.com>
References: <20230414061241.12754-1-lukas.bulwahn@gmail.com>
Date:   Thu, 20 Apr 2023 10:08:17 -0600
Message-ID: <87bkjitu32.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: bulk

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

> Commit c87db8ca0902 ("kmemleak-test: fix kmemleak_test.c build logic")
> essentially renames the config DEBUG_KMEMLEAK_TEST to SAMPLE_KMEMLEAK, but
> misses to adjust the documentation.
>
> Adjust kmemleak documentation to this config renaming.
>
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> ---
>  Documentation/dev-tools/kmemleak.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/dev-tools/kmemleak.rst b/Documentation/dev-tools/kmemleak.rst
> index 5483fd39ef29..2cb00b53339f 100644
> --- a/Documentation/dev-tools/kmemleak.rst
> +++ b/Documentation/dev-tools/kmemleak.rst
> @@ -227,7 +227,7 @@ Testing with kmemleak-test
>  --------------------------
>  
>  To check if you have all set up to use kmemleak, you can use the kmemleak-test
> -module, a module that deliberately leaks memory. Set CONFIG_DEBUG_KMEMLEAK_TEST
> +module, a module that deliberately leaks memory. Set CONFIG_SAMPLE_KMEMLEAK
>  as module (it can't be used as built-in) and boot the kernel with kmemleak

Applied, thanks.

jon