From: Rustam Kovhaev <rkovhaev@gmail.com>
To: catalin.marinas@arm.com, corbet@lwn.net
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Rustam Kovhaev <rkovhaev@gmail.com>
Subject: [PATCH] docs: kmemleak: add more details about kmemleak usage
Date: Thu, 17 Jun 2021 14:04:20 -0700 [thread overview]
Message-ID: <20210617210420.392412-1-rkovhaev@gmail.com> (raw)
a user may need to initiate a manual scan twice via debugfs before
kmemleak reports an orphan object.
this is mentioned in Testing section, let's mention this again in the
Usage section for better visibility.
Link: https://lore.kernel.org/lkml/YMpEtyUP0vuWo9HV@nuc10/
Signed-off-by: Rustam Kovhaev <rkovhaev@gmail.com>
---
Documentation/dev-tools/kmemleak.rst | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/Documentation/dev-tools/kmemleak.rst b/Documentation/dev-tools/kmemleak.rst
index 1c935f41cd3a..512f78e6e4fb 100644
--- a/Documentation/dev-tools/kmemleak.rst
+++ b/Documentation/dev-tools/kmemleak.rst
@@ -38,6 +38,9 @@ Note that the orphan objects are listed in the order they were allocated
and one object at the beginning of the list may cause other subsequent
objects to be reported as orphan.
+If you are triggering a manual memory scan, you might need to do it at least
+twice before kmemleak reports an orphan object.
+
Memory scanning parameters can be modified at run-time by writing to the
``/sys/kernel/debug/kmemleak`` file. The following parameters are supported:
@@ -235,7 +238,7 @@ enabled. Load the module and perform a scan with::
# modprobe kmemleak-test
# echo scan > /sys/kernel/debug/kmemleak
-Note that the you may not get results instantly or on the first scanning. When
+Note that you may not get the results instantly or on the first scanning. When
kmemleak gets results, it'll log ``kmemleak: <count of leaks> new suspected
memory leaks``. Then read the file to see then::
--
2.30.2
next reply other threads:[~2021-06-17 21:05 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-17 21:04 Rustam Kovhaev [this message]
2021-06-18 14:34 ` [PATCH] docs: kmemleak: add more details about kmemleak usage Catalin Marinas
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210617210420.392412-1-rkovhaev@gmail.com \
--to=rkovhaev@gmail.com \
--cc=catalin.marinas@arm.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox