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 Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2F755C43217 for ; Fri, 30 Sep 2022 13:33:17 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 39FF48D0002; Fri, 30 Sep 2022 09:33:16 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 3298B8D0001; Fri, 30 Sep 2022 09:33:16 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 17BA68D0002; Fri, 30 Sep 2022 09:33:16 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0014.hostedemail.com [216.40.44.14]) by kanga.kvack.org (Postfix) with ESMTP id 05CAE8D0001 for ; Fri, 30 Sep 2022 09:33:16 -0400 (EDT) Received: from smtpin16.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id C295E1A126D for ; Fri, 30 Sep 2022 13:33:15 +0000 (UTC) X-FDA: 79968843150.16.3D29DA9 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) by imf14.hostedemail.com (Postfix) with ESMTP id 37740100014 for ; Fri, 30 Sep 2022 13:33:13 +0000 (UTC) Received: from localhost (unknown [IPv6:2601:281:8300:73::5f6]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 0E2B27C0; Fri, 30 Sep 2022 13:33:12 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 0E2B27C0 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1664544792; bh=X9KMoc6wKBFQqqh02TQnYl/8HMk3OVzEUhHumF3CpUI=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=kAqoBsdLwJvwA/TnNO/OyRTe2bzVmSSUI9PjBrUPKUk9/BKv7DANoLUEyUh86zUzM Tbc5O4vzMtnEr14y3c0B5KoNEloNewUcVaNYsryTveAiUZJdd9tDUFy8BkrMkk6+1Z 4DO9iLaZs6s6psbIVtfQAEv89PJUiK/SzYjo2UkehxhoEG3FavVvfiuFvfztMr7aT8 xe1dQBqlt3fAwse16dnmBymfM3LKrJNUgB+404pJu5Az8ICKy1S/V4gyFtA3mwCe40 MSN+M9e1UAjp8Vm+qWOaCB5LdtBTcrwIgapidvz/MjTAdezwNNCm0q6BavLWAZYAeg 89b3RqCM2Ljkg== From: Jonathan Corbet To: Bagas Sanjaya , Rick Edgecombe Cc: x86@kernel.org, "H . Peter Anvin" , Thomas Gleixner , Ingo Molnar , linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, linux-mm@kvack.org, linux-arch@vger.kernel.org, linux-api@vger.kernel.org, Arnd Bergmann , Andy Lutomirski , Balbir Singh , Borislav Petkov , Cyrill Gorcunov , Dave Hansen , Eugene Syromiatnikov , Florian Weimer , "H . J . Lu" , Jann Horn , Kees Cook , Mike Kravetz , Nadav Amit , Oleg Nesterov , Pavel Machek , Peter Zijlstra , Randy Dunlap , "Ravi V . Shankar" , Weijiang Yang , "Kirill A . Shutemov" , joao.moreira@intel.com, John Allen , kcc@google.com, eranian@google.com, rppt@kernel.org, jamorris@linux.microsoft.com, dethoma@microsoft.com, Yu-cheng Yu Subject: Re: [PATCH v2 01/39] Documentation/x86: Add CET description In-Reply-To: References: <20220929222936.14584-1-rick.p.edgecombe@intel.com> <20220929222936.14584-2-rick.p.edgecombe@intel.com> Date: Fri, 30 Sep 2022 07:33:11 -0600 Message-ID: <87v8p5f0mg.fsf@meer.lwn.net> MIME-Version: 1.0 Content-Type: text/plain ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1664544794; a=rsa-sha256; cv=none; b=EUCqG2+uP9Jc2Z1Zb5cg/OoMYmob2OMZD6rzqEpKn6B2+rETdI44qIbp19g9vfZ2YfEFNO 4sJ7vKtWhWcKNCZgPIGZJ1Ouj1VdLKnIPbkfVvPEssrNHVR8/TNqeGOZZOSJ14tWbFyEfq ba4PJpPGCYx/VqiEHHa811j39P2daNE= ARC-Authentication-Results: i=1; imf14.hostedemail.com; dkim=pass header.d=lwn.net header.s=20201203 header.b=kAqoBsdL; dmarc=none; spf=pass (imf14.hostedemail.com: domain of corbet@lwn.net designates 45.79.88.28 as permitted sender) smtp.mailfrom=corbet@lwn.net ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1664544794; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=X9KMoc6wKBFQqqh02TQnYl/8HMk3OVzEUhHumF3CpUI=; b=HNW2V+3dc6CPID2ynfALfH+OYCs00O2s7plF0/1iaVHcEbPW7ljx9N7USjDrf/enujFkkV JYobs8OghMC3fVGP2eGUEHb0VFYeqwR5gsIFzlK43D52j1SyaxXe5vnU2jCo/pA7Kw9liT zBBUr2yVWNKiYrB1sbntLzjRroZSI7w= X-Rspamd-Queue-Id: 37740100014 X-Rspam-User: Authentication-Results: imf14.hostedemail.com; dkim=pass header.d=lwn.net header.s=20201203 header.b=kAqoBsdL; dmarc=none; spf=pass (imf14.hostedemail.com: domain of corbet@lwn.net designates 45.79.88.28 as permitted sender) smtp.mailfrom=corbet@lwn.net X-Rspamd-Server: rspam03 X-Stat-Signature: 7e1zjb59moyn7rjkxar9kw1hgsxpio7k X-HE-Tag: 1664544793-257373 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: Bagas Sanjaya writes: > The documentation above can be improved (both grammar and formatting): > > ---- >8 ---- > > diff --git a/Documentation/x86/cet.rst b/Documentation/x86/cet.rst > index 6b270a24ebc3a2..f691f7995cf088 100644 > --- a/Documentation/x86/cet.rst > +++ b/Documentation/x86/cet.rst > @@ -15,92 +15,101 @@ in the 64-bit kernel. > > CET introduces Shadow Stack and Indirect Branch Tracking. Shadow stack is > a secondary stack allocated from memory and cannot be directly modified by > -applications. When executing a CALL instruction, the processor pushes the > +applications. When executing a ``CALL`` instruction, the processor pushes the Just to be clear, not everybody is fond of sprinkling lots of ``literal text`` throughout the documentation in this way. Heavy use of it will certainly clutter the plain-text file and can be a net negative overall. Thanks, jon