| Filename | Latest commit message | Latest commit date |
|---|---|---|
4e3e345b41
`∞`, `→`, `≤` and `'` could not be typed. `ą` and `ę` could. That pairing is
the whole diagnosis: KBD_UP was 0xE2 and its neighbours filled 0xE0..0xE9,
which are exactly the UTF-8 lead bytes for three-byte characters. Every
character in U+0800..U+FFFF -- most punctuation, every arrow, every maths
symbol, the whole of CJK -- arrived as a value the console read as an arrow key
and helpfully turned into `ESC [ A`. Two-byte sequences lead with 0xC4 and
nothing claimed 0xC4, so Polish came through and the rest did not.
The chord codes already knew this rule and said so in a comment. The navigation
keys predate them and were never brought in line. Stated once, in kbd.h: a key
produces either a Unicode codepoint or a value above 0x10FFFF, and nothing in
between means anything. KEY_* -> KBD_*, which also settles a silent collision
-- include/input.h defines its own KEY_HOME, KEY_UP and KEY_END as evdev
numbers, and kbd.c includes both headers, so three macros were being quietly
redefined in the one file that used them.
Then the layouts, which is what the codepoint-sized keycodes were for.
kernel/dev/keymap.c: us, pl, de. A layout is four tables -- plain, Shift,
AltGr, Shift+AltGr -- of uint32 codepoints. uint32 and not uchar is the reason
the file exists: `ó` fits in a byte and `ą` does not, and half a Polish
alphabet is not a Polish layout.
Two things deliberately are *not* tables:
- **Ctrl is derived from the plain codepoint.** The table it replaces was
indexed by scancode, which quietly assumed US -- on QWERTZ the Y and Z keys
swap, so Ctrl+Z would have suspended a job only on some layouts.
- **Caps Lock is a case toggle on the result**, so AltGr+a with Caps Lock is
`Ą`. No second table could say that, because Caps Lock combines with AltGr
rather than replacing it. Latin Extended-A alternates upper/lower by
codepoint but not all the same way round -- Ł is U+0141 (odd) and Ą is
U+0104 (even) -- so Polish lands in both halves and the parity matters.
kbdgetc() encodes to UTF-8 and returns the bytes one call at a time.
consoleintr()'s contract is bytes: the serial line hands it UTF-8 already and
it could not tell an encoded codepoint from a byte of the same value.
The layouts live in the kernel. Linux's loadkeys compiles a text keymap and
uploads it a key at a time through KDSKBENT, which puts the data in userspace
-- and a machine whose /usr has not mounted then has no layout at all. Here the
kernel always has a working keyboard and `loadkeys` only names which one.
KB_GETLAYOUT/KB_SETLAYOUT/KB_LISTLAYOUT; /etc/vconsole.conf and an
os.schos.keymap job for the boot-time choice. No dead keys, so French and
Spanish are absent rather than wrong.
/etc/locale.conf and LANG=C.UTF-8 in profile and zshenv. Only the charset half
of that is real -- musl decodes UTF-8 whatever the locale says and ships no
locale data -- but an unset LANG reads as "ASCII only" to everything that asks,
which is its own way of producing `?`.
And two symlink bugs found while chasing
zsh: locking failed for /root/.zsh_history: operation not permitted
on every boot. symlink() is the classic atomic lock -- create the link, and if
it exists someone else holds it -- and zsh distinguishes EEXIST ("contended,
retry") from anything else ("this cannot work, give up"). sys_symlink returned
a bare -1, which is -EPERM, so every zsh on the machine took the second branch
on a filesystem that supports symlinks perfectly well. Same errno class as
commit
|
||
| .. | ||
| architecture | ||
| branding | ||
| guides | ||
| history | ||
| plan | ||
| Website | ||
| licensing.md | ||
| README.md | ||
SchOS documentation
Four kinds of document, kept in four directories, because they answer four different questions and go stale at four different rates.
| architecture/ | What SchOS is | Present tense. Describes what is built and working. |
| plan/ | What SchOS will be | Future tense. Everything here is unbuilt. |
| guides/ | How to work on it | Imperative. Build it, test it, add to it. |
| history/ | Why it is the way it is | Past tense. Bugs whose cause is not visible from the fix. |
Plus two that belong to no category and apply to everything: licensing.md — read it before copying anyone else's code in — and branding/, which holds the marks and the rules for using them.
The rule that keeps this from rotting
When something is finished, it moves from
plan/toarchitecture/and is rewritten as a description of the thing rather than a record of building it.
A completed item is not a ticked checkbox. A ticked checkbox says the work happened; it does not say what the work produced, and six months later the checkbox is the only thing left and it explains nothing.
So finishing a piece of work has three steps, and the third is not optional:
- The code works and is tested.
- The plan entry is deleted.
- A description exists in
architecture/written for somebody who was not there — what it does, what shape it has, what it costs, and what it still does not do.
This is not bookkeeping. The tree has already proved it necessary: the network stack was finished, verified end to end, and for a month afterwards the only description of it anywhere was a checkbox in a roadmap, four levels of indentation deep, written in the past tense of somebody arguing for the work rather than explaining the result.
The "what it does not do" section is the one that pays. Every description in
architecture/ ends with one. A document that only lists a subsystem's
strengths is marketing, and the reader who most needs the document is the one
about to trip over a limitation nobody wrote down.
Start here
New to the tree → architecture/README.md, the system layer by layer, then guides/layout.md for where the files are.
Trying to build it → guides/building.md.
Wondering what happens next → plan/1.0.md, which is the finish line and the register of everything half-built. Then plan/README.md for the order.
About to start something new → the register, first. Nothing new starts while it has rows in it, and a row leaves only by being finished or deleted.
Something is broken and it feels familiar → history/. There is a good chance it is in there.
architecture/ — what SchOS is
| README | The system, layer by layer. Read first. |
| boot.md | Firmware to the first userspace process. |
| kernel.md | SchIFT: memory, processes, scheduling, traps, signals, SMP. |
| syscalls.md | The call table, and the Linux personality that lets real software run. |
| filesystem.md | The VFS, the buffer cache, procfs, mounts. |
| schfs.md | SchFS: the copy-on-write root filesystem. |
| devices.md | The device model, driver binding, the class vtables. |
| usb.md | xHCI, the USB core, and the class drivers. |
| graphics.md | Framebuffer, text rendering, console, and the crash screen. |
| terminals.md | The six virtual terminals, and how one is switched to. |
| networking.md | Drivers, lwIP, sockets — Unix and INET. |
| init.md | schinit, PID 1 as a role, and the job manifests. |
plan/ — what SchOS will be
| README | The three current decisions and the order they happen in. |
| 1.0.md | The finish line, and the freeze. What 1.0 contains, what is deferred, and the register of every half-built thing in the tree. |
| foundations.md | The kernel work everything else is blocked on. |
| wayland.md | The GUI stack, and what gets deleted to make room. |
| hybrid.md | Moving drivers out of the kernel. |
| schapi.md | The long-term API layering, and the compatibility promise. |
| roadmap.md | Everything else still open. |
guides/ — how to work on it
| building.md | Prerequisites and the build, per host. |
| testing.md | The harnesses, and what each one actually proves. |
| layout.md | Repository map, and how to add a program or a port. |
| adding-a-driver.md | Writing one, binding it, publishing its class vtable. |
branding/ — the marks
| README | Shift the logo, Guru the icon, SchCotie the mascot: what each is for, the colour rule, and why a raster is committed next to its SVG. |
history/ — why it is the way it is
| README | What belongs in here and what does not. |
| kernel.md | Bugs whose cause was nowhere near their symptom. |
| schfs.md | The filesystem's own, from the same period as its design. |
| moving-to-linux.md | The Windows-to-Fedora move, kept for the parts that recur. |
Writing one of these
Four conventions, all of them observable in the existing files:
State the cost. Every design choice gave something up. A document that does not say what is a document that will be argued with later by somebody who only sees the downside.
Prefer the measured number to the remembered one. "500 of 3565 files carry the advertising clause" is worth more than "some do", and it was worth the minute it took to count.
Write down the bug that shaped it. Half the non-obvious code in this tree is non-obvious because something failed once. If a design is strange, the strangeness is load-bearing and the reader deserves to know why before changing it.
No dates in headings. A date in a heading turns a description into a
changelog, and the description is the thing with a long life. Dates belong in
history/, where they mean something.