* [PATCH] docs: kmsan: fix formatting of "Example report"
@ 2022-11-07 14:22 Alexander Potapenko
2022-11-09 20:33 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: Alexander Potapenko @ 2022-11-07 14:22 UTC (permalink / raw)
To: glider; +Cc: linux-kernel, linux-doc, akpm, corbet, kasan-dev, Bagas Sanjaya
Add a blank line to make the sentence before the list render as a
separate paragraph, not a definition.
Fixes: 93858ae70cf4 ("kmsan: add ReST documentation")
Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Alexander Potapenko <glider@google.com>
---
Documentation/dev-tools/kmsan.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/dev-tools/kmsan.rst b/Documentation/dev-tools/kmsan.rst
index 2a53a801198cb..55fa82212eb25 100644
--- a/Documentation/dev-tools/kmsan.rst
+++ b/Documentation/dev-tools/kmsan.rst
@@ -67,6 +67,7 @@ uninitialized in the local variable, as well as the stack where the value was
copied to another memory location before use.
A use of uninitialized value ``v`` is reported by KMSAN in the following cases:
+
- in a condition, e.g. ``if (v) { ... }``;
- in an indexing or pointer dereferencing, e.g. ``array[v]`` or ``*v``;
- when it is copied to userspace or hardware, e.g. ``copy_to_user(..., &v, ...)``;
--
2.38.1.431.g37b22c650d-goog
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] docs: kmsan: fix formatting of "Example report"
2022-11-07 14:22 [PATCH] docs: kmsan: fix formatting of "Example report" Alexander Potapenko
@ 2022-11-09 20:33 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2022-11-09 20:33 UTC (permalink / raw)
To: Alexander Potapenko, glider
Cc: linux-kernel, linux-doc, akpm, kasan-dev, Bagas Sanjaya
Alexander Potapenko <glider@google.com> writes:
> Add a blank line to make the sentence before the list render as a
> separate paragraph, not a definition.
>
> Fixes: 93858ae70cf4 ("kmsan: add ReST documentation")
> Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com>
> Signed-off-by: Alexander Potapenko <glider@google.com>
> ---
> Documentation/dev-tools/kmsan.rst | 1 +
> 1 file changed, 1 insertion(+)
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2022-11-09 20:33 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-11-07 14:22 [PATCH] docs: kmsan: fix formatting of "Example report" Alexander Potapenko
2022-11-09 20:33 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox