[PATCH] docs: kmemleak: adjust to config renaming

Lukas Bulwahn posted 1 patch 2 years, 8 months ago
Documentation/dev-tools/kmemleak.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] docs: kmemleak: adjust to config renaming
Posted by Lukas Bulwahn 2 years, 8 months ago
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
 enabled. Load the module and perform a scan with::
 
-- 
2.17.1
Re: [PATCH] docs: kmemleak: adjust to config renaming
Posted by Jonathan Corbet 2 years, 8 months ago
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
Re: [PATCH] docs: kmemleak: adjust to config renaming
Posted by Catalin Marinas 2 years, 8 months ago
On Fri, Apr 14, 2023 at 08:12:41AM +0200, Lukas Bulwahn wrote:
> 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>

Acked-by: Catalin Marinas <catalin.marinas@arm.com>