public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Takahiro Itazuri <itazur@amazon.com>
To: <linux-doc@vger.kernel.org>, <linux-kernel@vger.kernel.org>
Cc: Takahiro Itazuri <itazur@amazon.com>,
	Takahiro Itazuri <zulinx86@gmail.com>,
	Thomas Gleixner <tglx@linutronix.de>,
	Borislav Petkov <bp@alien8.de>,
	Peter Zijlstra <peterz@infradead.org>,
	Josh Poimboeuf <jpoimboe@kernel.org>,
	Pawan Gupta <pawan.kumar.gupta@linux.intel.com>,
	Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH] Documentation: Use list table for possible GDS sysfs values
Date: Tue, 3 Sep 2024 13:25:33 +0000	[thread overview]
Message-ID: <20240903132533.26458-1-itazur@amazon.com> (raw)

Using a normal table, a line break in the first column would be
recognized as two rows. Uses a list table instead as in MDS.

Signed-off-by: Takahiro Itazuri <itazur@amazon.com>
---
 .../hw-vuln/gather_data_sampling.rst          | 36 ++++++++++---------
 1 file changed, 19 insertions(+), 17 deletions(-)

diff --git a/Documentation/admin-guide/hw-vuln/gather_data_sampling.rst b/Documentation/admin-guide/hw-vuln/gather_data_sampling.rst
index 264bfa937f7d..4a2eaa80d20a 100644
--- a/Documentation/admin-guide/hw-vuln/gather_data_sampling.rst
+++ b/Documentation/admin-guide/hw-vuln/gather_data_sampling.rst
@@ -85,23 +85,25 @@ GDS this can be accessed by the following sysfs file:
 
 The possible values contained in this file are:
 
- ============================== =============================================
- Not affected                   Processor not vulnerable.
- Vulnerable                     Processor vulnerable and mitigation disabled.
- Vulnerable: No microcode       Processor vulnerable and microcode is missing
-                                mitigation.
- Mitigation: AVX disabled,
- no microcode                   Processor is vulnerable and microcode is missing
-                                mitigation. AVX disabled as mitigation.
- Mitigation: Microcode          Processor is vulnerable and mitigation is in
-                                effect.
- Mitigation: Microcode (locked) Processor is vulnerable and mitigation is in
-                                effect and cannot be disabled.
- Unknown: Dependent on
- hypervisor status              Running on a virtual guest processor that is
-                                affected but with no way to know if host
-                                processor is mitigated or vulnerable.
- ============================== =============================================
+  .. list-table::
+
+     * - 'Not affected'
+       - Processor is not vulnerable.
+     * - 'Vulnerable'
+       - Processor is vulnerable and mitigation is disabled.
+     * - 'Vulnerable: No microcode'
+       - Processor is vulnerable and microcode is missing mitigation.
+     * - 'Mitigation: AVX disabled, no microcode'
+       - Processor is vulnerable and microcode is missing mitigation. AVX
+         disabled as mitigation.
+     * - 'Mitigation: Microcode'
+       - Processor is vulnerable and mitigation is in effect.
+     * - 'Mitigation: Microcode (locked)'
+       - Processor is vulnerable and mitigation is in effect and cannot be
+         disabled.
+     * - 'Unknown: Dependent on hypervisor status'
+       - Running on a virtual guest processor that is affected but with no way
+         to know if host processor is mitigated or vulnerable.
 
 GDS Default mitigation
 ----------------------
-- 
2.40.1


             reply	other threads:[~2024-09-03 13:26 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-09-03 13:25 Takahiro Itazuri [this message]
2024-09-05 19:21 ` [PATCH] Documentation: Use list table for possible GDS sysfs values Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240903132533.26458-1-itazur@amazon.com \
    --to=itazur@amazon.com \
    --cc=bp@alien8.de \
    --cc=corbet@lwn.net \
    --cc=jpoimboe@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pawan.kumar.gupta@linux.intel.com \
    --cc=peterz@infradead.org \
    --cc=tglx@linutronix.de \
    --cc=zulinx86@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox