diff options
Diffstat (limited to 'pipeline/README.md')
| -rw-r--r-- | pipeline/README.md | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/pipeline/README.md b/pipeline/README.md index c5920f7..b5adc84 100644 --- a/pipeline/README.md +++ b/pipeline/README.md @@ -1,13 +1,13 @@ -# The pipeline: how to run the readers, the library and the writers +# The pipeline: how to run the library, its reader and the writers Fixed scripts rather than a test suite. They produce output that is meant to be **looked at**, and they double as the answer to "what do I type?". ``` config.sh where everything is, and where the output goes -build.sh build every reader, library and writer, in both languages +build.sh build the library and the writer, in both languages one.sh one tool, one document - the answer to "how do I run this?" -read.sh every reader and both libraries, over every document +read.sh the library and its reader, over every document write.sh every writer, in both languages, over every document pdf.sh compile the .typ files that write.sh produced run.sh all of the above, in order @@ -20,7 +20,7 @@ document-language and a `.ocda.db` for each document, and, where there is one, a `.sisupod` beside it. That is what spine writes: ```sh -spine --abstraction --ocda-db --pod2 --output=<dir> <pod>... +spine --show-abstraction --ocda-db --pod2 --output=<dir> <pod>... ``` Everything downstream reads those files and nothing else. **No tool here @@ -44,8 +44,6 @@ at something. ## Where the output goes ``` -$OUT/read/ssp-d/ ssp-g/ the .ssp readers' summaries -$OUT/read/db-d/ db-g/ the .ocda.db readers' summaries $OUT/read/dump-d/ dump-g/ the library's dump, from each serialisation $OUT/write/text/{d,g}/ <doc>.txt $OUT/write/md/{d,g}/ <doc>.md @@ -70,8 +68,8 @@ sh pipeline/one.sh read-d <doc>.sisupod en --tree The tool names are `<format>-<language>`: `text`, `md`, `html`, `epub`, `typst` for the writers, `read` for the library's reader (ocda-read, which -reads every form and takes its modes after the file), and `ssp`, `db`, `dump`, -`agree` for the older readers and the library; `-d` for D and `-g` for Gleam. +reads every form and takes its modes after the file), and `dump`, `agree` for +the library; `-d` for D and `-g` for Gleam. Output goes to stdout, so a comparison is a pipeline. The epub and the typst name a file instead, because an epub is a zip and a `.typ` names its images by @@ -86,7 +84,7 @@ typst compile --root d d/x.typ d/x.pdf ## What the counts at the end mean Each stage prints a few numbers. They are not a pass, they are a way to see a -regression without reading 36 documents. +regression without reading every document. | `all four dumps identical` | the library's whole claim: two serialisations, two languages, one model | |---|---| |