Skip to content

Commit 8d1b1c5

Browse files
docs: backfill README exit tables on the remaining thirteen examples
Inspection-only documentation so every shipped example lists its file-local nonzero codes. No flags, no behavior, no code-value changes. Signed-off-by: TMHSDigital <154358121+TMHSDigital@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent e457a12 commit 8d1b1c5

13 files changed

Lines changed: 281 additions & 30 deletions

File tree

‎examples/coincident-vert-weld/README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,20 @@ blender --background --python coincident_vert_weld.py --
3333
blender --background --python coincident_vert_weld.py -- --no-duplicate
3434
blender --background --python coincident_vert_weld.py -- --weld
3535
```
36+
37+
## Exit codes
38+
39+
Per-script sequential checks. `9` is a valid check code; there is no rule
40+
against it.
41+
42+
| Code | Meaning |
43+
| --- | --- |
44+
| 0 | Success |
45+
| 1 | Uncaught exception (FATAL wrapper) |
46+
| 2 | argparse / usage; also exporter RNA missing expected glTF kwargs |
47+
| 3 | Pathology missing: coincident shells (`--no-duplicate` lands here) |
48+
| 4 | glTF export handling failed (`--weld` lands here) |
49+
50+
The `blender-smoke` workflow runs the check on Blender 5.2 LTS and 4.5 LTS
51+
(5.1 on the weekly cron, the `needs-5.1` PR label, or manual dispatch).
52+
Smoke does not pass `--no-duplicate` or `--weld`.

‎examples/cross-version-property-delete/README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,25 @@ the Clear plate tagged and exit 7.
3636

3737
The `--output` render path measures framing against the Layer 1 band via
3838
`examples/gallery_framing.py` (exit 10 on violation) before writing the still.
39+
40+
## Exit codes
41+
42+
Per-script sequential checks. `9` is a valid check code; there is no rule
43+
against it. `10` is the shared framing helper.
44+
45+
| Code | Meaning |
46+
| --- | --- |
47+
| 0 | Success |
48+
| 1 | Uncaught exception (FATAL wrapper) |
49+
| 2 | argparse / usage; also an active object existed after the data-API build |
50+
| 3 | Custom ID property did not land |
51+
| 4 | `property_unset` on a custom ID key did not TypeError, or it deleted the key |
52+
| 5 | `del` did not report removal |
53+
| 6 | Keep plate lost the ID property |
54+
| 7 | Clear plate still has the ID property (`--skip-delete` / `--unset-instead` land here) |
55+
| 10 | Gallery framing violation |
56+
| 12 | `--output` produced no file |
57+
58+
The `blender-smoke` workflow runs the check on Blender 5.2 LTS and 4.5 LTS
59+
(5.1 on the weekly cron, the `needs-5.1` PR label, or manual dispatch).
60+
Smoke does not pass `--output`, `--skip-delete`, or `--unset-instead`.

‎examples/exit-pre-sidecar/README.md‎

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,10 @@ accessing the handler list.
1212

1313
No gallery still. There is no geometry.
1414

15-
**What failure each check would catch:**
16-
17-
- exit 77 — Blender &lt; 5.1 and not `--force-run`
18-
- exit 2 — `--force-run` on 4.5 (`exit_pre` missing)
19-
- harness FAIL missing sidecar — `--silent-handler` / `--no-handler`
20-
- harness FAIL wrong contents — `--wrong-text` (`nope`), `--write-in-main`
21-
(`from-main`), `--atexit-instead` (`atexit-ok`)
22-
2315
The harness checks **contents** (`sidecar_contains=exit_pre-ok`), not
24-
existence only. A file written from `main` or `atexit` is red.
16+
existence only. A file written from `main` or `atexit` is red. Several
17+
falsifiers exit 0 from the script so the **harness** can fail after Blender
18+
dies.
2519

2620
## Run
2721

@@ -33,3 +27,19 @@ python tests/smoke/run_example.py --name exit-pre-sidecar \
3327
--series 5.2 --min-version 5.1 \
3428
--expect-sidecar /tmp/exit-pre.sidecar --sidecar-contains exit_pre-ok
3529
```
30+
31+
## Exit codes
32+
33+
Per-script sequential checks. `9` is a valid check code; there is no rule
34+
against it. `77` is the smoke skip protocol, not a product check.
35+
36+
| Code | Meaning |
37+
| --- | --- |
38+
| 0 | Success (including `--silent-handler` / `--no-handler` / `--wrong-text` / `--write-in-main` / `--atexit-instead`, which the harness then fails) |
39+
| 1 | Uncaught exception (FATAL wrapper); also `$BDT_SMOKE_SIDECAR` unset |
40+
| 2 | argparse / usage; also `--force-run` on Blender &lt; 5.1 (`exit_pre` missing or unexpectedly present) |
41+
| 77 | `SMOKE_SKIP:` `exit_pre` requires Blender 5.1+ |
42+
43+
The `blender-smoke` workflow runs the check on Blender 5.2 LTS (5.1 on the
44+
weekly cron, the `needs-5.1` PR label, or manual dispatch) and skips on 4.5
45+
LTS. Smoke does not pass the falsifier flags.

