Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
MIME-Version: 1.0
References: <3167cbec7a82704c1ed2c6bfe85b77534a836fdc.1651162840.git.andreyknvl@google.com>
In-Reply-To: <3167cbec7a82704c1ed2c6bfe85b77534a836fdc.1651162840.git.andreyknvl@google.com>
From:   Alexander Potapenko <glider@google.com>
Date:   Thu, 28 Apr 2022 18:42:16 +0200
Message-ID: <CAG_fn=XFOA-qsvPwjwJ0iZH1Wy54aS7QtD4ETVdp9L-yvOkiWg@mail.gmail.com>
Subject: Re: [PATCH 1/3] kasan: clean up comments in internal kasan.h
To:     andrey.konovalov@linux.dev
Cc:     Marco Elver <elver@google.com>,
        Andrey Konovalov <andreyknvl@gmail.com>,
        Dmitry Vyukov <dvyukov@google.com>,
        Andrey Ryabinin <ryabinin.a.a@gmail.com>,
        kasan-dev <kasan-dev@googlegroups.com>,
        Andrew Morton <akpm@linux-foundation.org>,
        Linux Memory Management List <linux-mm@kvack.org>,
        LKML <linux-kernel@vger.kernel.org>,
        Andrey Konovalov <andreyknvl@google.com>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

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

Reviewed-by: Alexander Potapenko <glider@google.com>

>
> +/* 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 ?