diff mbox series

docs: kmsan: fix formatting of "Example report"

Message ID 20221107142255.4038811-1-glider@google.com
State New
Headers
Series docs: kmsan: fix formatting of "Example report" |

Commit Message

Alexander Potapenko Nov. 7, 2022, 2:22 p.m. UTC 
  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(+)

Comments

Jonathan Corbet Nov. 9, 2022, 8:33 p.m. UTC | #1 
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
diff mbox series

Patch

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, ...)``;