From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-24.8 required=3.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, USER_AGENT_SANE_1,USER_IN_DEF_DKIM_WL autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C92ACC433E0 for ; Fri, 12 Mar 2021 15:08:01 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 6AE7A64F80 for ; Fri, 12 Mar 2021 15:08:01 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 6AE7A64F80 Authentication-Results: mail.kernel.org; dmarc=fail (p=reject dis=none) header.from=google.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id F42356B006C; Fri, 12 Mar 2021 10:08:01 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id EF11B6B0070; Fri, 12 Mar 2021 10:08:00 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id D6C796B0071; Fri, 12 Mar 2021 10:08:00 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0083.hostedemail.com [216.40.44.83]) by kanga.kvack.org (Postfix) with ESMTP id B56326B006C for ; Fri, 12 Mar 2021 10:08:00 -0500 (EST) Received: from smtpin29.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay02.hostedemail.com (Postfix) with ESMTP id 701D0876D for ; Fri, 12 Mar 2021 15:08:00 +0000 (UTC) X-FDA: 77911552320.29.78FCA1C Received: from mail-wm1-f44.google.com (mail-wm1-f44.google.com [209.85.128.44]) by imf13.hostedemail.com (Postfix) with ESMTP id 26E63E005F02 for ; Fri, 12 Mar 2021 15:07:49 +0000 (UTC) Received: by mail-wm1-f44.google.com with SMTP id r15-20020a05600c35cfb029010e639ca09eso16013129wmq.1 for ; Fri, 12 Mar 2021 07:07:52 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=fwNR/esNVxm8bvX0S5OWeZlTokgAgw+YxcDuubZWv9Y=; b=PVXNJnwSGwoevssUnEh1inCzRSXjHaDhS0l9Lxkb6lXzwyiMvsKzhOdQ1oktcEVyl0 HyN/+lCS9c98sOlX263sV7lUUA/1p7VXOZMd0kwZOwKO6yA1qwJaWGjOkWtC3zeRQPGr uPO6pDotO3NhEjO0FS2rxtztT9GZ7LdqlHWCd432Mnj1MCUYYblWDWwNhHGHV0fYHipP 8DA87GJH0O9rFV6lsfyJdgcZYLda9E2jvYecRbiIFOMSqH41rF77dpj7o4t4dVpg5jUX XasF4PC1gALbaTVx41DjHjgd+28cmG6iVRXzhQmkwyd4uC/I7biUEEmiovtvd161vEXy lPcg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=fwNR/esNVxm8bvX0S5OWeZlTokgAgw+YxcDuubZWv9Y=; b=FyvHzdpBIZUb9tqQklQu+0Ng59IPEs52tdG4UO/mOb796xdICtd/xP2Wi68T0jWEDC YiX+tE8OcSydsvOQ8nNPALDr1aJhsRRGicE3Hb8+Cyxw7cedBLauorDqhBBmq1kNsnVr uCEH0ERMuLR1r/dMt4Cnt59forvVb7CVr/LdAcThhMOKMrj36eWAOPzHpz9ccyq/f/1r aUpe6+2KGMT4Rz3WiLOtXhBYZRxcLZKxDQRAoGlnBXeqs5GxxMbOEOZBorGfoLwhHTF6 s30brFDZ60oU0ttV3+UZj5ACH2+rv9qNV8GwcXAhMTnPowJDD4VQ5VTvpRwhNNKlUqFp IPmA== X-Gm-Message-State: AOAM5325X9VZpWyMtbEmSG9DDAvA1sNE/1lFghnAdu0msr9qtIN4BdpY bzNB85IrUese3WwvWIp9PeFHNXh9aeChtw== X-Google-Smtp-Source: ABdhPJxnpebHGFV0Q4Eu8cs3Jth8EBcbH5bjBDK71GUH5UHkJB1w1j2kgjPd33zgfnq0afxfAxD5uQ== X-Received: by 2002:a7b:c931:: with SMTP id h17mr13781890wml.4.1615561670668; Fri, 12 Mar 2021 07:07:50 -0800 (PST) Received: from elver.google.com ([2a00:79e0:15:13:d5de:d45f:f79c:cb62]) by smtp.gmail.com with ESMTPSA id h10sm8125546wrp.22.2021.03.12.07.07.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Mar 2021 07:07:49 -0800 (PST) Date: Fri, 12 Mar 2021 16:07:44 +0100 From: Marco Elver To: Andrey Konovalov Cc: Andrew Morton , Alexander Potapenko , Andrey Ryabinin , Dmitry Vyukov , 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: References: <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) X-Stat-Signature: 79q38scnkwfmfikh4xnwmwtxgwwwjyek X-Rspamd-Server: rspam02 X-Rspamd-Queue-Id: 26E63E005F02 Received-SPF: none (google.com>: No applicable sender policy available) receiver=imf13; identity=mailfrom; envelope-from=""; helo=mail-wm1-f44.google.com; client-ip=209.85.128.44 X-HE-DKIM-Result: pass/pass X-HE-Tag: 1615561669-791546 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: 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 Reviewed-by: Marco Elver > --- > 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 >