linux-kernel - [PATCH] Documentation: Add a source tree map overview

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <CAKg96b=n1pZi4FUBqe+puUJo9ndRfU8npvo9w6fE6Enshe73Hg@mail.gmail.com>
Date: Sun, 1 Jun 2025 12:22:53 -0400
From: William Raezer <wraezer@...il.com>
To: linux-doc@...r.kernel.org
Cc: linux-kernel@...r.kernel.org, corbet@....net
Subject: [PATCH] Documentation: Add a source tree map overview

Hello,

My name is William Raezer, and this is my first contribution to the Linux
kernel. I'm submitting a simple but hopefully helpful addition: a
high-level map of the Linux kernel source tree as a new document in
`Documentation/source-map.rst`.

As someone beginning to explore the internals of the Linux kernel, I
noticed that while there is some documentation available that describes the
subsystems in principle, there's no centralized overview of the source tree
structure itself. This patch adds a basic source map that describes the
role of each top-level directory in the kernel source.

The goal is to assist both myself and others in navigating the codebase,
especially new contributors who may be overwhelmed by the kernel's size and
complexity. As a follow-up, I plan to add subsystem-level maps for key
directories such as `kernel/`, `mm/`, and `fs/`.

I hope this addition is seen as a positive and useful step, and I’m open to
feedback or suggestions to improve it.

Best regards,
William Raezer
wraezer@...il.com

Signed-off-by: William Raezer <wraezer@...il.com>

-- 
"If you don't have something nice to say, at least be creative."
--Madilyn Bailey

Content of type "text/html" skipped

View attachment "0001-Documentation-Add-a-source-tree-map-overview.patch" of type "text/x-patch" (2751 bytes)