Files
LithosAnanake/tools/README.md
T
rajamesandJunie a8b70e88d3 Reorganize source tree: kernel/, v3/, v4/ split and board infrastructure
Source tree reorganization:
- Move StarForth v3 engine to v3/ (src/, include/, Makefile)
- Move kernel to kernel/ (src/, include/, linker/, Makefile)
- Create v4/ skeleton for F18-ISA golden model (DECOMPOSITION.md, JUSTIFICATION.md)
- Move FABRIC-0..4.md to docs/fabric/
- Move ONTOLOGY.md and ROADMAP.md to docs/

Board infrastructure:
- Add boards/ser5/, boards/raspi/, boards/milkv/, boards/zynq7020/
- Each board has board.mk (ISA, CPU flags, boot recipe) and README.md
- Root Makefile becomes thin dispatcher: boot_image, all, clean, docs take TARGET
- make boot_image TARGET=SER5|RASPI|MILKV builds one GPT/MBR image per board
- ZYNQ7020 target exists but stops with clear error (ARMv7 port not built yet)
- scripts/mkdiskimage.sh builds disk images for all boards

Docs pipeline:
- docs/book/ with LaTeX master (main.tex) and Makefile
- pandoc converts Markdown to LaTeX at build time
- Two Lua filters: table-widths.lua (wide tables wrap), code-breaks.lua (inline code breaks)
- make docs builds single PDF (754 pages, 0 missing characters)
- make docs TARGET=<board> adds board appendix
- build/docs/<book|board>/meta.tex stamps git commit into PDF

Bug fixes:
- 42 include paths that only worked by accident now use correct relative paths
- clang-18 hardcode replaced with configurable CC variable (fixed aarch64 build)
- Pi 5: kernel_2712.img linked at 0x80000, .bss zeroed, memory reserved
- Doxyfile, .clang-tidy, README.md, Kconfig paths updated

Verified:
- Hosted v3 build passes 1012 tests, 0 failures
- SER5 image boots in QEMU (OVMF), POST passes, K exact (65536 = Q48_ONE)
- Milk-V image boots in QEMU (OpenSBI + U-Boot + bootefi), POST passes
- make clean TARGET=<board> removes only that board and its ISA objects
- make all builds all boards, hosted v3, and docs in one run

Co-authored-by: Junie <junie@jetbrains.com>
2026-10-01 15:40:09 -04:00

38 lines
1.8 KiB
Markdown

# tools/
Build-time and integration-test utilities for the StarForth / LithosAnanke
toolchain.
## Contents
| File | Purpose |
|------|---------|
| `mkcapsule.c` | Assembles `.4th` capsule files into `capsule_generated.c` baked into the kernel image. Invoked automatically by `kernel/Makefile`. |
| `mkcapsule` | Compiled host binary (rebuilt on demand). |
| `ttftest.c` | Host TTF glyph-rendering test — font rasterization unit tests, no QEMU needed. |
| `pe_reloc_gen.py` | Generates PE32+ relocation tables for the UEFI loader. |
| `svg_to_png.py` | Renders every tracked `.svg` in the repo to a same-named `.png` via headless Chromium; leaves the source `.svg` untouched, run manually. |
| `hermes_smoke.sh` | Hermes v1 hosted smoke test — swaps in the Hermes init capsule and prints values for manual inspection. |
| `hermes_channel_smoke.sh` | Exercises the full Hermes channel-negotiation lifecycle (`CH-REQUEST` → `CH-ACCEPT` → `CH-CLOSE` → reap) per the protocol in `.claude/HERMES.md`. |
| `hermes_tripod_smoke.sh` | Full Tripod integration test — exercises all 6 inter-VM message paths using the `DEFER VM-EXEC`/`IS VM-EXEC` dispatcher shim from `init.4th`. |
| `kconfig/` | Vendored Linux kernel Kconfig tooling (`conf`/`mconf`/`qconf`), GPL-2.0. See `tools/kconfig/README.md`. |
## mkcapsule
```bash
# Invoked automatically by the kernel build:
make -f kernel/Makefile ARCH=amd64 clean qemu
# Manual invocation (for inspection):
./tools/mkcapsule capsules/ build/amd64/kernel/capsule_generated.c
```
Scans `capsules/` for `.4th` files, computes XXHash64 per capsule, assigns
type `(m)` to `init.4th` and `(p)` to everything else.
## See also
- [`capsules/README.md`](../capsules/README.md) — capsule file format and block namespace
- [`kernel/Makefile`](../kernel/Makefile) — kernel build system
- [Project root](../README.md)