linux-kernel - Re: [PATCH v6 18/23] docs: add Rust documentation

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: <CANiq72mBVo4+htxVjY0wB1Y3GO2PEUiZjZKRYT8ddwx84-hAtg@mail.gmail.com>
Date:   Mon, 9 May 2022 12:41:28 +0200
From:   Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To:     Akira Yokosawa <akiyks@...il.com>
Cc:     Miguel Ojeda <ojeda@...nel.org>,
        Alex Gaynor <alex.gaynor@...il.com>,
        Adam Bratschi-Kaye <ark.email@...il.com>,
        Boris-Chengbiao Zhou <bobo1239@....de>,
        Wu XiangCheng <bobwxc@...il.cn>,
        Jonathan Corbet <corbet@....net>, Daniel Xu <dxu@...uu.xyz>,
        Gary Guo <gary@...yguo.net>,
        Greg KH <gregkh@...uxfoundation.org>,
        Jarkko Sakkinen <jarkko@...nel.org>,
        Yuki Okushi <jtitor@...6.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Linux Kbuild mailing list <linux-kbuild@...r.kernel.org>,
        linux-kernel <linux-kernel@...r.kernel.org>,
        Masahiro Yamada <masahiroy@...nel.org>,
        Julian Merkle <me@...erkle.de>, Finn Behrens <me@...enk.de>,
        Michal Marek <michal.lkml@...kovi.net>,
        Michael Ellerman <mpe@...erman.id.au>,
        Nick Desaulniers <ndesaulniers@...gle.com>,
        rust-for-linux <rust-for-linux@...r.kernel.org>,
        Sven Van Asbroeck <thesven73@...il.com>,
        Linus Torvalds <torvalds@...ux-foundation.org>,
        Wedson Almeida Filho <wedsonaf@...gle.com>,
        Wei Liu <wei.liu@...nel.org>
Subject: Re: [PATCH v6 18/23] docs: add Rust documentation

Hi Akira,

On Mon, May 9, 2022 at 6:02 AM Akira Yokosawa <akiyks@...il.com> wrote:
>
> I think you agreed splitting SVG part into its own patch with
> a proper copying info, etc.  Let me see...  So, here is the link:

Yes, sorry, will do (in fact, it should have been there in v5 too).

By the way, the Linux SVG logo (used to make the one here) is pending
in the linux-doc ML.

> I might have missed v5 of this patch series.
> That might be because v5's 15/20 was not accepted by linux-doc's
> lore archive (maybe) due to its size despite it had Cc: linux-doc.
> v6's 18/23 was also rejected.

Yes, a few patches get rejected in several lists. We were told this
was fine as long as LKML gets them (the cover letter has the lists in
Cc).

> I have some alternative ideas for table formatting in ReST.

I was following the LLVM one, but it makes sense to use the other ones
where possible. I can send a patch for that one too.

> So here are a couple of alternative ways to represent the table
>
> * ASCII-art format:
> * Literal block format:

Thanks for taking the time to format the examples, it is useful :)

> As you see, those inline-literal markers of ``xxxx``, which are
> distracting when the .rst file is read as plain-text, are not
> necessary in the literal-block approach.  And you can directly

I agree, it can be better (it is one reason I find Markdown a bit more
readable since it uses a single backquote for that instead of two).

> In my opinion, the literal-block approach should be the most
> reasonable choice here. Of course its your call which one
> to choose.

Yeah, that sounds reasonable. I will take a look.

Thanks for the review!

Cheers,
Miguel