Skip to content

Commit d0b3436

Browse files
Zildj1anJonathan Corbet
authored andcommitted
kernel-docs: Add new section for Rust learning materials
Include a new section in the Index of Further Kernel Documentation with resources to learn Rust. Reference it in the Rust index. The resources are a product of a survey among assistants to the conference Kangrejos'24. Signed-off-by: Carlos Bilbao <carlos.bilbao.osdev@gmail.com> Reviewed-by: Dirk Behme <dirk.behme@de.bosch.com> Acked-by: Miguel Ojeda <ojeda@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20240922160411.274949-1-carlos.bilbao.osdev@gmail.com
1 parent 3c8ead6 commit d0b3436

File tree

2 files changed

+155
-11
lines changed

2 files changed

+155
-11
lines changed

Documentation/process/kernel-docs.rst

Lines changed: 152 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,6 @@ On-line docs
7272
programming. Lots of examples. Currently the new version is being
7373
actively maintained at https://github.com/sysprog21/lkmpg.
7474

75-
* Title: **Rust for Linux**
76-
77-
:Author: various
78-
:URL: https://rust-for-linux.com/
79-
:Date: rolling version
80-
:Keywords: glossary, terms, linux-kernel.
81-
:Description: From the website: "Rust for Linux is the project adding
82-
support for the Rust language to the Linux kernel. This website is
83-
intended as a hub of links, documentation and resources related to
84-
the project".
85-
8675
Published books
8776
---------------
8877

@@ -220,6 +209,158 @@ Miscellaneous
220209
other original research and content related to Linux and software
221210
development.
222211

