MIME-Version: 1.0
References: <20211206140313.5653-1-ojeda@kernel.org> <20211206140313.5653-15-ojeda@kernel.org>
 <CAKwvOdnA+XU9u+dJ6NfmVFDTxdkCH4v04nMVaieuzauWZtBUpw@mail.gmail.com>
In-Reply-To: <CAKwvOdnA+XU9u+dJ6NfmVFDTxdkCH4v04nMVaieuzauWZtBUpw@mail.gmail.com>
From:   Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
Date:   Thu, 9 Dec 2021 00:07:24 +0100
Message-ID: <CANiq72n1DehytS+n2_RbJf0uAROTD2c48voDWVGEWPaPr_V4qQ@mail.gmail.com>
Subject: Re: [PATCH 14/19] docs: add Rust documentation
To:     Nick Desaulniers <ndesaulniers@google.com>
Cc:     Miguel Ojeda <ojeda@kernel.org>,
        Linus Torvalds <torvalds@linux-foundation.org>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        rust-for-linux <rust-for-linux@vger.kernel.org>,
        Linux Kbuild mailing list <linux-kbuild@vger.kernel.org>,
        Linux Doc Mailing List <linux-doc@vger.kernel.org>,
        linux-kernel <linux-kernel@vger.kernel.org>,
        Alex Gaynor <alex.gaynor@gmail.com>,
        Finn Behrens <me@kloenk.de>,
        Adam Bratschi-Kaye <ark.email@gmail.com>,
        Wedson Almeida Filho <wedsonaf@google.com>,
        Michael Ellerman <mpe@ellerman.id.au>,
        Sven Van Asbroeck <thesven73@gmail.com>,
        Wu XiangCheng <bobwxc@email.cn>, Gary Guo <gary@garyguo.net>,
        Boris-Chengbiao Zhou <bobo1239@web.de>,
        Yuki Okushi <jtitor@2k36.org>, Wei Liu <wei.liu@kernel.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Wed, Dec 8, 2021 at 2:30 AM Nick Desaulniers <ndesaulniers@google.com> wrote:
>
> I'm sure Documentation/rust/ will grow over time; there's certainly
> more that can be added and core kernel devs will have more questions

Indeed -- the comment is only trying to emphasize (or explain) that
this might be a difference with respect to C, i.e. that we should try
to put as much of the documentation as possible closer to the code,
rather than create "far" files in `Documentation/rust`. I will try to
clarify the comment.

> But I read through all that was added here and didn't find anything
> problematic IMO.  I didn't verify the png's are actually the logo...

Thanks for reading through all of it!

> I don't think `make htmldocs` produced any new warnings, though it's
> not exactly warning free at the moment (pre-existing before this
> series).

Yeah, I also run `make htmldocs` before submitting the patch series
rounds. And indeed, there are quite a few warnings (20+?), but none
coming from `Documentation/rust` that I could see.

> How is rust-logo.png being included in the docs? Is there something
> with RST that isn't grep'able for rust-logo.png?

At the moment, the assets are simply copied to the output folder, in
the `rust/Makefile`. (I should provide an SVG too or remove the
reference to it, by the way).

Cheers,
Miguel