linux-kernel - [PATCH 1/3] Documentation: hw-vuln: Wrap mitigate_smt

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20230215123253.41552-2-bagasdotme@gmail.com>
Date:   Wed, 15 Feb 2023 19:32:51 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     Linux Documentation <linux-doc@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Linux Next Mailing List <linux-next@...r.kernel.org>,
        Linux Power Management <linux-pm@...r.kernel.org>,
        Linux BPF Development <bpf@...r.kernel.org>
Cc:     Jonathan Corbet <corbet@....net>, Huang Rui <ray.huang@....com>,
        Alexei Starovoitov <ast@...nel.org>,
        Daniel Borkmann <daniel@...earbox.net>,
        Andrii Nakryiko <andrii@...nel.org>,
        Martin KaFai Lau <martin.lau@...ux.dev>,
        Song Liu <song@...nel.org>, Yonghong Song <yhs@...com>,
        John Fastabend <john.fastabend@...il.com>,
        KP Singh <kpsingh@...nel.org>,
        Stanislav Fomichev <sdf@...gle.com>,
        Hao Luo <haoluo@...gle.com>, Jiri Olsa <jolsa@...nel.org>,
        Bagas Sanjaya <bagasdotme@...il.com>,
        Paolo Bonzini <pbonzini@...hat.com>,
        Tom Lendacky <thomas.lendacky@....com>,
        Dave Marchevsky <davemarchevsky@...com>,
        Perry Yuan <perry.yuan@....com>,
        "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>,
        Wyes Karny <wyes.karny@....com>,
        Mario Limonciello <mario.limonciello@....com>,
        oe-kbuild-all@...ts.linux.dev,
        Stephen Rothwell <sfr@...b.auug.org.au>
Subject: [PATCH 1/3] Documentation: hw-vuln: Wrap mitigate_smt_rsb example in literal code block

Stephen Rothwell reported htmldocs warning when making htmldocs from
Linus's Tree:

Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst:92: ERROR: Unexpected indentation.

Fix the warning by formatting example of mitigate_smt_rsb module parameter
as literal code block.

Link: https://lore.kernel.org/linux-next/20230215144117.369ffb5f@canb.auug.org.au/
Fixes: 493a2c2d23ca91 ("Documentation/hw-vuln: Add documentation for Cross-Thread Return Predictions")
Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
 Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst b/Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst
index ec6e9f5bcf9e89..3593d30ccfde12 100644
--- a/Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst
+++ b/Documentation/admin-guide/hw-vuln/cross-thread-rsb.rst
@@ -88,5 +88,6 @@ capability to override those interceptions, but since this is not common, the
 mitigation that covers this path is not enabled by default.
 
 The mitigation for the KVM_CAP_X86_DISABLE_EXITS capability can be turned on
-using the boolean module parameter mitigate_smt_rsb, e.g.:
+using the boolean module parameter mitigate_smt_rsb, e.g.::
+
         kvm.mitigate_smt_rsb=1
-- 
An old man doll... just what I always wanted! - Clara