diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 24dc70f..dd665fc 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -16,6 +16,95 @@ /.markdownlint.jsonc @WDrijver @TuKo1982 /core/cpu-68080/index.md @WDrijver +/core/cpu-68080/prm/ammx-unit.md @WDrijver +/core/cpu-68080/prm/apollo-bit.md @WDrijver +/core/cpu-68080/prm/b-registers.md @WDrijver +/core/cpu-68080/prm/fpu-unit.md @WDrijver +/core/cpu-68080/prm/index.md @WDrijver +/core/cpu-68080/prm/instruction-efficiency.md @WDrijver +/core/cpu-68080/prm/instruction-fusing.md @WDrijver +/core/cpu-68080/prm/instruction-timing.md @WDrijver +/core/cpu-68080/prm/integer-unit.md @WDrijver +/core/cpu-68080/prm/optimizing.md @WDrijver +/core/cpu-68080/prm/pipeline.md @WDrijver +/core/cpu-68080/prm/programming-model.md @WDrijver +/core/cpu-68080/prm/specs.md @WDrijver +/core/cpu-68080/prm/superscalar.md @WDrijver +/core/cpu-68080/prm/trace.md @WDrijver +/core/cpu-68080/prm/ammx/ammx-format.md @WDrijver +/core/cpu-68080/prm/ammx/bfly.md @WDrijver +/core/cpu-68080/prm/ammx/bsel.md @WDrijver +/core/cpu-68080/prm/ammx/c2p.md @WDrijver +/core/cpu-68080/prm/ammx/load.md @WDrijver +/core/cpu-68080/prm/ammx/loadi.md @WDrijver +/core/cpu-68080/prm/ammx/lsdq.md @WDrijver +/core/cpu-68080/prm/ammx/minterm.md @WDrijver +/core/cpu-68080/prm/ammx/pack3216.md @WDrijver +/core/cpu-68080/prm/ammx/packuswb.md @WDrijver +/core/cpu-68080/prm/ammx/padd.md @WDrijver +/core/cpu-68080/prm/ammx/pand.md @WDrijver +/core/cpu-68080/prm/ammx/pandn.md @WDrijver +/core/cpu-68080/prm/ammx/pavgb.md @WDrijver +/core/cpu-68080/prm/ammx/pcmpccb.md @WDrijver +/core/cpu-68080/prm/ammx/pcmpccw.md @WDrijver +/core/cpu-68080/prm/ammx/peor.md @WDrijver +/core/cpu-68080/prm/ammx/pmaxb.md @WDrijver +/core/cpu-68080/prm/ammx/pmaxw.md @WDrijver +/core/cpu-68080/prm/ammx/pminb.md @WDrijver +/core/cpu-68080/prm/ammx/pminw.md @WDrijver +/core/cpu-68080/prm/ammx/pmul.md @WDrijver +/core/cpu-68080/prm/ammx/pmula.md @WDrijver +/core/cpu-68080/prm/ammx/por.md @WDrijver +/core/cpu-68080/prm/ammx/psub.md @WDrijver +/core/cpu-68080/prm/ammx/rex.md @WDrijver +/core/cpu-68080/prm/ammx/store.md @WDrijver +/core/cpu-68080/prm/ammx/storec.md @WDrijver +/core/cpu-68080/prm/ammx/storei.md @WDrijver +/core/cpu-68080/prm/ammx/storeilm.md @WDrijver +/core/cpu-68080/prm/ammx/storem.md @WDrijver +/core/cpu-68080/prm/ammx/storem3.md @WDrijver +/core/cpu-68080/prm/ammx/tex.md @WDrijver +/core/cpu-68080/prm/ammx/trans.md @WDrijver +/core/cpu-68080/prm/ammx/unpack1632.md @WDrijver +/core/cpu-68080/prm/ammx/vperm.md @WDrijver +/core/cpu-68080/prm/fpu/fadd-3op.md @WDrijver +/core/cpu-68080/prm/fpu/fdbcc-l.md @WDrijver +/core/cpu-68080/prm/fpu/fdiv-3op.md @WDrijver +/core/cpu-68080/prm/fpu/fmove-dn.md @WDrijver +/core/cpu-68080/prm/fpu/fmovem.md @WDrijver +/core/cpu-68080/prm/fpu/fmoverz.md @WDrijver +/core/cpu-68080/prm/fpu/fmul-3op.md @WDrijver +/core/cpu-68080/prm/fpu/fpu-format.md @WDrijver +/core/cpu-68080/prm/fpu/fsqrt-3op.md @WDrijver +/core/cpu-68080/prm/fpu/fsub-3op.md @WDrijver +/core/cpu-68080/prm/integer/addiw.md @WDrijver +/core/cpu-68080/prm/integer/addq-bn.md @WDrijver +/core/cpu-68080/prm/integer/bank.md @WDrijver +/core/cpu-68080/prm/integer/bcc-s-plus.md @WDrijver +/core/cpu-68080/prm/integer/bra-s-plus.md @WDrijver +/core/cpu-68080/prm/integer/bsr-s-plus.md @WDrijver +/core/cpu-68080/prm/integer/clr-q.md @WDrijver +/core/cpu-68080/prm/integer/cmp-bn.md @WDrijver +/core/cpu-68080/prm/integer/cmpiw.md @WDrijver +/core/cpu-68080/prm/integer/dbcc-l.md @WDrijver +/core/cpu-68080/prm/integer/extub-extuw.md @WDrijver +/core/cpu-68080/prm/integer/lea-bn.md @WDrijver +/core/cpu-68080/prm/integer/mov3q.md @WDrijver +/core/cpu-68080/prm/integer/move-bn.md @WDrijver +/core/cpu-68080/prm/integer/move-sr.md @WDrijver +/core/cpu-68080/prm/integer/move16.md @WDrijver +/core/cpu-68080/prm/integer/move2.md @WDrijver +/core/cpu-68080/prm/integer/movea-bn.md @WDrijver +/core/cpu-68080/prm/integer/movec.md @WDrijver +/core/cpu-68080/prm/integer/moveh.md @WDrijver +/core/cpu-68080/prm/integer/movex.md @WDrijver +/core/cpu-68080/prm/integer/moviw.md @WDrijver +/core/cpu-68080/prm/integer/movs.md @WDrijver +/core/cpu-68080/prm/integer/movz.md @WDrijver +/core/cpu-68080/prm/integer/movz2.md @WDrijver +/core/cpu-68080/prm/integer/perm.md @WDrijver +/core/cpu-68080/prm/integer/subq-bn.md @WDrijver +/core/cpu-68080/prm/integer/touch.md @WDrijver /core/saga-3d-maggie/index.md @WDrijver /core/saga-audio-arne/index.md @WDrijver /core/saga-dma-anni/index.md @WDrijver diff --git a/.github/workflows/kb-checks.yml b/.github/workflows/kb-checks.yml index f65b031..7bdc267 100644 --- a/.github/workflows/kb-checks.yml +++ b/.github/workflows/kb-checks.yml @@ -22,6 +22,8 @@ jobs: run: python tools/check_frontmatter.py - name: Internal links run: python tools/check_links.py + - name: Generated files match their originals + run: for s in tools/intake/*.py; do python "$s" --check; done - name: Owners are GitHub users run: python tools/check_owners.py env: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d48cf54..29229de 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -269,6 +269,8 @@ Every pull request runs (scripts in `tools/`): - `check_links.py`: internal markdown links point to existing files - `check_owners.py`: every owner is an existing GitHub account - Markdown lint (rules in `.markdownlint.jsonc`) +- `intake/*.py --check`: files generated by document intake match their + original in `sources/official/` (section 11) - Compilation of all `kb:compile` code blocks with ApolloCrossDev (GCC-6.50-Dev, flags as in its Makefile template; see `tools/compile-snippets.sh`) @@ -306,17 +308,24 @@ regenerate. 1. Add or update the original in `sources/official/`, in an editable format such as ODT. PDF is a last resort. -2. Convert it to Markdown, for example with pandoc. -3. Optimize for AI (see below) and split it into knowledge base files in the - right pillar. Every generated file gets: +2. Convert it with a converter script in `tools/intake/`, one per document + (for example `tools/intake/prm68080.py`). The script does the conversion, + the optimization for AI and the split, so an update of the original is + regenerated the same way. Use only the Python standard library. +3. The script splits the result into knowledge base files in the right + pillar (see "Optimized for AI" below). Every generated file gets: - `origin: official` - `owner`: a maintainer - `status: draft` - `generated_from: sources/official/` 4. Open a PR. The maintainer checks the conversion against the original and - sets `status: reviewed` when it is correct. -5. On an update of the original: repeat steps 1–4, and review the diff of - the generated files. + sets `status: reviewed` in a generated file when it is correct. The + converter keeps that status as long as the file's content stays the same, + and generates the file as `draft` again when its content changes. +5. On an update of the original: replace it in `sources/official/`, run the + converter, and review the diff of the generated files in the PR. CI fails + when the generated files do not match the original + (`tools/intake/