docs: four directories, and a rule for when a thing leaves the roadmap

docs/ was ten files where a plan, a description, a guide and a bug report all
sat next to each other. It is now architecture/ (what SchOS is), plan/ (what it
will be), guides/ (how to work on it) and history/ (why it is like this), with
an index that states the one rule holding it together: when something is
finished it moves from plan/ to architecture/ and is rewritten as a description
of the thing rather than a record of building it.

A ticked checkbox says the work happened. It does not say what the work
*produced*, and six months later the checkbox is all that is left. The network
stack proved the point: finished, verified end to end, and for a month the only
description of it anywhere was a checkbox four levels of indentation deep.

So roadmap.md went from 534 lines to 181 -- nothing deleted, the done work
graduated. Seven subsystems that were finished and undescribed now have
descriptions: boot, kernel, syscalls, filesystem, networking, graphics, usb,
init. Every one ends with "What it does not do", which is the section that pays;
a document listing only strengths is marketing, and the reader who needs it most
is the one about to trip over a limitation nobody wrote down.

schfs.md still opened with "phases 1 through 3 1/2 are done, phase 4 is next"
long after all five had landed. It is a description now, with the phase record
and the hard-won bugs moved to history/.

Three corrections found on the way, all load-bearing:

  * projects/schcom/README.md claimed SCM_RIGHTS was done. There is no
    sendmsg/recvmsg in the kernel at all, and an entire GUI plan rested on it.
  * The root README said "No TCP/IP" months after the stack landed.
  * history/kernel.md sec.7 was marked "in progress" on a problem that process
    groups solved.

Also adds plan/1.0.md, which draws a finish line so the open list stops being
infinite, and marks schwm/ and schde/ superseded: in Wayland the compositor is
the window manager, so that split dissolves rather than being abandoned.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VQ7Qx8E1q1M1bbCq8QLHS2
This commit is contained in:
Nexoniarz 2026-09-12 17:13:35 +02:00
commit 57aff40228
59 changed files with 3981 additions and 1124 deletions

View file

@ -19,7 +19,7 @@ Fedora 44, Ryzen 5 7000-series, RTX 4050, 16 GB DDR5. The GPU is irrelevant to
the build — QEMU runs headless for tests.
`tools/posix/setup-fedora.sh` installs the toolchain (`--check` to only report).
`docs/moving-to-linux.md` is the procedure. Memory moves with
`docs/history/moving-to-linux.md` is the procedure. Memory moves with
[[schos-memory-sync]]: `import` after arriving, `export` and commit after a
session that learned something.

View file

@ -32,7 +32,7 @@ stays in [[schunix-console-tty]]'s `include/theme.h`; the loader composites it i
for the one rule. 4 bits rather than 8 because the header is included by the
*bootloader*, where size is a boot constraint.
**`STAGE2_SECTORS` was encoded in five places, not the three `docs/layout.md`
**`STAGE2_SECTORS` was encoded in five places, not the three `docs/guides/layout.md`
claimed.** Raising it 24 → 48 to fit the 8 KiB mask proved it: the `dd seek=25`
offset stayed behind and the kernel got written straight over stage2's tail.
The five were `boot/bootasm.S`, `boot/stage2main.c`, the `dd seek=`, and *twice*

View file

@ -32,7 +32,7 @@ the Makefile says so out loud rather than skipping silently. Everything is a
no-op on Linux, so a Linux/VM build still works identically.
**Five latent bugs the move exposed**, all real, none Windows-specific — see
`docs/architecture/kernel-history.md` §8 for the two hardest:
`docs/history/kernel.md` §8 for the two hardest:
1. `kernel.ld` named no `.ltext`/`.ldata`/`.lbss` — with `-mcmodel=large`, LLVM
and GCC 13+ put nearly everything there, and orphan placement put them past

View file

@ -9,7 +9,7 @@ metadata:
---
Built 2026-08-08. `include/device.h` + `kernel/dev/device.c`, readable at
`/proc/devices`. Written up in `docs/drivers.md`. Supersedes the two separate
`/proc/devices`. Written up in `docs/architecture/devices.md`. Supersedes the two separate
arrays in `kernel/drivers/registry.c` as the answer to "what is attached".
**Bus is provenance, class is capability** — keep them separate. `bus` is

View file

@ -42,5 +42,5 @@ undistributable, not just the image. See [[schunix-ramdisk-root-sizing]] and
faulting `rip` to get a function name, then use the fault offset to identify
the exact field. "Null pointer plus 24" alone is nearly useless.
Both lessons are written up in `docs/roadmap.md` Phase 7 and
`docs/architecture/kernel-history.md` §10 and §12, with the program genericised.
Both lessons are written up in `docs/plan/roadmap.md` Phase 7 and
`docs/history/kernel.md` §10 and §12, with the program genericised.

View file

@ -43,7 +43,7 @@ machine with only virtio-gpu boots blind until the kernel is up.
`Refrence/freebsd-src` (spelled that way on disk) is a full FreeBSD checkout,
re-cloned 2026-08-08 after the NetBSD one was deleted for space. Never built,
never in an image; recorded in `docs/layout.md` and `docs/licensing.md` §4.
never in an image; recorded in `docs/guides/layout.md` and `docs/licensing.md` §4.
**It is 2.1 GB** — measured, and the same reason the NetBSD one was deleted.
Only `sys/dev`, `sys/net` and `sys/netinet` have ever been read, so a sparse

