mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2026-05-07 20:58:14 -04:00
bb97dbfaf9
A few months ago we started a webpage for the Rust subsystem and the overall Rust for Linux project [1]. The current `W:` field of the Rust entry points to the GitHub repository, since originally we kept information in a `README.md` file that got rendered by GitHub when visiting that URL. That information was moved into the webpage and got expanded. The webpage is also nowadays the entry point to the project, and we pointed the "Website" GitHub metadata field to it. Thus update the `W:` field to point to the actual webpage. Link: https://rust-for-linux.com [1] Reviewed-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com> Reviewed-by: Andreas Hindborg <a.hindborg@samsung.com> Reviewed-by: Benno Lossin <benno.lossin@proton.me> Reviewed-by: Alice Ryhl <aliceryhl@google.com> Reviewed-by: Geert Stappers <stappers@stappers.nl> Reviewed-by: Boqun Feng <boqun.feng@gmail.com> Link: https://lore.kernel.org/r/20230830165949.127475-1-ojeda@kernel.org Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
Linux kernel
============
There are several guides for kernel developers and users. These guides can
be rendered in a number of formats, like HTML and PDF. Please read
Documentation/admin-guide/README.rst first.
In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``. The formatted documentation can also be read online at:
https://www.kernel.org/doc/html/latest/
There are various text files in the Documentation/ subdirectory,
several of them using the Restructured Text markup notation.
Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.