kernel-docs: Add book to process/kernel-docs.rst

Add a reference to my new book, The Linux Memory Manager, an in-depth
exploration of the memory management subsystem, to
process/kernel-docs.rst.

Th

kernel-docs: Add book to process/kernel-docs.rst

Add a reference to my new book, The Linux Memory Manager, an in-depth
exploration of the memory management subsystem, to
process/kernel-docs.rst.

This is not yet published, but the full draft is available on pre-order, so
it seems worthwhile adding it here. The situation is made clear in the
'notes' section.

The 'pre-release' was made available in February 2025, and full release is
scheduled for Fall 2025. The book's ISBN-13 is 978-1718504462.

The document will be updated upon release to reflect this.

Signed-off-by: Lorenzo Stoakes <[email protected]>
Reviewed-by: Carlos Bilbao <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
Link: https://lore.kernel.org/r/[email protected]

show more ...

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 resource

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 <[email protected]>
Reviewed-by: Dirk Behme <[email protected]>
Acked-by: Miguel Ojeda <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
Link: https://lore.kernel.org/r/[email protected]

show more ...

Documentation: fix links to mailing list services

There have been some changes to the way mailing lists are hosted at
kernel.org. This patch does the following:

1. fixes links that are pointing at

Documentation: fix links to mailing list services

There have been some changes to the way mailing lists are hosted at
kernel.org. This patch does the following:

1. fixes links that are pointing at the outdated resources
2. removes an outdated patchbomb admonition

We still don't particularly want or welcome huge patchbombs, but they
are less likely to overload our systems.

Acked-by: Dan Williams <[email protected]>
Signed-off-by: Konstantin Ryabitsev <[email protected]>
Reviewed-by: Carlos Bilbao <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
Link: https://lore.kernel.org/r/20240619-docs-patch-msgid-link-v2-1-72dd272bfe37@linuxfoundation.org

show more ...

docs: Extend and refactor index of further kernel docs

Extend the Index of Further Kernel Documentation by adding entries for the
Rust for Linux website, the Linux Foundation's YouTube channel, and

docs: Extend and refactor index of further kernel docs

Extend the Index of Further Kernel Documentation by adding entries for the
Rust for Linux website, the Linux Foundation's YouTube channel, and notes
on the second edition of Billimoria's kernel programming book. Also,
perform some refactoring: format the text to 75 characters per line and
sort per-section content in chronological order of publication.

Signed-off-by: Carlos Bilbao <[email protected]>
Tested-by: Randy Dunlap <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

Documentation: Fix typos

Fix typos in Documentation.

Signed-off-by: Bjorn Helgaas <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jon

Documentation: Fix typos

Fix typos in Documentation.

Signed-off-by: Bjorn Helgaas <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

docs: Add book to process/kernel-docs.rst

Include to process/kernel-docs.rst a book on Linux system administration
published in May, 2023 (with ISBN 978-1098109035).

Signed-off-by: Carlos Bilbao <c

docs: Add book to process/kernel-docs.rst

Include to process/kernel-docs.rst a book on Linux system administration
published in May, 2023 (with ISBN 978-1098109035).

Signed-off-by: Carlos Bilbao <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
Link: https://lore.kernel.org/r/[email protected]

show more ...

docs: Add relevant kernel publications to list of books

For the list of kernel published books, include publication covering kernel
debugging from August, 2022 (ISBN 978-1801075039) and one from Mar

docs: Add relevant kernel publications to list of books

For the list of kernel published books, include publication covering kernel
debugging from August, 2022 (ISBN 978-1801075039) and one from March, 2021
on the topic of char device drivers and kernel synchronization (ISBN
978-1801079518). Also add foundational book from Robert Love (ISBN
978-1449339531) and remove extra spaces.

Co-developed-by: Kaiwan N Billimoria <[email protected]>
Signed-off-by: Kaiwan N Billimoria <[email protected]>
Signed-off-by: Carlos Bilbao <[email protected]>

Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

docs: Add book to process/kernel-docs.rst

Include to process/kernel-docs.rst a book on Linux kernel development
published in 2021 (with ISBN 978-1789953435).

Signed-off-by: Carlos Bilbao <carlos.bi

docs: Add book to process/kernel-docs.rst

Include to process/kernel-docs.rst a book on Linux kernel development
published in 2021 (with ISBN 978-1789953435).

Signed-off-by: Carlos Bilbao <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

docs: Retire old resources from kernel-docs.rst

Remove outdated or obsolete resources from process/kernel-docs.rst, with
the exception of foundational material. Update information regarding
LWN.net.

