Re: [PATCH 1/3] kasan: clean up comments in internal kasan.h

From: Alexander Potapenko
Date: Thu Apr 28 2022 - 12:42:57 EST


On Thu, Apr 28, 2022 at 6:21 PM <andrey.konovalov@xxxxxxxxx> wrote:
>
> From: Andrey Konovalov <andreyknvl@xxxxxxxxxx>
>
> Clean up comments in mm/kasan/kasan.h: clarify, unify styles, fix
> punctuation, etc.
>
> Signed-off-by: Andrey Konovalov <andreyknvl@xxxxxxxxxx>

Reviewed-by: Alexander Potapenko <glider@xxxxxxxxxx>

>
> +/* alloca redzone size. Compiler's ABI, do not change. */
s/Compiler's/Compiler ?

> #define KASAN_ALLOCA_REDZONE_SIZE 32
>
> -/*
> - * Stack frame marker (compiler ABI).
> - */
> +/* Stack frame marker. Compiler's ABI, do not change. */
Ditto

>
> -/* The layout of struct dictated by compiler */
> +/* Do not change the struct layout: compiler's ABI. */
Ditto

> -/* The layout of struct dictated by compiler */
> +/* Do not change the struct layout: compiler's ABI. */
Ditto

> - unsigned long has_dynamic_init; /* This needed for C++ */
> + unsigned long has_dynamic_init; /* This needed for C++. */
"is needed"?


> - * is accepted since SLAB redzones aren't enabled in production builds.
> + * is accepted since slab redzones aren't enabled in production builds.
s/accepted/acceptable ?