linux-kernel - Re: [PATCH linux-doc v2] docs/doc-guide: Clarify how to write tables

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] [day] [month] [year] [list]

Message-ID: <CADa=RywRFzMy_1_xfmmPyrUKGOJ6ziVAFzG2RLdTM7w0H1LfRQ@mail.gmail.com>
Date:   Mon, 24 Apr 2023 10:17:03 -0700
From:   Joe Stringer <joe@...valent.com>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        corbet@....net
Subject: Re: [PATCH linux-doc v2] docs/doc-guide: Clarify how to write tables

On Sat, Apr 22, 2023 at 11:31 AM Randy Dunlap <rdunlap@...radead.org> wrote:
>
> Hi,
>
> On 4/22/23 10:52, Joe Stringer wrote:
> > Prior to this commit, the kernel docs writing guide spent over a page
> > describing exactly how *not* to write tables into the kernel docs,
> > without providing a example about the desired format.
> > > This patch provides a positive example first in the guide so that it's
> > harder to miss, then leaves the existing less desirable approach below
> > for contributors to follow if they have some stronger justification for
> > why to use that approach.
> >
> > Signed-off-by: Joe Stringer <joe@...valent.com>
> > ---
> > v2: Simplify recommendation for either simple or grid table syntax
> >     Remove example, link to rST user reference
> > ---
> >  Documentation/doc-guide/sphinx.rst | 11 ++++++++++-
> >  1 file changed, 10 insertions(+), 1 deletion(-)
> >
> > diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
> > index 23edb427e76f..77ac7dc27715 100644
> > --- a/Documentation/doc-guide/sphinx.rst
> > +++ b/Documentation/doc-guide/sphinx.rst
> > @@ -313,9 +313,18 @@ the documentation build system will automatically turn a reference to
> >  function name exists.  If you see ``c:func:`` use in a kernel document,
> >  please feel free to remove it.
> >
> > +Tables
> > +------
> > +
> > +ReStructuredText provides several options for table syntax. Kernel style for
> > +tables is prefer *simple table* syntax or *grid table* syntax. See the
>
>    tables is to prefer
> or
>    tables prefers
>
> Otherwise LGTM. It's good to have positive examples, not just negative ones.

Thanks, I'll fix this up and send a fresh version.