summaryrefslogtreecommitdiffhomepage
path: root/dlang
diff options
context:
space:
mode:
Diffstat (limited to 'dlang')
-rw-r--r--dlang/README.md25
1 files changed, 19 insertions, 6 deletions
diff --git a/dlang/README.md b/dlang/README.md
index 711c770..262162f 100644
--- a/dlang/README.md
+++ b/dlang/README.md
@@ -10,6 +10,7 @@ The abstraction's model and both its loaders, as a dub library.
| `ocda.load_ssp` | text -> model |
| `ocda.load_db` | sqlite -> model |
| `ocda.load` | what a path is, and loading it |
+| `ocda.dump` | the model written out canonically, as an oracle |
| `ocda.sqlite` | the sqlite3 C API, declared rather than depended upon |
`ocda.model` importing nothing is the property that matters: a writer
@@ -30,20 +31,32 @@ foreach (obj; doc.body) { ... }
Link `sqlite3`; the library declares the dozen functions it needs rather
than taking a binding from the registry, so there is nothing to fetch.
-## The agreement check
+## The two checks
```sh
-nix build
-./result/bin/ocda-agree <doc>.ssp <doc>.ocda.db [lang]
+nix build .#ocda-agree && ./result/bin/ocda-agree <doc>.ssp <doc>.ocda.db [lang]
+nix build .#ocda-dump && ./result/bin/ocda-dump [--unknown] <file> [lang]
```
-`test/agree.d` is the whole of it: load both, compare the models. It is the
-library's reason to exist, put to the question.
+`agree` loads both and compares ten fields of each object, naming the field
+where they part company. `agree` found the blank-first-text-line defect and
+was not enough for anything subtler.
+
+**`ocda-dump` is the stronger check**: the whole loaded model, every field,
+written out in a form fully determined by the model, so that two
+implementations can be compared with `diff`. It is an oracle, not an output
+format; anything reading it to reconstruct a document has misunderstood it.
+It agrees byte for byte with the Gleam library's `ocda-lib dump`, which is
+the point of having it.
+
+It found four disagreements `agree` could not see. They are in the
+repository README and in the history.
## Build
```sh
-nix build # the agreement check
+nix build .#ocda-agree # the agreement check
+nix build .#ocda-dump # the canonical dump
nix develop # ldc, dub, dtools, sqlite
dub build # the library
```