212+
Rust
213+
----
214+
215+
* Title: **Rust for Linux**
216+
217+
:Author: various
218+
:URL: https://rust-for-linux.com/
219+
:Date: rolling version
220+
:Keywords: glossary, terms, linux-kernel, rust.
221+
:Description: From the website: "Rust for Linux is the project adding
222+
support for the Rust language to the Linux kernel. This website is
223+
intended as a hub of links, documentation and resources related to
224+
the project".
225+
226+
* Title: **Learn Rust the Dangerous Way**
227+
228+
:Author: Cliff L. Biffle
229+
:URL: https://cliffle.com/p/dangerust/
230+
:Date: Accessed Sep 11 2024
231+
:Keywords: rust, blog.
232+
:Description: From the website: "LRtDW is a series of articles
233+
putting Rust features in context for low-level C programmers who
234+
maybe don’t have a formal CS background — the sort of people who
235+
work on firmware, game engines, OS kernels, and the like.
236+
Basically, people like me.". It illustrates line-by-line
237+
conversions from C to Rust.
238+
239+
* Title: **The Rust Book**
240+
241+
:Author: Steve Klabnik and Carol Nichols, with contributions from the
242+
Rust community
243+
:URL: https://doc.rust-lang.org/book/
244+
:Date: Accessed Sep 11 2024
245+
:Keywords: rust, book.
246+
:Description: From the website: "This book fully embraces the
247+
potential of Rust to empower its users. It’s a friendly and
248+
approachable text intended to help you level up not just your
249+
knowledge of Rust, but also your reach and confidence as a
250+
programmer in general. So dive in, get ready to learn—and welcome
251+
to the Rust community!".
252+
253+
* Title: **Rust for the Polyglot Programmer**
254+
255+
:Author: Ian Jackson
256+
:URL: https://www.chiark.greenend.org.uk/~ianmdlvl/rust-polyglot/index.html
257+
:Date: December 2022
258+
:Keywords: rust, blog, tooling.
259+
:Description: From the website: "There are many guides and
260+
introductions to Rust. This one is something different: it is
261+
intended for the experienced programmer who already knows many
262+
other programming languages. I try to be comprehensive enough to be
263+
a starting point for any area of Rust, but to avoid going into too
264+
much detail except where things are not as you might expect. Also
265+
this guide is not entirely free of opinion, including
266+
recommendations of libraries (crates), tooling, etc.".
267+
268+
* Title: **Fasterthanli.me**
269+
270+
:Author: Amos Wenger
271+
:URL: https://fasterthanli.me/
272+
:Date: Accessed Sep 11 2024
273+
:Keywords: rust, blog, news.
274+
:Description: From the website: "I make articles and videos about how
275+
computers work. My content is long-form, didactic and exploratory
276+
— and often an excuse to teach Rust!".
277+
278+
* Title: **Comprehensive Rust**
279+
280+
:Author: Android team at Google
281+
:URL: https://google.github.io/comprehensive-rust/
282+
:Date: Accessed Sep 13 2024
283+
:Keywords: rust, blog.
284+
:Description: From the website: "The course covers the full spectrum
285+
of Rust, from basic syntax to advanced topics like generics and
286+
error handling".
287+
288+
* Title: **The Embedded Rust Book**
289+
290+
:Author: Multiple contributors, mostly Jorge Aparicio
291+
:URL: https://docs.rust-embedded.org/book/
292+
:Date: Accessed Sep 13 2024
293+
:Keywords: rust, blog.
294+
:Description: From the website: "An introductory book about using
295+
the Rust Programming Language on "Bare Metal" embedded systems,
296+
such as Microcontrollers".
297+
298+
* Title: **Experiment: Improving the Rust Book**
299+
300+
:Author: Cognitive Engineering Lab at Brown University
301+
:URL: https://rust-book.cs.brown.edu/
302+
:Date: Accessed Sep 22 2024
303+
:Keywords: rust, blog.
304+
:Description: From the website: "The goal of this experiment is to
305+
evaluate and improve the content of the Rust Book to help people
306+
learn Rust more effectively.".
307+
308+
* Title: **New Rustacean** (podcast)
309+
310+
:Author: Chris Krycho
311+
:URL: https://newrustacean.com/
312+
:Date: Accessed Sep 22 2024
313+
:Keywords: rust, podcast.
314+
:Description: From the website: "This is a podcast about learning
315+
the programming language Rust—from scratch! Apart from this spiffy
316+
landing page, all the site content is built with Rust's own
317+
documentation tools.".
318+
319+
* Title: **Opsem-team** (repository)
320+
321+
:Author: Operational semantics team
322+
:URL: https://github.com/rust-lang/opsem-team/tree/main
323+
:Date: Accessed Sep 22 2024
324+
:Keywords: rust, repository.
325+
:Description: From the README: "The opsem team is the successor of
326+
the unsafe-code-guidelines working group and responsible for
327+
answering many of the difficult questions about the semantics of
328+
unsafe Rust".
329+
330+
* Title: **You Can't Spell Trust Without Rust**
331+
332+
:Author: Alexis Beingessner
333+
:URL: https://repository.library.carleton.ca/downloads/1j92g820w?locale=en
334+
:Date: 2015
335+
:Keywords: rust, master, thesis.
336+
:Description: This thesis focuses on Rust's ownership system, which
337+
ensures memory safety by controlling data manipulation and
338+
lifetime, while also highlighting its limitations and comparing it
339+
to similar systems in Cyclone and C++.
340+
341+
* Name: **Linux Plumbers (LPC) 2024 Rust presentations**
342+
343+
:Title: Rust microconference
344+
:URL: https://lpc.events/event/18/sessions/186/#20240918
345+
:Title: Rust for Linux
346+
:URL: https://lpc.events/event/18/contributions/1912/
347+
:Title: Journey of a C kernel engineer starting a Rust driver project
348+
:URL: https://lpc.events/event/18/contributions/1911/
349+
:Title: Crafting a Linux kernel scheduler that runs in user-space
350+
using Rust
351+
:URL: https://lpc.events/event/18/contributions/1723/
352+
:Title: openHCL: A Linux and Rust based paravisor
353+
:URL: https://lpc.events/event/18/contributions/1956/
354+
:Keywords: rust, lpc, presentations.
355+
:Description: A number of LPC talks related to Rust.
356+
357+
* Name: **The Rustacean Station Podcast**
358+
359+
:URL: https://rustacean-station.org/
360+
:Keywords: rust, podcasts.
361+
:Description: A community project for creating podcast content for
362+
the Rust programming language.
363+
223364
-------
224365

225366
This document was originally based on:

Documentation/rust/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ more details.
5656
arch-support
5757
testing
5858

59+
You can also find learning materials for Rust in its section in
60+
:doc:`../process/kernel-docs`.
61+
5962
.. only:: subproject and html
6063

6164
Indices

0 commit comments

Comments
 (0)