‎examples/export-preset-axis/README.md‎

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,26 @@ blender --background --python export_preset_axis.py -- --output beacon.png
4343
blender --background --python export_preset_axis.py -- --output beacon.png --engine cycles
4444
```
4545

46-
It exits non-zero on failure (RNA drift, source not Z-dominant, Unity disk
47-
not converted, Godot disk not Z-up, Unity not standing, Godot not lying,
48-
orientations equal). The `blender-smoke` workflow runs the check on Blender
49-
5.2 LTS and 4.5 LTS (5.1 on the weekly cron).
46+
## Exit codes
47+
48+
Per-script sequential checks. `9` is a valid check code; there is no rule
49+
against it. `10` is the shared framing helper.
50+
51+
| Code | Meaning |
52+
| --- | --- |
53+
| 0 | Success |
54+
| 1 | Uncaught exception (FATAL wrapper) |
55+
| 2 | argparse / usage; also exporter RNA missing expected glTF kwargs |
56+
| 3 | Source mast is not Z-dominant, or tip drifted |
57+
| 4 | glTF reimport produced no mesh |
58+
| 5 | Unity disk POSITION is not `(x, z, -y)`, or Unity node has rotation |
59+
| 6 | Godot disk POSITION is not raw Z-up; also `--output` produced no file |
60+
| 7 | Unity reimport is not standing |
61+
| 8 | Godot reimport is not lying along Y, or reimported tip mismatch |
62+
| 9 | Reimported orientations did not differ (`--same-axis` lands here) |
63+
| 10 | Gallery framing violation |
64+
| 11 | `--same-axis` did not collapse the axis difference |
65+
66+
The `blender-smoke` workflow runs the check on Blender 5.2 LTS and 4.5 LTS
67+
(5.1 on the weekly cron, the `needs-5.1` PR label, or manual dispatch).
68+
Smoke does not pass `--output` or `--same-axis`.

‎examples/gn-bundle-roundtrip/README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,23 @@ not read at thumbnail.
4343
blender --background --python gn_bundle_roundtrip.py --
4444
blender --background --python gn_bundle_roundtrip.py -- --force-run
4545
```
46+
47+
## Exit codes
48+
49+
Per-script sequential checks. `9` is a valid check code; there is no rule
50+
against it. `77` is the smoke skip protocol, not a product check.
51+
52+
| Code | Meaning |
53+
| --- | --- |
54+
| 0 | Success |
55+
| 1 | Uncaught exception (FATAL wrapper) |
56+
| 2 | argparse / usage; carrier mesh rewritten; `--legacy-rna` on 5.x |
57+
| 3 | Evaluated vert/face count off closed form (`--mismatch`) |
58+
| 4 | Unpacked Scale/Offset x-extent off (`--bypass`) |
59+
| 5 | `bundle_mark` missing or off closed form |
60+
| 77 | `SMOKE_SKIP:` Bundles require Blender 5.0+ |
61+
62+
The `blender-smoke` workflow runs the check on Blender 5.2 LTS (5.1 on the
63+
weekly cron, the `needs-5.1` PR label, or manual dispatch) and skips on 4.5
64+
LTS. Smoke does not pass `--bypass`, `--legacy-rna`, `--mismatch`, or
65+
`--force-run`.

