2023-04-14 06:17:03

by Lukas Bulwahn

Subject: [PATCH] docs: kmemleak: adjust to config renaming

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 <[email protected]>
---
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

2023-04-14 10:20:43

by Catalin Marinas

Subject: Re: [PATCH] docs: kmemleak: adjust to config renaming

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 <[email protected]>

Acked-by: Catalin Marinas <[email protected]>

2023-04-20 16:25:35

by Jonathan Corbet

Subject: Re: [PATCH] docs: kmemleak: adjust to config renaming

Lukas Bulwahn <[email protected]> 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 <[email protected]>
> ---
> 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