Repository navigation
Commit a2acaac
docs: MakefileContract: what goes in RESULTS_DIR, OBJECTS_DIR, REPORTS_DIR and LOG_DIR
The four directories exist for the reader: one directory would work for
the flow, but when the directory says what a file is for, a user finds
the result a later stage reads, the log of a failed step or the report
to look at without reading the Makefile. The rules were unwritten, and
files on master break them: route.guide and maze.log sit in RESULTS_DIR
although no stage reads them, klayout.lyt sits in OBJECTS_DIR although
the final stage reads it.
The contract now says what each directory holds, with the edge cases
named: a stage is a numbered stage, not a make target; a file that can
affect the flow is a result even when a person also reads it; a file
that only suggests a change is a report; a cache a stage falls back from
is the stage's own; a stage's metrics .json stays next to its log.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>1 parent 64939f3 commit a2acaac
1 file changed
Lines changed: 24 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
138 | 138 | | |
139 | 139 | | |
140 | 140 | | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
0 commit comments