The header scan (Captain Bob, 2026-11-10): 788 source files -- 351 with the
SL-1.0 header, 12 with the old name (docs/working/experiments, kept by
ruling), 31 under someone else's licence (tools/kconfig, Linux's, GPL-2.0:
kept), and 394 with none. Ruled: the SPDX form; capsules (.4th, .f18) and
proofs (.thy) left for a ruling of their own (mkcapsule's 64x16 block format,
content-addressed capsules).
253 files now begin
SPDX-License-Identifier: LicenseRef-Starship-1.0
Copyright (c) 2023-2026 Robert A. James
as a /* */ block (C, headers, assembly, linker scripts) or # lines (scripts,
Makefiles, Kconfig; below a shebang or a coding line); tools/mkcapsule.c,
which had the copyright line, gets the SPDX line only.
Not touched: docs/working/ (archive and old campaign material, as the
ruling kept the experiments); v4/system/post_cases.c (generated by
v4/tools/mkpost.py, "do not edit" -- the generator has the header).
Comments only: the kernel builds on amd64, aarch64, riscv64; make -C v4
test-32: 39 programs, 0 failures; every changed script parses.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GE3SDvQn5EoxdGufk84zz2
docs/book/
make docs builds one PDF, build/docs/LithosAnanke.pdf, from main.tex with xelatex.
make docs TARGET=<board> builds build/docs/LithosAnanke-<board>.pdf: the same book with
boards/<board>/README.md added as an appendix.
Tools: sudo apt-get install -y pandoc latexmk texlive-xetex texlive-latex-extra texlive-pictures texlive-fonts-recommended fonts-dejavu fonts-dejavu-extra
Without root, a user-local TeX Live works too (this is how the book was first built):
TinyTeX (curl -sL https://yihui.org/tinytex/install-bin-unix.sh | sh) plus
tlmgr install latexmk xetex fontspec pgf pgfplots booktabs multirow fancyvrb fvextra lineno upquote ulem enumitem newunicodechar bookmark hyperref geometry xcolor graphics tools etoolbox fancyhdr truncate amsfonts,
and the pandoc release tarball unpacked into ~/.local.
The installed DejaVu decides italics: fonts-dejavu-core alone has no serif italic, so
main.tex falls back to a slanted upright face; fonts-dejavu-extra gives real italics.
How it fits together
main.texis the master file. It sets the parts and the chapter order.- Chapters that are still Markdown are listed in
Makefile(CHAPTERS, asname:source.md). At build time pandoc converts each one intobuild/docs/gen/<name>.tex, andmain.texincludes it with\input{<name>}. The Markdown stays the source until the chapter is rewritten in LaTeX. At that point the.texmoves into this directory and theCHAPTERSentry is removed. pandoc/highlighting.latexextracts the code-highlighting macros from the installed pandoc, so the macros and the fragments always come from the same pandoc version.- Two Lua filters run on every chapter.
pandoc/table-widths.luagives wide tables proportional wrapping columns, because pandoc's gfm reader leaves column widths unset.pandoc/code-breaks.lualets long inline identifiers and paths break after_ / . - :. Code blocks wrap through fvextra (breaklines). build/docs/<book|board>/meta.texis written on every build. It records the commit (and whether there were uncommitted changes), the date, and the board.
Rule for data
Any figure or table that shows measured numbers is generated from the CSV when the book is built. Numbers are never typed in by hand:
\begin{tikzpicture}
\begin{axis}[xlabel=run, ylabel=K]
\addplot table[col sep=comma, x=run, y=K]{experiments/<campaign>/results.csv};
\end{axis}
\end{tikzpicture}
\datasource{experiments/<campaign>/results.csv}
Use \pgfplotstabletypeset[col sep=comma]{...} for tables. \datasource prints the CSV path
and the commit, so a reader can find the exact file the figure was drawn from. CSV paths are
repo-relative, because xelatex runs from the repo root.
Older pipelines to fold in or retire
These still exist and still have their own targets. Each one needs a decision during the curation pass: move it into this book, or retire it.
| Source | Current target | Produces |
|---|---|---|
docs/formal/vol1-vm-physics, vol2-kernel, vol3-research |
make -C docs/formal vols |
three volume PDFs |
docs/formal/dev-guide, user-guide, cookbook |
make -C docs/formal books |
three practitioner PDFs |
docs/formal/experiments, proofs, ssrn, patent |
make -C docs/formal standalone |
four standalone PDFs |
Doxygen (Doxyfile) |
make -C docs/formal doxygen |
API reference PDF |
scripts/generate-doxygen-appendix.sh |
make -f v3/Makefile api-docs |
AsciiDoc API appendix |
docs/src/internal/formal/*.thy |
make -f v3/Makefile docs-isabelle |
Isabelle report |
scripts/asciidoc-to-latex.sh |
make -f v3/Makefile docs-latex |
docs/latex/ |
docs/SSRN_companion/Math_Companion_SSRN.tex |
make -f v3/Makefile math-companion |
SSRN math companion |