diff options
| author | Kacper Fiedorowicz <kf@efab.pl> | 2026-01-03 18:44:51 +0100 |
|---|---|---|
| committer | Kacper Fiedorowicz <kf@efab.pl> | 2026-01-03 18:44:51 +0100 |
| commit | 6018e17637264a9561b37be699c3d53b6661de23 (patch) | |
| tree | 8546c9fa94358e7d6daaad5f11ac53e61be97ad5 /docs | |
| parent | ab21f339a33abb1144f3c0f5c4285324e7e88392 (diff) | |
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README | 11 | ||||
| -rw-r--r-- | docs/boot.txt | 15 | ||||
| -rw-r--r-- | docs/fs.txt | 30 | ||||
| -rw-r--r-- | docs/initrd.txt | 10 |
4 files changed, 66 insertions, 0 deletions
diff --git a/docs/README b/docs/README new file mode 100644 index 00000000..caceec3f --- /dev/null +++ b/docs/README @@ -0,0 +1,11 @@ +Documentation +============= + +There are some tiny documents how openlinux is designed. +Is not another copy of wikipedia, how things work, but +collection of base things and useful sources. + +docs/ + boot.txt - boot procedure design + fs.txt - filesystem layout + initrd.txt - initramfs layout diff --git a/docs/boot.txt b/docs/boot.txt new file mode 100644 index 00000000..eddb09b9 --- /dev/null +++ b/docs/boot.txt @@ -0,0 +1,15 @@ +BOOT +==== + +Openlinux for now supports only uefi based booting. +Kernel bzImage must have efi stub (1) option enabled, +and placed in correct path (2). The uefi starts image, +kernel does it startup procedures, then mounts our initrd (3), +and parses bootconfig.txt (3), next init (4) is called. +Init program mounts kernel virtual filesystems and switches to real root partition, then +runs real init system. + +(1) - https://www.kernel.org/doc/html/latest/admin-guide/efi-stub.html +(2) - See docs/fs.txt +(3) - See docs/initrd.txt +(4) - https://www.kernel.org/doc/html/latest/admin-guide/bootconfig.html diff --git a/docs/fs.txt b/docs/fs.txt new file mode 100644 index 00000000..c6617df0 --- /dev/null +++ b/docs/fs.txt @@ -0,0 +1,30 @@ +FILESYSTEM +========== + +Openlinux filesystem is designed to be as handy as possible. + +┌── bin/ +│ └── (System binaries) +│ +├── efi/ (separate parition can be mounted at /boot) +│ └── boot/ +│ ├── bootx64.efi (1) +│ └── initrd (2) +│ +├── lib/ +│ └── (System libraries) +│ +├── usr/ +│ ├── include/ +│ │ └── (System headers) +│ │ +│ ├── local/ +│ │ ├── bin/ +│ │ │ └── (User binaries) +│ │ ├── lib/ +│ │ │ └── (User libraries) +│ │ └── include/ +│ │ └── (User headers) + +(1) - https://www.kernel.org/doc/html/latest/admin-guide/efi-stub.html +(2) - https://www.kernel.org/doc/html/latest/admin-guide/initrd.html diff --git a/docs/initrd.txt b/docs/initrd.txt new file mode 100644 index 00000000..ca0c646f --- /dev/null +++ b/docs/initrd.txt @@ -0,0 +1,10 @@ +INITRD +====== + +Initrd contains two files: + +- bootconfig.txt (1) +- init (2) + +(1) - https://docs.kernel.org/admin-guide/bootconfig.html +(2) - See boot.txt |