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

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: <87h6asgal3.fsf@trenco.lwn.net>
Date: Fri, 06 Sep 2024 07:45:12 -0600
From: Jonathan Corbet <corbet@....net>
To: Jani Nikula <jani.nikula@...ux.intel.com>, Takahiro Itazuri
 <itazur@...zon.com>, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org
Cc: bp@...en8.de, itazur@...zon.com, zulinx86@...il.com,
 jpoimboe@...nel.org, pawan.kumar.gupta@...ux.intel.com,
 peterz@...radead.org, tglx@...utronix.de
Subject: Re: [PATCH v2] Documentation: Use grid table over list table

Jani Nikula <jani.nikula@...ux.intel.com> writes:

> On Fri, 06 Sep 2024, Takahiro Itazuri <itazur@...zon.com> 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@...zon.com>
>> ---
>> 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@amazon.com/
>
> 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.
>
> Up to Jon, of course.

I think it's up to the people who write and use the documentation in the
end; I don't want to dictate minor choices like that.  Anything that
makes it more readable works well for me.

Thanks,

jon