From 1d81c3a74ea814841969152c1faebbcb99766cc2 Mon Sep 17 00:00:00 2001 From: Yu Watanabe Date: Tue, 8 Jul 2025 13:52:03 +0900 Subject: [PATCH] docs: mention src/include/ directories --- docs/ARCHITECTURE.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index ff6c8975d56..33bd992ae9c 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -20,6 +20,9 @@ There are many, and more are constantly added, so we will not enumerate them all The code that is shared between components is split into a few directories, each with a different purpose: +- 'src/include/uapi/' contains copy of kernel headers we use. + 'src/include/override/' contains wrappers for libc and kernel headers, to provide several missing symbols. + - `src/basic/` and `src/fundamental/` — those directories contain code primitives that are used by all other code. `src/fundamental/` is stricter, because it used for EFI and user-space code, while `src/basic/` is only used for user-space code. The code in `src/fundamental/` cannot depend on any other code in the tree, and `src/basic/` can depend only on itself and `src/fundamental/`. @@ -43,6 +46,12 @@ Any code that is used only for EFI goes under `src/boot/efi/`, and `src/fundamen To summarize: +`src/include/uapi/` +- copy of kernel headers + +`src/include/override/` +- wrappers for libc and kernel headers + `src/fundamental/` - may be used by all code in the tree - may not use any code outside of `src/fundamental/` -- 2.47.3