View file

@ -11,7 +11,7 @@ metadata:
Restructured Schunix's tree on 2026-08-01. `bt/` became `ports/` (third-party
only, Makefile + patches, nothing else), first-party userland split into `lib/`
(runtime glue) and `cmd/<name>/main.c` (programs), tarballs to `dist/`, and all
generated output to `build/`. Documented in `docs/layout.md`. Verified: full
generated output to `build/`. Documented in `docs/guides/layout.md`. Verified: full
build passes and the image boots to `init: ready (pid 1)`.
**Two traps that bit during this and will bite again:**

View file

@ -44,7 +44,7 @@ add to `NOTICE`, done. Reading Linux to understand hardware is fine;
translating a driver function-by-function produces a derivative work whatever
the identifiers say. Best source of all is the public specification — xHCI,
virtio, AHCI, NVMe, e1000 — which carries no licence on what you write from
it. Recorded in `docs/roadmap.md` §1. See [[schunix-roadmap-and-projects]].
it. Recorded in `docs/plan/roadmap.md` §1. See [[schunix-roadmap-and-projects]].
## fs.c is third-party, and was unattributed until 2026-08-09

View file

@ -28,7 +28,7 @@ appear against a real peer.
The NetBSD clause belongs to **WIDE**, not Berkeley, so the 1999 rescission does
not reach it. Checked FreeBSD's file directly from `raw.githubusercontent.com`;
zero matches for "All advertising materials". Checked lwIP's `COPYING`; likewise
zero. This **reverses** the older assumption in `docs/roadmap.md` that NetBSD
zero. This **reverses** the older assumption in `docs/plan/roadmap.md` that NetBSD
was the intended starting point.
## The porting evidence, which matters more
@ -37,7 +37,7 @@ FreeBSD's `sys/netinet` is not a library. `tcp_input.c` alone is 122 KB and
reaches into mbufs, `epoch(9)`, netisr, VNET, `uma(9)`, sockbufs, inpcb hash
tables and FreeBSD's locking. Taking it means porting FreeBSD's kernel
infrastructure first and finding the TCP underneath — the same conclusion
`docs/roadmap.md` §1 already reached about `sys/dev/usb`.
`docs/plan/roadmap.md` §1 already reached about `sys/dev/usb`.
**lwIP was written for the situation Schunix is actually in:** a small OS with a
raw Ethernet driver and no infrastructure. Port layer is a handful of files, no

View file

@ -9,7 +9,7 @@ metadata:
---
Built 2026-08-08. `kernel/core/qr.c` + `include/qr.h`, the Phase 8 crash channel
(see [[schunix-crash-screen]] and `docs/roadmap.md`).
(see [[schunix-crash-screen]] and `docs/plan/roadmap.md`).
**Wired into the crash screen the same day.** `panic.c` builds a compact payload
and paints a white card on the right of PSOGM. Verified end-to-end with

View file

@ -8,7 +8,7 @@ metadata:
modified: 2026-08-09T20:20:11.342Z
---
**Set out 2026-08-04.** Recorded in `docs/roadmap.md`; the naming and the
**Set out 2026-08-04.** Recorded in `docs/plan/roadmap.md`; the naming and the
split are Nexoniarz's.
Order asked for: USB → GPU → OTF/TTF → network + sockets → GUI → installer.

View file

@ -12,7 +12,7 @@ metadata:
attached". It is aimed at being a **system**: NeXTSTEP/macOS-shaped layering,
with POSIX/Unix kept complete but demoted from identity to *personality*, and a
native higher-level API called **SchAPI** above it. Written up in
`docs/architecture/schapi.md`.
`docs/plan/schapi.md`.
The architecture is borrowed from macOS; the compatibility policy is borrowed
from **Windows** (nothing is ever removed after 1.0). Those are two different

View file

@ -8,7 +8,7 @@ metadata:
modified: 2026-08-08T19:21:20.756Z
---
Both of Nexoniarz's 2026-08-08 reports are **fixed**. `docs/roadmap.md` §3b has
Both of Nexoniarz's 2026-08-08 reports are **fixed**. `docs/plan/roadmap.md` §3b has
the full write-up.
## SMP works

View file

@ -24,7 +24,7 @@ carries the attribution and says which option was taken.
`make usb-ids`. Fetching per build would break offline builds, make the same
source produce different images on different days, and put a third-party web
server on the critical path of `make` — and `dist/` exists precisely so a
rebuild never needs the network (stated in `docs/layout.md`). The file is
rebuild never needs the network (stated in `docs/guides/layout.md`). The file is
committed and carries its own version and date, so what shipped is always
knowable. The update target validates the download (`grep -q "^# Version:"`)
before replacing the cached copy, so a truncated file or an error page cannot

View file

@ -115,4 +115,4 @@ drains the event ring by hand — that is what separates "no event" from
"event, no interrupt". `echo s > /proc/sysrq` reads block 1 off the USB disk
through the buffer cache.
**Still not done:** hubs. See `docs/roadmap.md` phase 1.
**Still not done:** hubs. See `docs/plan/roadmap.md` phase 1.