Repository navigation
Commit eeace57
authored
Remove documentation that describes things that no longer exist (#2017)
Three kinds of stale documentation, all of it naming something the tree does not
contain. `doc-consistency.md` §3: when a referent is gone, the reference goes too.
**`problems.md`, deleted.** A personal working audit of `host_build_graph` —
findings, their status, and notes on what to look at next. It was never meant to be
here. It arrived in #1974 through a `git add -A` that swept it up with that
change's 958 files, and #2012 then updated it rather than noticing it. Nothing
references it (`git grep problems.md` is empty), it is absent from `mkdocs.yml`,
and `wheel.packages` is `["simpler_setup", "python/simpler"]` so it never shipped.
Its closed items name the PRs that closed them, each of which carries the
reasoning in its own commit message.
**`last_task_alive`, in hbg's `RUNTIME_LOGIC.md`.** The paragraph gives four
reasons `SchedulerState` holds no per-run content, and the third was "hbg never
advances `last_task_alive`". That was accurate when written — hbg inherited the
field from `tensormap_and_ringbuffer` and did not advance it — but #1837 deleted
the field with the rest of the reclamation paths, for exactly the reason the
sentence gives, and #2004 then removed the ring that held it. The clause now names
the one thing in that list that does not exist. It is replaced by the live fact
from the same runtime: polling reserves no wiring or dependency pool, because
readiness comes from the task table's `completion_flags`.
**`ring 0`, in hbg's `SCALAR_DATA_ACCESS.md`.** Ownership validation was described
as checking that "the task ID ... carries ring 0, the only ring HBG places tasks
on". hbg has had no ring since #2004 (`git grep 'rings\['` over its tree is
empty), and since #2012 the check is on the id *space*, not a ring index. The
bullet now says what the code does and why a `GRAPH_NODE` id fails it.
**`pto_runtime2_init`, in three `scheduler.h` files.** A comment credited it with
reserving and wiring the early-dispatch queues. `git grep pto_runtime2_init`
returned only those three comments — the symbol exists nowhere. The work is done by
`SchedulerState::init_data_from_layout`, which the comment now names. Only three of
the four runtime trees carried the line; `src/a5/runtime/tensormap_and_ringbuffer`
words that member differently.
**`run_from_blob`, in `docs/buffer-abi.md`.** A present-tense table row told the
chip leaf to "hand the POD blob to `run_from_blob`", a name that has never existed
(introduced with the row in #1599). The row now names the three functions that do
the work — `read_args_from_blob`, `ImportRegistry.materialize_args`,
`_submit_chip_run_materialized` — matching `worker.py`'s `submit_frame`.
Deliberately untouched: `tensormap_and_ringbuffer`'s ring documentation.
`current_task_index`, `task_window_mask`, `advance_lock` and `last_task_alive` are
all live there (162 uses across 20 non-doc files); #2004 dropped the ring from
`host_build_graph` only, and said so.1 parent 0631f57 commit eeace57
9 files changed
Lines changed: 28 additions & 145 deletions
File tree
- docs
- src
- a2a3/runtime
- host_build_graph
- docs
- runtime/scheduler
- tensormap_and_ringbuffer/runtime/scheduler
- a5/runtime/host_build_graph
- docs
- runtime/scheduler
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
250 | 250 | | |
251 | 251 | | |
252 | 252 | | |
253 | | - | |
| 253 | + | |
254 | 254 | | |
255 | 255 | | |
256 | 256 | | |
| |||
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
124 | 124 | | |
125 | 125 | | |
126 | 126 | | |
127 | | - | |
128 | | - | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
129 | 130 | | |
130 | 131 | | |
131 | 132 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
73 | | - | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
74 | 76 | | |
75 | 77 | | |
76 | 78 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
689 | 689 | | |
690 | 690 | | |
691 | 691 | | |
692 | | - | |
693 | | - | |
694 | | - | |
695 | | - | |
696 | | - | |
| 692 | + | |
| 693 | + | |
| 694 | + | |
| 695 | + | |
| 696 | + | |
697 | 697 | | |
698 | 698 | | |
699 | 699 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
735 | 735 | | |
736 | 736 | | |
737 | 737 | | |
738 | | - | |
739 | | - | |
740 | | - | |
741 | | - | |
742 | | - | |
| 738 | + | |
| 739 | + | |
| 740 | + | |
| 741 | + | |
| 742 | + | |
743 | 743 | | |
744 | 744 | | |
745 | 745 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
124 | 124 | | |
125 | 125 | | |
126 | 126 | | |
127 | | - | |
128 | | - | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
129 | 130 | | |
130 | 131 | | |
131 | 132 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
73 | | - | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
74 | 76 | | |
75 | 77 | | |
76 | 78 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
689 | 689 | | |
690 | 690 | | |
691 | 691 | | |
692 | | - | |
693 | | - | |
694 | | - | |
695 | | - | |
696 | | - | |
| 692 | + | |
| 693 | + | |
| 694 | + | |
| 695 | + | |
| 696 | + | |
697 | 697 | | |
698 | 698 | | |
699 | 699 | | |
| |||
0 commit comments