Skip to content

Commit 2dbba37

Browse files
author
Pierre Granger
committed
Commit the design of following SPINE releases, as built
docs/designs/following-spine-releases.md is the design that pull requests 1 to 6 implemented: the library's version, the tests that survive expected SPINE changes, the fixture tooling for any tag, the dumper's new keys, the classifier and follow_spine.py, and CI. Its companion following-spine-releases.cafmaker-fields.tsv lists the 228 model fields the three CAFMakers read, from which tests/test_contracts.cpp was written. Updated before committing: - Status: implemented, in pull requests 1 to 6; v0.1.0 on the merge commit of pull request 2. - G2 and the v1.4.91 row (R8): a new NuInteractionScheme member needs its interaction tables in SPINE's Neutrino.resolve_enum, or the dumper stops with "cannot identify the enum of interaction_mode under ..." (checked on a copy of v1.4.0 with a member and no tables). - The table of open points R1-R16 says how each was fixed. - A new section, "As built", records where the code differs from the plan, pull request by pull request, and what the verification reached. The root EGM.md and the README index the new folder.
1 parent 2340b2f commit 2dbba37

4 files changed

Lines changed: 2213 additions & 0 deletions

File tree

‎EGM.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,13 @@ Build and packaging (`CMakeLists.txt`):
8686
`project(VERSION)`), `sanitize.sh` (ASan/UBSan or TSan on EL9) and `sl7-ups.sh` (SL7 container,
8787
UPS gcc 12 and HDF5 1.12.2).
8888
- tests (not documented by contract): doctest unit tests and the test data under `tests/data/`.
89+
- docs: design documents, prose only, no contract file.
90+
[./docs/designs/following-spine-releases.md](./docs/designs/following-spine-releases.md) is
91+
the design that pull requests 1 to 6 implemented: the library's version, the tests that
92+
survive expected SPINE changes, the fixture and release tooling, and CI. Its section "As
93+
built" records where the code differs from the plan. The companion
94+
`following-spine-releases.cafmaker-fields.tsv` lists the 228 model fields the CAFMakers read,
95+
from which `tests/test_contracts.cpp` was written.
8996

9097
## Global Invariants
9198

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Status: under construction.
3636
| `tools/fixtures/` | Writes the test files in `tests/data/` with SPINE's own writer, plus expected values. |
3737
| `tools/release/` | Tooling for following SPINE releases: `follow_spine.py` runs one SPINE tag end to end, `classify.py` proposes the version bump, `scan_consumer_fields.py` lists the model fields a CAFMaker build reads ([README](tools/release/README.md)). |
3838
| `tests/` | doctest unit tests (`test_*.cpp`). |
39+
| `docs/designs/` | Design documents: [following SPINE releases](docs/designs/following-spine-releases.md) (the version, the tests, the fixture and release tooling, CI), with the table of the model fields the CAFMakers read. |
3940

4041
## Build
4142

0 commit comments

Comments
 (0)