From: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
To: Douglas Su <d0u9.su@gmail.com>
Cc: rust-for-linux <rust-for-linux@vger.kernel.org>
Subject: Re: Contribute documentation
Date: Tue, 1 Jun 2021 13:30:37 +0200 [thread overview]
Message-ID: <CANiq72kxfZt9A_ky_UMK+Un5HRVFng8-_yBgw3W4cwjLx+St5g@mail.gmail.com> (raw)
In-Reply-To: <CABDqbH3s6Xr-5xhxAYyTt44w16A-Sq8sK7wgvxJuyDgg8+bWXg@mail.gmail.com>
Hi Douglas,
On Tue, Jun 1, 2021 at 11:56 AM Douglas Su <d0u9.su@gmail.com> wrote:
>
> Hi, fellows. I am composing a series of documentation about Rust in
> the Kernel. Currently, they are published in my github repo:
> https://github.com/d0u9/Linux-Device-Driver-Rust/tree/master/Docs.
Nice!
> I wonder if this documentation is valuable and if so, how could I
> contribute these to the Kernel's source?
From the perspective of putting it into the kernel:
- It seems a bit too detailed, i.e. it discusses implementation
details which will likely change, and thus it may be hard to keep
up-to-date. In particular now that we are still in the early days.
- Some bits are covered by other kernel docs (e.g. Kbuild), so it
would perhaps be best to cross-reference as needed instead (possibly
improving the existing docs where lacking etc.).
- I assume the `Doc/` maintainers would ask you to convert the
sources into reST format.
Cheers,
Miguel
next prev parent reply other threads:[~2021-06-01 11:30 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-01 9:56 Contribute documentation Douglas Su
2021-06-01 11:30 ` Miguel Ojeda [this message]
[not found] ` <CABDqbH2oji4Vh+u3Qp+P2h3yScX5Qi3cLsdF9Z_D8871FKD_iw@mail.gmail.com>
[not found] ` <CANiq72kXKFRGzP-=nWfiOk8Lq6TRjY2hmFS6PDomk6SsdaQagw@mail.gmail.com>
2021-06-02 1:39 ` Douglas Su
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=CANiq72kxfZt9A_ky_UMK+Un5HRVFng8-_yBgw3W4cwjLx+St5g@mail.gmail.com \
--to=miguel.ojeda.sandonis@gmail.com \
--cc=d0u9.su@gmail.com \
--cc=rust-for-linux@vger.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).