Skip to content

Commit fdb0f1c

Browse files
committed
docs: scope the evidence spec to what a producer writes
The page claimed the pydantic models were the normative definition of the whole format. They are not: they forbid the inspection key, so they reject a file DVPlan accepts. That is correct for a writer, but it makes the claim wrong. AI-assisted (Claude Code) — reviewed and approved by author Signed-off-by: martin-velay <mvelay@lowrisc.org>
1 parent f1726da commit fdb0f1c

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

doc/dv_evidence.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A verification plan asks a different question: of everything we said we would ve
1010
Answering it needs the regression's own outcomes in a form a planning tool can read, rather than a log directory and a human.
1111

1212
This is that form.
13-
DVSim writes one of these files per simulation flow, and it is the definition of the format rather than a description of one tool's output.
13+
DVSim writes one of these files per simulation flow, and this page specifies what any producer has to write rather than describing one tool's output.
1414
Anything that can produce it can be scored against a verification plan, whether or not it is DVSim.
1515

1616
## Where DVSim writes it
@@ -88,5 +88,7 @@ It is not the only thing that could: the format carries no DVPlan concepts, and
8888

8989
## Changing it
9090

91-
The pydantic models in `src/dvsim/report/dv_evidence.py` are the normative definition, and this document describes them.
92-
A change to either is a change to the format, so change both, and bear in mind that a consumer may be reading files this repo wrote months ago.
91+
The pydantic models in `src/dvsim/report/dv_evidence.py` specify what a producer writes, and this document describes them.
92+
They are not the whole format: the `inspection` half and the rules for scoring a file are the consumer's, and [DVPlan](https://github.com/lowRISC/dvplan) specifies those.
93+
So the models here reject a file carrying an `inspection` key, which is correct, since DVSim writes evidence and never reads it back.
94+
A change to the models or to this document is a change to the format, so change both, and bear in mind that a consumer may be reading files this repo wrote months ago.

0 commit comments

Comments
 (0)