docs: Retire old resources from kernel-docs.rst

Remove outdated or obsolete resources from process/kernel-docs.rst, with
the exception of foundational material. Update information regarding
LWN.net. See Link below for further context.

Link: https://lore.kernel.org/lkml/[email protected]/
Signed-off-by: Carlos Bilbao <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

docs: Update maintainer of kernel-docs.rst

Set new maintainer of the Index of Further Kernel Documentation (document
process/kernel_docs.rst). See Link for further context. Also remove line
that kee

docs: Update maintainer of kernel-docs.rst

Set new maintainer of the Index of Further Kernel Documentation (document
process/kernel_docs.rst). See Link for further context. Also remove line
that keeps record of last update of the text -this information is already
available elsewhere.

Link: https://lore.kernel.org/lkml/[email protected]/
Reviewed-by: Miguel Ojeda <[email protected]>
Signed-off-by: Carlos Bilbao <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

docs: kernel-docs: add a reference mentioned in submitting-drivers.rst

One section in submitting-drivers.rst was just a collection of references
to other external documentation. All except the one a

docs: kernel-docs: add a reference mentioned in submitting-drivers.rst

One section in submitting-drivers.rst was just a collection of references
to other external documentation. All except the one added in this commit
is already mentioned in kernel-docs or other places in the kernel
documentation.

Add Arjan van de Ven's article on How to NOT write kernel driver to this
index of further kernel documentation.

Signed-off-by: Lukas Bulwahn <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

docs: kernel-docs: reflect that it is community-maintained

Remove and rephrase statements that only make sense if a single author
exclusively would maintain this document, but we would really want t

docs: kernel-docs: reflect that it is community-maintained

Remove and rephrase statements that only make sense if a single author
exclusively would maintain this document, but we would really want to
consider this being a page maintained by the kernel community, as it is
placed in the kernel repository, and let us hope that more contributors
suggest some more documents.

Further, do some minor word-smithing.

Signed-off-by: Lukas Bulwahn <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

docs: kernel-docs: shorten the lengthy doc title

The original title comes from copying the content from a web page that
covered various mixed computer-science material. Within the kernel
documentati

docs: kernel-docs: shorten the lengthy doc title

The original title comes from copying the content from a web page that
covered various mixed computer-science material. Within the kernel
documentation and its current structure, the title can be shortened.

Other titles considered, but not selected were:
- Index of More Kernel Documentation
- Further Kernel Documentation
- References to Further Kernel Documentation

Shorten the title.

Signed-off-by: Lukas Bulwahn <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

docs: kernel-docs: order reference from newest to oldest

The documents on each section of this document are ordered by its
published date, from the newest to the oldest.

In the kernel-docs.rst, the

docs: kernel-docs: order reference from newest to oldest

The documents on each section of this document are ordered by its
published date, from the newest to the oldest.

In the kernel-docs.rst, the references on each section of this document
are intended to be ordered by its published date, from the newest to the
oldest. The Linux Kernel Module Programming Guide was published in 2021;
so, it is placed at the top as the most recent publication after the
rolling-version "Linux Kernel Mailing List Glossary" reference.

Fixes: 630c8fa02f9a ("Documentation: Update details of The Linux Kernel Module Programming Guide")

Signed-off-by: Lukas Bulwahn <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

ASoC: doc: Update dead links

The alsa-project documentation is now part of the kernel docs,
the original links are long dead, update links.

Signed-off-by: Marek Vasut <[email protected]>
Cc: Mark Brown

ASoC: doc: Update dead links

The alsa-project documentation is now part of the kernel docs,
the original links are long dead, update links.

Signed-off-by: Marek Vasut <[email protected]>
Cc: Mark Brown <[email protected]>
Cc: Takashi Iwai <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Mark Brown <[email protected]>

show more ...

Documentation: Update details of The Linux Kernel Module Programming Guide

Recently, the content and examples of the book "The Linux Kernel Module
Programming Guide" are being actively maintained an

Documentation: Update details of The Linux Kernel Module Programming Guide

Recently, the content and examples of the book "The Linux Kernel Module
Programming Guide" are being actively maintained and added on Github[1].
Currently, the book is being regularly built into webpage and pdf
file using Github static page[2].

[1]: https://github.com/sysprog21/lkmpg
[2]: https://sysprog21.github.io/lkmpg/

Signed-off-by: Chun-Hung Tseng <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
[jc: fixed docs-build warnings]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

Documentation: fix typos in process/kernel-docs.rst

Fix two typos in kernel-docs.rst