‎examples/gn-zone-iterate/README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,25 @@ blender --background --python gn_zone_iterate.py -- --output zones.png
4040

4141
The `--output` render path measures framing via `examples/gallery_framing.py`
4242
(exit 10 on violation).
43+
44+
## Exit codes
45+
46+
Per-script sequential checks. `9` is a valid check code; there is no rule
47+
against it. `10` is the shared framing helper.
48+
49+
| Code | Meaning |
50+
| --- | --- |
51+
| 0 | Success |
52+
| 1 | Uncaught exception (FATAL wrapper) |
53+
| 2 | argparse / usage; also carrier mesh was rewritten |
54+
| 3 | Repeat evaluated vert/face count off closed form |
55+
| 4 | Repeat X-centers off closed form |
56+
| 5 | For Each evaluated vert/face count off closed form |
57+
| 6 | For Each Z-centers off closed form |
58+
| 10 | Gallery framing violation |
59+
| 12 | `--output` produced no file |
60+
61+
The `blender-smoke` workflow runs the check on Blender 5.2 LTS and 4.5 LTS
62+
(5.1 on the weekly cron, the `needs-5.1` PR label, or manual dispatch).
63+
Smoke does not pass `--output`, `--no-offset`, `--unpair-foreach`, or
64+
`--unpair-repeat`.

‎examples/lightmap-uv-channel/README.md‎

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,27 @@ blender --background --python lightmap_uv_channel.py -- --output atlas.png
8787
blender --background --python lightmap_uv_channel.py -- --falsify overlap.png
8888
```
8989

90-
Exits non-zero on failure. The `blender-smoke` workflow runs the check on
91-
Blender 5.2 LTS and 4.5 LTS. The `--output` render path additionally measures
92-
framing against the Layer 1 band via `examples/gallery_framing.py` (exit 10
93-
on violation) before writing the still.
90+
## Exit codes
91+
92+
Per-script sequential checks. `9` is a valid check code; there is no rule
93+
against it. `10` is the shared framing helper. `11` is the shared asset-quality
94+
helper.
95+
96+
| Code | Meaning |
97+
| --- | --- |
98+
| 0 | Success |
99+
| 1 | Uncaught exception (FATAL wrapper) |
100+
| 2 | argparse / usage |
101+
| 3 | UV layer names ≠ UV0 / UV1 |
102+
| 4 | UVMap / UV1 render/clone flags wrong after re-assert |
103+
| 5 | Channel 0 (UV0) touched by the UV1 unwrap |
104+
| 6 | UV1 loops outside `[0,1]` |
105+
| 7 | SAT overlap self-test failed, or UV1 triangle pairs overlap |
106+
| 8 | Min island distance below margin |
107+
| 9 | Part is not watertight |
108+
| 10 | Gallery framing violation; also `--output` produced no file |
109+
| 11 | Gallery asset-quality violation |
110+
111+
The `blender-smoke` workflow runs the check on Blender 5.2 LTS and 4.5 LTS
112+
(5.1 on the weekly cron, the `needs-5.1` PR label, or manual dispatch).
113+
Smoke does not pass `--output` or `--falsify`.

‎examples/modular-kit-snap/README.md‎

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,26 @@ blender --background --python modular_kit_snap.py -- --output corridor.png
8383
blender --background --python modular_kit_snap.py -- --falsify seams.png
8484
```
8585

