Re: [PATCH v2] Documentation: Use grid table over list table

[Takahiro Itazuri]

On Fri, 6 Sep 2024, Pawan Gupta <pawan.kumar.gupta@xxxxxxxxxxxxxxx> wrote:
> On Fri, Sep 06, 2024 at 04:26:49PM +0300, Jani Nikula wrote:
> > On Fri, 06 Sep 2024, Takahiro Itazuri <itazur@xxxxxxxxxx> wrote:
> > > Using a simple table, a line break in the first column would be
> > > recognized as two rows. To avoid that, list table was used but it
> > > is unreadable for plain text readers. Uses grid table instead.
> > >
> > > Signed-off-by: Takahiro Itazuri <itazur@xxxxxxxxxx>
> > > ---
> > > Changes in v2:
> > > - Use grid table over list table (applying to not only GDS but also
> > >   other vulnerabilities)
> > > - Link to v1: https://lore.kernel.org/all/20240903132533.26458-1-itazur@xxxxxxxxxx/
> > 
> > I see that Jon asked you to use a grid table.
> > 
> > But when I look at what's being changed, I can't help but think a
> > definition list [1] might provide the best compromise between readable
> > (and easily editable!) source rst and generated html. I don't think it
> > has to be a *table* in either.

Thank you for your feedback!

Then, I'd prefer list table again because it doesn't change the existing HTML
appearance and it doesn't look much different from the definition list in plain
text format.

For readability/editability in plain text format, a line break can be inserted
between items as follows:

.. list-table::

   * - 'Not affected'
     - Processor not vulnerable.

   * - 'Vulnerable'
     - Processor vulnerable and mitigation disabled.

   * - 'Vulnerable: No microcode'
     - Processor vulnerable and microcode is missing migitation.

   * - 'Mitigation: AVX disabled, no microcode'
     - Processor is vulnerable and microcode is missing mitigation. AVX disbaled 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.

Thanks,
Taka