rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Miguel Ojeda <ojeda@kernel.org>,
	Linus Torvalds <torvalds@linux-foundation.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: rust-for-linux@vger.kernel.org, linux-kbuild@vger.kernel.org,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	Miguel Ojeda <ojeda@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>,
	Daniel Xu <dxu@dxuuu.xyz>
Subject: Re: [PATCH v3 14/19] docs: add Rust documentation
Date: Tue, 18 Jan 2022 15:33:39 -0700	[thread overview]
Message-ID: <87fspk1xoc.fsf@meer.lwn.net> (raw)
In-Reply-To: <20220117053349.6804-15-ojeda@kernel.org>

Miguel Ojeda <ojeda@kernel.org> writes:

> Most of the documentation for Rust is written within the source code
> itself, as it is idiomatic for Rust projects. This applies to both
> the shared infrastructure at `rust/` as well as any other Rust module
> (e.g. drivers) written across the kernel.
>
> However, these documents contain general information that does not
> fit particularly well in the source code, like the Quick Start guide.
>
> It also contains a few binary assets used for the `rustdoc` target
> and a few other small changes elsewhere in the documentation folder.

Glad to see documentation!

That said, I have one little request...

>  Documentation/doc-guide/kernel-doc.rst      |   3 +
>  Documentation/index.rst                     |   1 +
>  Documentation/kbuild/kbuild.rst             |   4 +
>  Documentation/process/changes.rst           |  42 ++++
>  Documentation/rust/arch-support.rst         |  35 +++
>  Documentation/rust/assets/favicon-16x16.png | Bin 0 -> 798 bytes
>  Documentation/rust/assets/favicon-32x32.png | Bin 0 -> 2076 bytes
>  Documentation/rust/assets/rust-logo.png     | Bin 0 -> 53976 bytes

We have really tried to keep binary files (like PNG images) out of the
documentation tree.  If we really need these images, can they be
provided in SVG form?

Thanks,

jon

  reply	other threads:[~2022-01-18 22:33 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-17  5:33 [PATCH v3 00/19] Rust support Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 01/19] kallsyms: support "big" kernel symbols Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 02/19] kallsyms: increase maximum kernel symbol length to 512 Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 03/19] kallsyms: use the correct buffer size for symbols Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 04/19] rust: add C helpers Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 05/19] rust: add `compiler_builtins` crate Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 07/19] rust: add `build_error` crate Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 08/19] rust: add `macros` crate Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 10/19] rust: export generated symbols Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 11/19] vsprintf: add new `%pA` format specifier Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 12/19] scripts: add `generate_rust_analyzer.py` Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 13/19] scripts: decode_stacktrace: demangle Rust symbols Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 14/19] docs: add Rust documentation Miguel Ojeda
2022-01-18 22:33   ` Jonathan Corbet [this message]
2022-01-19 13:58     ` Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 15/19] Kbuild: add Rust support Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 16/19] samples: add Rust examples Miguel Ojeda
2022-01-17  5:33 ` [PATCH v3 17/19] MAINTAINERS: Rust Miguel Ojeda
2022-01-17  5:33 ` [RFC PATCH v3 18/19] drivers: gpio: PrimeCell PL061 in Rust Miguel Ojeda

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=87fspk1xoc.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=alex.gaynor@gmail.com \
    --cc=ark.email@gmail.com \
    --cc=bobo1239@web.de \
    --cc=bobwxc@email.cn \
    --cc=dxu@dxuuu.xyz \
    --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=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 \
    --subject='Re: [PATCH v3 14/19] docs: add Rust documentation' \
    /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

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).