2022-11-07 16:05:51

by Alexander Potapenko

Subject: [PATCH] docs: kmsan: fix formatting of "Example report"

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 <[email protected]>
Signed-off-by: Alexander Potapenko <[email protected]>
---
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

2022-11-09 20:55:32

by Jonathan Corbet

Subject: Re: [PATCH] docs: kmsan: fix formatting of "Example report"

Alexander Potapenko <[email protected]> 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 <[email protected]>
> Signed-off-by: Alexander Potapenko <[email protected]>
> ---
> Documentation/dev-tools/kmsan.rst | 1 +
> 1 file changed, 1 insertion(+)

Applied, thanks.

jon