2023-10-06 15:19:27

by andrey.konovalov

Subject: [PATCH 5/5] Documentation: *san: drop "the" from article titles

From: Andrey Konovalov <[email protected]>

Drop "the" from the titles of documentation articles for KASAN, KCSAN,
and KMSAN, as it is redundant.

Also add SPDX-License-Identifier for kasan.rst.

Signed-off-by: Andrey Konovalov <[email protected]>
---
Documentation/dev-tools/kasan.rst | 7 +++++--
Documentation/dev-tools/kcsan.rst | 4 ++--
Documentation/dev-tools/kmsan.rst | 6 +++---
3 files changed, 10 insertions(+), 7 deletions(-)

diff --git a/Documentation/dev-tools/kasan.rst b/Documentation/dev-tools/kasan.rst
index 382818a7197a..858c77fe7dc4 100644
--- a/Documentation/dev-tools/kasan.rst
+++ b/Documentation/dev-tools/kasan.rst
@@ -1,5 +1,8 @@
-The Kernel Address Sanitizer (KASAN)
-====================================
+.. SPDX-License-Identifier: GPL-2.0
+.. Copyright (C) 2023, Google LLC.
+
+Kernel Address Sanitizer (KASAN)
+================================

Overview
--------
diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
index 3ae866dcc924..94b6802ab0ab 100644
--- a/Documentation/dev-tools/kcsan.rst
+++ b/Documentation/dev-tools/kcsan.rst
@@ -1,8 +1,8 @@
.. SPDX-License-Identifier: GPL-2.0
.. Copyright (C) 2019, Google LLC.

-The Kernel Concurrency Sanitizer (KCSAN)
-========================================
+Kernel Concurrency Sanitizer (KCSAN)
+====================================

The Kernel Concurrency Sanitizer (KCSAN) is a dynamic race detector, which
relies on compile-time instrumentation, and uses a watchpoint-based sampling
diff --git a/Documentation/dev-tools/kmsan.rst b/Documentation/dev-tools/kmsan.rst
index 55fa82212eb2..323eedad53cd 100644
--- a/Documentation/dev-tools/kmsan.rst
+++ b/Documentation/dev-tools/kmsan.rst
@@ -1,9 +1,9 @@
.. SPDX-License-Identifier: GPL-2.0
.. Copyright (C) 2022, Google LLC.

-===================================
-The Kernel Memory Sanitizer (KMSAN)
-===================================
+===============================
+Kernel Memory Sanitizer (KMSAN)
+===============================

KMSAN is a dynamic error detector aimed at finding uses of uninitialized
values. It is based on compiler instrumentation, and is quite similar to the
--
2.25.1

2023-10-07 07:02:18

by Marco Elver

Subject: Re: [PATCH 5/5] Documentation: *san: drop "the" from article titles

On Fri, 6 Oct 2023 at 17:18, <[email protected]> wrote:
>
> From: Andrey Konovalov <[email protected]>
>
> Drop "the" from the titles of documentation articles for KASAN, KCSAN,
> and KMSAN, as it is redundant.
>
> Also add SPDX-License-Identifier for kasan.rst.
>
> Signed-off-by: Andrey Konovalov <[email protected]>
> ---
> Documentation/dev-tools/kasan.rst | 7 +++++--
> Documentation/dev-tools/kcsan.rst | 4 ++--
> Documentation/dev-tools/kmsan.rst | 6 +++---

UBSan also has it: https://docs.kernel.org/dev-tools/ubsan.html

Reviewed-by: Marco Elver <[email protected]>

> 3 files changed, 10 insertions(+), 7 deletions(-)
>
> diff --git a/Documentation/dev-tools/kasan.rst b/Documentation/dev-tools/kasan.rst
> index 382818a7197a..858c77fe7dc4 100644
> --- a/Documentation/dev-tools/kasan.rst
> +++ b/Documentation/dev-tools/kasan.rst
> @@ -1,5 +1,8 @@
> -The Kernel Address Sanitizer (KASAN)
> -====================================
> +.. SPDX-License-Identifier: GPL-2.0
> +.. Copyright (C) 2023, Google LLC.
> +
> +Kernel Address Sanitizer (KASAN)
> +================================
>
> Overview
> --------
> diff --git a/Documentation/dev-tools/kcsan.rst b/Documentation/dev-tools/kcsan.rst
> index 3ae866dcc924..94b6802ab0ab 100644
> --- a/Documentation/dev-tools/kcsan.rst
> +++ b/Documentation/dev-tools/kcsan.rst
> @@ -1,8 +1,8 @@
> .. SPDX-License-Identifier: GPL-2.0
> .. Copyright (C) 2019, Google LLC.
>
> -The Kernel Concurrency Sanitizer (KCSAN)
> -========================================
> +Kernel Concurrency Sanitizer (KCSAN)
> +====================================
>
> The Kernel Concurrency Sanitizer (KCSAN) is a dynamic race detector, which
> relies on compile-time instrumentation, and uses a watchpoint-based sampling
> diff --git a/Documentation/dev-tools/kmsan.rst b/Documentation/dev-tools/kmsan.rst
> index 55fa82212eb2..323eedad53cd 100644
> --- a/Documentation/dev-tools/kmsan.rst
> +++ b/Documentation/dev-tools/kmsan.rst
> @@ -1,9 +1,9 @@
> .. SPDX-License-Identifier: GPL-2.0
> .. Copyright (C) 2022, Google LLC.
>
> -===================================
> -The Kernel Memory Sanitizer (KMSAN)
> -===================================
> +===============================
> +Kernel Memory Sanitizer (KMSAN)
> +===============================
>
> KMSAN is a dynamic error detector aimed at finding uses of uninitialized
> values. It is based on compiler instrumentation, and is quite similar to the
> --
> 2.25.1
>

2023-10-09 19:45:56

by Andrey Konovalov

Subject: Re: [PATCH 5/5] Documentation: *san: drop "the" from article titles

On Sat, Oct 7, 2023 at 9:01 AM Marco Elver <[email protected]> wrote:
>
> On Fri, 6 Oct 2023 at 17:18, <[email protected]> wrote:
> >
> > From: Andrey Konovalov <[email protected]>
> >
> > Drop "the" from the titles of documentation articles for KASAN, KCSAN,
> > and KMSAN, as it is redundant.
> >
> > Also add SPDX-License-Identifier for kasan.rst.
> >
> > Signed-off-by: Andrey Konovalov <[email protected]>
> > ---
> > Documentation/dev-tools/kasan.rst | 7 +++++--
> > Documentation/dev-tools/kcsan.rst | 4 ++--
> > Documentation/dev-tools/kmsan.rst | 6 +++---
>
> UBSan also has it: https://docs.kernel.org/dev-tools/ubsan.html

Ah, right, forgot that one. I'll send a fix up next week.

(Once again I wonder if we should rename UBSAN to KUBSAN. :)

> Reviewed-by: Marco Elver <[email protected]>

Thanks!