Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Date:   Fri, 12 Mar 2021 16:07:44 +0100
From:   Marco Elver <elver@google.com>
To:     Andrey Konovalov <andreyknvl@google.com>
Cc:     Andrew Morton <akpm@linux-foundation.org>,
        Alexander Potapenko <glider@google.com>,
        Andrey Ryabinin <aryabinin@virtuozzo.com>,
        Dmitry Vyukov <dvyukov@google.com>, kasan-dev@googlegroups.com,
        linux-mm@kvack.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 03/11] kasan: docs: update usage section
Message-ID: <YEuDwG6NqbNlCXL/@elver.google.com>
References: <c2bbb56eaea80ad484f0ee85bb71959a3a63f1d7.1615559068.git.andreyknvl@google.com>
 <48427809cd4b8b5d6bc00926cbe87e2b5081df17.1615559068.git.andreyknvl@google.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <48427809cd4b8b5d6bc00926cbe87e2b5081df17.1615559068.git.andreyknvl@google.com>
User-Agent: Mutt/2.0.5 (2021-01-21)
Precedence: bulk

On Fri, Mar 12, 2021 at 03:24PM +0100, Andrey Konovalov wrote:
> Update the "Usage" section in KASAN documentation:
> 
> - Add inline code snippet markers.
> - Reword the part about stack traces for clarity.
> - Other minor clean-ups.
> 
> Signed-off-by: Andrey Konovalov <andreyknvl@google.com>

Reviewed-by: Marco Elver <elver@google.com>

> ---
>  Documentation/dev-tools/kasan.rst | 23 +++++++++++------------
>  1 file changed, 11 insertions(+), 12 deletions(-)
> 
> diff --git a/Documentation/dev-tools/kasan.rst b/Documentation/dev-tools/kasan.rst
> index 2f2697b290d5..46f4e9680805 100644
> --- a/Documentation/dev-tools/kasan.rst
> +++ b/Documentation/dev-tools/kasan.rst
> @@ -41,22 +41,21 @@ and riscv architectures, and tag-based KASAN modes are supported only for arm64.
>  Usage
>  -----
>  
> -To enable KASAN configure kernel with::
> +To enable KASAN, configure the kernel with::
>  
> -	  CONFIG_KASAN = y
> +	  CONFIG_KASAN=y
>  
> -and choose between CONFIG_KASAN_GENERIC (to enable generic KASAN),
> -CONFIG_KASAN_SW_TAGS (to enable software tag-based KASAN), and
> -CONFIG_KASAN_HW_TAGS (to enable hardware tag-based KASAN).
> +and choose between ``CONFIG_KASAN_GENERIC`` (to enable generic KASAN),
> +``CONFIG_KASAN_SW_TAGS`` (to enable software tag-based KASAN), and
> +``CONFIG_KASAN_HW_TAGS`` (to enable hardware tag-based KASAN).
>  
> -For software modes, you also need to choose between CONFIG_KASAN_OUTLINE and
> -CONFIG_KASAN_INLINE. Outline and inline are compiler instrumentation types.
> -The former produces smaller binary while the latter is 1.1 - 2 times faster.
> +For software modes, also choose between ``CONFIG_KASAN_OUTLINE`` and
> +``CONFIG_KASAN_INLINE``. Outline and inline are compiler instrumentation types.
> +The former produces a smaller binary while the latter is 1.1-2 times faster.
>  
> -For better error reports that include stack traces, enable CONFIG_STACKTRACE.
> -
> -To augment reports with last allocation and freeing stack of the physical page,
> -it is recommended to enable also CONFIG_PAGE_OWNER and boot with page_owner=on.
> +To include alloc and free stack traces of affected slab objects into reports,
> +enable ``CONFIG_STACKTRACE``. To include alloc and free stack traces of affected
> +physical pages, enable ``CONFIG_PAGE_OWNER`` and boot with ``page_owner=on``.
>  
>  Error reports
>  ~~~~~~~~~~~~~
> -- 
> 2.31.0.rc2.261.g7f71774620-goog
>