[PATCH] Documentation: Use list table for possible GDS sysfs values

[PATCH] Documentation: Use list table for possible GDS sysfs values

[Takahiro Itazuri]

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

Re: [PATCH] Documentation: Use list table for possible GDS sysfs values

[Jonathan Corbet]

Takahiro Itazuri <itazur@amazon.com> writes:

> 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(-)

Is there any chance I could get you to turn this into a grid table
instead?  List tables are entirely unreadable in the source file...

Thanks,

jon