Skip to contentSkip to conversation

docs: kmemleak: adjust to config renaming

PATCH Applied Lukas Bulwahn 3 participants 3 messages Apr 14, 2023 – Apr 20, 2023

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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.

---
 Documentation/dev-tools/kmemleak.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/dev-tools/kmemleak.rst +1 -1
index 5483fd39ef29..2cb00b53339f 100644
@@ -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::
 
Signature · 1 line
2.17.1
maintainer Applied
#2 lore raw
In reply to Lukas Bulwahn
Quoted 16 lines · Lukas Bulwahn

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.

---
 Documentation/dev-tools/kmemleak.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/dev-tools/kmemleak.rst +0 -0
index 5483fd39ef29..2cb00b53339f 100644

Documentation/dev-tools/kmemleak.rst Testing with kmemleak-test · line 231

Quoted 6 lines
Documentation/dev-tools/kmemleak.rst +1 -1
@@ -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