Commit d26a219
authored
docs+ffi: fill rsr-template placeholders left from template instantiation (#59)
The repo was scaffolded from rsr-template-repo but several files still
carried unfilled `{{project}}`, `{{PROJECT}}`, `{{BUILD_CMD}}`,
`{{TEST_CMD}}`, `{{LANG_STACK}}`, `{{MUST_INVARIANTS}}`, `{{PACKAGE_NAME}}`,
`{{DEPS}}`, and `{{BUILD_OUTPUT_PATH}}` placeholders. The repo's own
`.machine_readable/agent_instructions/methodology.a2ml` lists `{{PROJECT}}`
and `rsr-template-repo` in its `reject-if-contains` policy, so these were
also active policy violations.
Substitutions:
* `ABI-FFI-README.md`, `ffi/zig/build.zig`, `ffi/zig/test/integration_test.zig`
— `{{project}}` → `valence_shell` (matches the symbol prefix already
exported from `ffi/zig/src/main.zig`); `{{PROJECT}}` → `ValenceShell`
(PascalCase Idris module path). Directory-tree root label fixed to the
actual hyphenated repo name.
* `alkahest-shell-transmuter/*` — same substitutions but scoped to
`alkahest` / `Alkahest` since that subtree is its own subproject.
* `QUICKSTART-DEV.adoc` — populated tech stack, build/test commands
(cross-referenced against the top-level `Justfile` recipes), and
inlined the key MUST invariants from `.machine_readable/MUST.contractile`
rather than leaving a placeholder.
* `QUICKSTART-MAINTAINER.adoc` — populated runtime deps (glibc, optional
Lean/Erlang runtimes), build output paths (`vsh` binary +
`libvalence_shell.{so,a}` + generated header), and substituted
`{{PACKAGE_NAME}}` → `valence-shell` throughout install/config paths.
Also:
* Removed `tests/fuzz/placeholder.txt`, a scorecard placeholder inherited
from rsr-template-repo. Real fuzz infra lives at
`impl/rust-cli/fuzz/fuzz_targets/` (cargo-fuzz) and `.clusterfuzzlite/`,
so the placeholder served only to misrepresent fuzz coverage.
* Updated `TEST-NEEDS.md` FAKE-FUZZ ALERT section accordingly.
* Stripped the leading `{{~ Aditionally delete this line ... ~}}` template
comment from both `ABI-FFI-README.md` files.
The only remaining `{{...}}` strings in the repo are: the legitimate
inline-prose reference to forbidden placeholders inside QUICKSTART-DEV's
invariants list, the `reject-if-contains` policy entry in `methodology.a2ml`
itself, and just-recipe variable references in `impl/ocaml/Justfile` (which
are runtime variables, not template placeholders).1 parent 18e3e3c commit d26a219
13 files changed
Lines changed: 236 additions & 213 deletions
File tree
- alkahest-shell-transmuter
- ffi/zig
- src
- test
- src/abi
- ffi/zig
- test
- tests/fuzz
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
2 | | - | |
3 | | - | |
| 1 | + | |
4 | 2 | | |
5 | 3 | | |
6 | 4 | | |
| |||
26 | 24 | | |
27 | 25 | | |
28 | 26 | | |
29 | | - | |
| 27 | + | |
30 | 28 | | |
31 | 29 | | |
32 | 30 | | |
| |||
39 | 37 | | |
40 | 38 | | |
41 | 39 | | |
42 | | - | |
| 40 | + | |
43 | 41 | | |
44 | 42 | | |
45 | 43 | | |
| |||
50 | 48 | | |
51 | 49 | | |
52 | 50 | | |
53 | | - | |
| 51 | + | |
54 | 52 | | |
55 | 53 | | |
56 | 54 | | |
| |||
67 | 65 | | |
68 | 66 | | |
69 | 67 | | |
70 | | - | |
| 68 | + | |
71 | 69 | | |
72 | 70 | | |
73 | 71 | | |
74 | | - | |
| 72 | + | |
75 | 73 | | |
76 | 74 | | |
77 | 75 | | |
| |||
199 | 197 | | |
200 | 198 | | |
201 | 199 | | |
202 | | - | |
| 200 | + | |
203 | 201 | | |
204 | 202 | | |
205 | 203 | | |
| |||
222 | 220 | | |
223 | 221 | | |
224 | 222 | | |
225 | | - | |
| 223 | + | |
226 | 224 | | |
227 | 225 | | |
228 | | - | |
| 226 | + | |
229 | 227 | | |
230 | 228 | | |
231 | | - | |
| 229 | + | |
232 | 230 | | |
233 | | - | |
| 231 | + | |
234 | 232 | | |
235 | 233 | | |
236 | 234 | | |
237 | | - | |
| 235 | + | |
238 | 236 | | |
239 | 237 | | |
240 | 238 | | |
241 | 239 | | |
242 | 240 | | |
243 | 241 | | |
244 | | - | |
| 242 | + | |
245 | 243 | | |
246 | 244 | | |
247 | 245 | | |
248 | 246 | | |
249 | 247 | | |
250 | | - | |
| 248 | + | |
251 | 249 | | |
252 | 250 | | |
253 | 251 | | |
| |||
264 | 262 | | |
265 | 263 | | |
266 | 264 | | |
267 | | - | |
| 265 | + | |
268 | 266 | | |
269 | | - | |
270 | | - | |
271 | | - | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
272 | 270 | | |
273 | 271 | | |
274 | 272 | | |
275 | 273 | | |
276 | | - | |
| 274 | + | |
277 | 275 | | |
278 | 276 | | |
279 | | - | |
| 277 | + | |
280 | 278 | | |
281 | 279 | | |
282 | | - | |
| 280 | + | |
283 | 281 | | |
284 | 282 | | |
285 | 283 | | |
286 | 284 | | |
287 | 285 | | |
288 | 286 | | |
289 | 287 | | |
290 | | - | |
| 288 | + | |
291 | 289 | | |
292 | 290 | | |
293 | | - | |
| 291 | + | |
294 | 292 | | |
295 | 293 | | |
296 | 294 | | |
297 | 295 | | |
298 | 296 | | |
299 | | - | |
| 297 | + | |
300 | 298 | | |
301 | 299 | | |
302 | 300 | | |
303 | 301 | | |
304 | | - | |
| 302 | + | |
305 | 303 | | |
306 | 304 | | |
307 | 305 | | |
| |||
355 | 353 | | |
356 | 354 | | |
357 | 355 | | |
358 | | - | |
| 356 | + | |
359 | 357 | | |
360 | 358 | | |
361 | 359 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
4 | 2 | | |
5 | 3 | | |
6 | 4 | | |
7 | 5 | | |
8 | 6 | | |
9 | 7 | | |
10 | | - | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
11 | 14 | | |
12 | 15 | | |
13 | 16 | | |
| |||
38 | 41 | | |
39 | 42 | | |
40 | 43 | | |
41 | | - | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
42 | 50 | | |
43 | 51 | | |
44 | 52 | | |
45 | 53 | | |
46 | 54 | | |
47 | 55 | | |
48 | | - | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
49 | 61 | | |
50 | 62 | | |
51 | 63 | | |
| |||
91 | 103 | | |
92 | 104 | | |
93 | 105 | | |
94 | | - | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
95 | 113 | | |
96 | 114 | | |
97 | 115 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
4 | 2 | | |
5 | 3 | | |
6 | 4 | | |
| |||
12 | 10 | | |
13 | 11 | | |
14 | 12 | | |
15 | | - | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
16 | 22 | | |
17 | 23 | | |
18 | 24 | | |
| |||
23 | 29 | | |
24 | 30 | | |
25 | 31 | | |
26 | | - | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
27 | 37 | | |
28 | 38 | | |
29 | 39 | | |
| |||
65 | 75 | | |
66 | 76 | | |
67 | 77 | | |
68 | | - | |
| 78 | + | |
69 | 79 | | |
70 | 80 | | |
71 | | - | |
| 81 | + | |
72 | 82 | | |
73 | 83 | | |
74 | 84 | | |
| |||
80 | 90 | | |
81 | 91 | | |
82 | 92 | | |
83 | | - | |
| 93 | + | |
84 | 94 | | |
85 | | - | |
| 95 | + | |
86 | 96 | | |
87 | 97 | | |
88 | 98 | | |
| |||
102 | 112 | | |
103 | 113 | | |
104 | 114 | | |
105 | | - | |
| 115 | + | |
106 | 116 | | |
107 | 117 | | |
108 | 118 | | |
| |||
117 | 127 | | |
118 | 128 | | |
119 | 129 | | |
120 | | - | |
121 | | - | |
| 130 | + | |
| 131 | + | |
122 | 132 | | |
123 | 133 | | |
124 | 134 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
73 | | - | |
| 73 | + | |
74 | 74 | | |
75 | | - | |
76 | | - | |
77 | | - | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
0 commit comments