Signed-off-by: Andrew Klychkov <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Link

Documentation: fix typos in process/kernel-docs.rst

Fix two typos in kernel-docs.rst

Signed-off-by: Andrew Klychkov <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

Replace HTTP links with HTTPS ones: Documentation/process

Rationale:
Reduces attack surface on kernel devs opening the links for MITM
as HTTPS traffic is much harder to manipulate.

Deterministic al

Replace HTTP links with HTTPS ones: Documentation/process

Rationale:
Reduces attack surface on kernel devs opening the links for MITM
as HTTPS traffic is much harder to manipulate.

Deterministic algorithm:
For each file:
If not .svg:
For each line:
If doesn't contain `\bxmlns\b`:
For each link, `\bhttp://[^# \t\r\n]*(?:\w|/)`:
If both the HTTP and HTTPS versions
return 200 OK and serve the same content:
Replace HTTP with HTTPS.

Signed-off-by: Alexander A. Klimov <[email protected]>
Acked-by: Miguel Ojeda <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

docs: kernel-docs: Remove "Here is its" at the end of lines

Before commit 9e03ea7f683e ("Documentation/kernel-docs.txt: convert it
to ReST markup"), it read:

Description: Linux Journal Kerne

docs: kernel-docs: Remove "Here is its" at the end of lines

Before commit 9e03ea7f683e ("Documentation/kernel-docs.txt: convert it
to ReST markup"), it read:

Description: Linux Journal Kernel Korner article. Here is its
abstract: "..."

In Sphinx' HTML formatting, however, the "Here is its" doesn't make
sense anymore, because the "Abstract:" is clearly separated.

Signed-off-by: Jonathan Neuschäfer <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

Documentation: kernel-docs: Remove entry for vfs.txt

It's unnecessary to point to an external mirror of the Documentation
directory.

Jonathan Corbet writes in favor of removing this entry, instead

Documentation: kernel-docs: Remove entry for vfs.txt

It's unnecessary to point to an external mirror of the Documentation
directory.

Jonathan Corbet writes in favor of removing this entry, instead of
moving it under "Docs at the Linux Kernel tree":

> We don't want to turn kernel-docs.rst into yet another out-of-date
> index for the rest of Documentation/, and the removal of the external
> URL takes away the only bit of additional information that this entry
> offers.

Signed-off-by: Jonathan Neuschäfer <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

doc: Change LXR references to elixir.bootlin.com

Recently, Free Electrons was renamed to Bootlin[1]. Less recently, the
Linux Cross Reference (LXR) at lxr.free-electrons.com was replaced by
Elixir[2

doc: Change LXR references to elixir.bootlin.com

Recently, Free Electrons was renamed to Bootlin[1]. Less recently, the
Linux Cross Reference (LXR) at lxr.free-electrons.com was replaced by
Elixir[2], and lxr.free-electrons.com redirected first to
elixir.free-electrons.com and now to elixir.bootlin.com.

[1]: https://bootlin.com/blog/free-electrons-becomes-bootlin/
[2]: https://github.com/free-electrons/elixir

Signed-off-by: Jonathan Neuschäfer <[email protected]>
Reviewed-by: Martin Kepplinger <[email protected]>
Acked-by: Federico Vaga <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

Fix broken link in Documentation/process/kernel-docs.rst

Kernel Glossary has moved from /Glossary to /KernelGlossary
on kernelnewbies.org. This patch corrects this link.

Signed-off-by: Grigory Ship

Fix broken link in Documentation/process/kernel-docs.rst

Kernel Glossary has moved from /Glossary to /KernelGlossary
on kernelnewbies.org. This patch corrects this link.

Signed-off-by: Grigory Shipunov <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

docs: update old references for DocBook from the documentation

DocBook is mentioned several times at the documentation. Update
the obsolete references from it at the DocBook.

Acked-by: SeongJae Par

docs: update old references for DocBook from the documentation

DocBook is mentioned several times at the documentation. Update
the obsolete references from it at the DocBook.

Acked-by: SeongJae Park <[email protected]>
Signed-off-by: Mauro Carvalho Chehab <[email protected]>

show more ...

docs-rst: add documents to development-process

Add several documents to the development-process ReST book.

As we don't want renames, use symlinks instead, keeping those
documents on their original

docs-rst: add documents to development-process

Add several documents to the development-process ReST book.

As we don't want renames, use symlinks instead, keeping those
documents on their original place.

Acked-by: Greg Kroah-Hartman <[email protected]>
Signed-off-by: Mauro Carvalho Chehab <[email protected]>

show more ...