From: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
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>
Subject: Re: [PATCH 14/19] docs: add Rust documentation
Date: Thu, 9 Dec 2021 00:07:24 +0100 [thread overview]
Message-ID: <CANiq72n1DehytS+n2_RbJf0uAROTD2c48voDWVGEWPaPr_V4qQ@mail.gmail.com> (raw)
In-Reply-To: <CAKwvOdnA+XU9u+dJ6NfmVFDTxdkCH4v04nMVaieuzauWZtBUpw@mail.gmail.com>
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
next prev parent reply other threads:[~2021-12-08 23:07 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-06 14:02 [PATCH 00/19] Rust support Miguel Ojeda
2021-12-06 14:02 ` [PATCH 01/19] kallsyms: support "big" kernel symbols Miguel Ojeda
2021-12-06 14:18 ` Matthew Wilcox
2021-12-06 17:00 ` Miguel Ojeda
2021-12-06 14:02 ` [PATCH 02/19] kallsyms: increase maximum kernel symbol length to 512 Miguel Ojeda
2021-12-06 14:02 ` [PATCH 03/19] kallsyms: use the correct buffer size for symbols Miguel Ojeda
2021-12-06 14:02 ` [PATCH 04/19] rust: add C helpers Miguel Ojeda
2021-12-06 14:02 ` [PATCH 05/19] rust: add `compiler_builtins` crate Miguel Ojeda
2021-12-07 23:01 ` Nick Desaulniers
2021-12-09 19:34 ` Miguel Ojeda
2021-12-06 14:03 ` [PATCH 06/19] rust: add `alloc` crate Miguel Ojeda
2021-12-06 14:03 ` [PATCH 07/19] rust: add `build_error` crate Miguel Ojeda
2021-12-06 14:03 ` [PATCH 08/19] rust: add `macros` crate Miguel Ojeda
2021-12-06 14:03 ` [PATCH 09/19] rust: add `kernel` crate Miguel Ojeda
2021-12-06 14:03 ` [PATCH 10/19] rust: export generated symbols Miguel Ojeda
2021-12-06 14:03 ` [PATCH 11/19] vsprintf: add new `%pA` format specifier Miguel Ojeda
2021-12-06 15:02 ` Greg Kroah-Hartman
2021-12-06 15:56 ` Miguel Ojeda
2021-12-06 16:02 ` Greg Kroah-Hartman
2021-12-06 19:52 ` Nick Desaulniers
2021-12-06 19:55 ` Matthew Wilcox
2021-12-06 20:02 ` Nick Desaulniers
2021-12-06 14:03 ` [PATCH 12/19] scripts: add `generate_rust_analyzer.py` Miguel Ojeda
2021-12-06 14:03 ` [PATCH 13/19] scripts: decode_stacktrace: demangle Rust symbols Miguel Ojeda
2021-12-06 14:03 ` [PATCH 14/19] docs: add Rust documentation Miguel Ojeda
2021-12-08 1:29 ` Nick Desaulniers
2021-12-08 23:07 ` Miguel Ojeda [this message]
2021-12-06 14:03 ` [PATCH 15/19] Kbuild: add Rust support Miguel Ojeda
2021-12-07 22:45 ` Nick Desaulniers
2021-12-07 23:21 ` Nick Desaulniers
2021-12-07 23:25 ` Wedson Almeida Filho
2021-12-08 0:05 ` Nick Desaulniers
2021-12-08 22:52 ` Miguel Ojeda
2021-12-11 15:53 ` Masahiro Yamada
2022-01-17 4:45 ` Miguel Ojeda
2021-12-06 14:03 ` [PATCH 16/19] samples: add Rust examples Miguel Ojeda
2021-12-06 14:03 ` [PATCH 17/19] MAINTAINERS: Rust Miguel Ojeda
2021-12-06 14:03 ` [RFC PATCH 18/19] drivers: gpio: PrimeCell PL061 in Rust Miguel Ojeda
2021-12-06 14:03 ` [RFC PATCH 19/19] drivers: android: Binder IPC " Miguel Ojeda
2021-12-06 15:01 ` Greg Kroah-Hartman
2021-12-06 15:59 ` Wedson Almeida Filho
2021-12-06 16:02 ` Greg Kroah-Hartman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CANiq72n1DehytS+n2_RbJf0uAROTD2c48voDWVGEWPaPr_V4qQ@mail.gmail.com \
--to=miguel.ojeda.sandonis@gmail.com \
--cc=alex.gaynor@gmail.com \
--cc=ark.email@gmail.com \
--cc=bobo1239@web.de \
--cc=bobwxc@email.cn \
--cc=gary@garyguo.net \
--cc=gregkh@linuxfoundation.org \
--cc=jtitor@2k36.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=me@kloenk.de \
--cc=mpe@ellerman.id.au \
--cc=ndesaulniers@google.com \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=thesven73@gmail.com \
--cc=torvalds@linux-foundation.org \
--cc=wedsonaf@google.com \
--cc=wei.liu@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).