86-
Exits non-zero on failure. The `blender-smoke` workflow runs the check on
87-
Blender 5.2 LTS and 4.5 LTS. The `--output` render path additionally measures
88-
framing against the Layer 1 band via `examples/gallery_framing.py` (reported
89-
under the documented deviation above) before writing the still.
86+
## Exit codes
87+
88+
Per-script sequential checks. `9` is a valid check code; there is no rule
89+
against it. `10` is the shared framing helper. `11` is the shared asset-quality
90+
helper.
91+
92+
| Code | Meaning |
93+
| --- | --- |
94+
| 0 | Success |
95+
| 1 | Uncaught exception (FATAL wrapper) |
96+
| 2 | argparse / usage |
97+
| 3 | Boundary vert count or end-plane membership |
98+
| 4 | End rings do not partition evenly, or opposing loops differ |
99+
| 5 | Tiled instances do not share boundary positions |
100+
| 6 | Shell or whole-asset bbox off the declared tile |
101+
| 7 | Boundary edge count, non-manifold edges, or rim off the end planes |
102+
| 8 | Detail part not watertight |
103+
| 9 | Detail part reaches a tile boundary; also `--output` produced no file |
104+
| 11 | Kit part count, unapplied scale, namespace, or origin; also gallery asset-quality violation |
105+
106+
The `blender-smoke` workflow runs the check on Blender 5.2 LTS and 4.5 LTS
107+
(5.1 on the weekly cron, the `needs-5.1` PR label, or manual dispatch).
108+
Smoke does not pass `--output` or `--falsify`.

‎examples/ngon-triangulate/README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,20 @@ blender --background --python ngon_triangulate.py --
2929
blender --background --python ngon_triangulate.py -- --no-dissolve
3030
blender --background --python ngon_triangulate.py -- --skip-triangulate
3131
```
32+
33+
## Exit codes
34+
35+
Per-script sequential checks. `9` is a valid check code; there is no rule
36+
against it.
37+
38+
| Code | Meaning |
39+
| --- | --- |
40+
| 0 | Success |
41+
| 1 | Uncaught exception (FATAL wrapper) |
42+
| 2 | argparse / usage |
43+
| 3 | Pathology missing: n-gon count, loops, or face count (`--no-dissolve` lands here) |
44+
| 4 | `calc_tangents` / triangulate handling (`--skip-triangulate` lands here) |
45+
46+
The `blender-smoke` workflow runs the check on Blender 5.2 LTS and 4.5 LTS
47+
(5.1 on the weekly cron, the `needs-5.1` PR label, or manual dispatch).
48+
Smoke does not pass `--no-dissolve` or `--skip-triangulate`.

‎examples/socket-attach-points/README.md‎

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,11 +123,35 @@ blender --background --python socket_attach_points.py -- --falsify adrift.png
123123
blender --background --python socket_attach_points.py -- --probe
124124
```
125125

126-
Exits non-zero on failure. The `blender-smoke` workflow runs the check on
127-
Blender 5.2 LTS and 4.5 LTS. The `--output` render path additionally gates framing
128-
via `examples/gallery_framing.py` (fill **0.881x**, margins
126+
The `--output` render path additionally gates framing via
127+
`examples/gallery_framing.py` (fill **0.881x**, margins
129128
**0.066/0.053/0.122/0.106**, no edge touched) and the asset floors via
130129
`examples/gallery_asset_quality.py` (32 materials, `edge90` **0.027**, no
131130
default names). The `--falsify` render is a diagnostic, not a gallery hero, so
132131
it takes a documented framing deviation — its whole point is that the modules
133132
leave the frame.
133+
134+
## Exit codes
135+
136+
Per-script sequential checks. `9` is a valid check code; there is no rule
137+
against it. `10` is the shared framing helper. `11` is the shared asset-quality
138+
helper.
139+
140+
| Code | Meaning |
141+
| --- | --- |
142+
| 0 | Success |
143+
| 1 | Uncaught exception (FATAL wrapper) |
144+
| 2 | argparse / usage |
145+
| 3 | Socket world matrix, orthonormal basis, or determinant |
146+
| 4 | Socket pad normal, origin, or up-axis rule |
147+
| 5 | Module seating / mount axis / leftover local transform |
148+
| 6 | Population, namespace, default datablock name, SKT_ prefix, or skid plane |
149+
| 7 | Re-pose: socket or module lost the root |
150+
| 8 | Parent-inverse clear, child scale pushdown, or post-apply module drift |
151+
| 9 | `--output` produced no file |
152+
| 10 | Gallery framing violation |
153+
| 11 | Gallery asset-quality violation |
154+
155+
The `blender-smoke` workflow runs the check on Blender 5.2 LTS and 4.5 LTS
156+
(5.1 on the weekly cron, the `needs-5.1` PR label, or manual dispatch).
157+
Smoke does not pass `--output`, `--falsify`, or `--probe`.

0 commit comments

Comments
 (0)