Contribute documentation

Contribute documentation

[Douglas Su]

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.

I wonder if this documentation is valuable and if so, how could I
contribute these to the Kernel's source?

Currently, these documentations are drafts that mean typos and grammar
errors (English is not my first language, sorry for that.) may exist.

Thanks

Re: Contribute documentation

[Miguel Ojeda]

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

Re: Contribute documentation

[Douglas Su]

> Note that you replied only to me so others did not see your reply! You
> need to use "Reply to All" so that your message is seen by all the
> mailing list :-)
>
> Also, please do not feel discouraged by what I said. I think having a
> book like the Rust ones (like the rustc dev guide book) would be great
> when the project grows, and I am sure a lot of people will appreciate
> it. I was trying to point out things that would perhaps need to change
> a bit etc.
>
> Cheers,
> Miguel

Thanks for your response.

Cheers,
Douglas