Commit 880d6be
committed
docs: the README states three tiers, both languages state the same targets, and a check enforces it
The two top-level READMEs were outside every documentation check but the emoji
rule, and had drifted from the implementation in three ways.
The target table now carries the three tiers the engine actually stores --
`verified`, `preview`, `planned` -- and every canonical spelling in
`modules/toolchain-model/src/triple.cppm`. The distinction is load-bearing:
a build for a `planned` row is refused, while a `preview` row builds and links,
and three rows the README called `planned` were `preview`. Three rows were
absent altogether. The 简体中文 table was seven rows behind -- every bare-metal
row, plus the footnote that says a freestanding target takes its C library,
startup code and emulator from a board-support package -- so that README
described a tool with no freestanding support at all.
The Feature Overview gains the surfaces shipped since 2026.8 and previously
unmentioned in either language: cross-compilation, bare metal and devices;
heterogeneous builds and accelerators; and the extension model of `build.mcpp`
and rule packages. `--release`, `--profile`, `--features`, `mcpp emit sbom` and
the machine-readable output join the command list, and `mcpp why` regains its
fourth topic.
The Documentation section names the parts of the manual and points at the index
that owns the reverse lookup, rather than naming seven chapters out of
thirty-one. The benchmark keeps its table, its provenance and its control row,
and loses half its lines. Two counts that rot with the tree -- "43+ C++23
modules" against 119 interface units -- are replaced by prose; the one count
that is a measurement stays where it is measured.
Rules 9 and 10 of `check_docs_structure.sh` now cover the README pair: the row
counts are 61 and 61, and a row dropped from either side fails the check. Rule
14 is new -- a link labelled with a chapter number must point at that chapter.
It was written for `[docs/13 -- ...](docs/40-baremetal.md)` in README.md and
found six more of the same, left in `docs/` and `docs/specs/` by the
renumbering in #590; all seven are corrected here.
`triple.cppm`'s own tier legend named two of the three tiers it stores. The
README now cites that file, so it is corrected in the same change.1 parent 85ea09b commit 880d6be
10 files changed
Lines changed: 250 additions & 121 deletions
File tree
- .github/tools
- docs
- specs
- zh
- modules/toolchain-model/src
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
| 20 | + | |
20 | 21 | | |
21 | 22 | | |
22 | 23 | | |
| |||
144 | 145 | | |
145 | 146 | | |
146 | 147 | | |
147 | | - | |
| 148 | + | |
148 | 149 | | |
149 | 150 | | |
150 | 151 | | |
151 | 152 | | |
152 | 153 | | |
153 | 154 | | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
154 | 159 | | |
155 | 160 | | |
156 | 161 | | |
| |||
195 | 200 | | |
196 | 201 | | |
197 | 202 | | |
198 | | - | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
199 | 206 | | |
200 | 207 | | |
201 | 208 | | |
| |||
227 | 234 | | |
228 | 235 | | |
229 | 236 | | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
230 | 243 | | |
231 | 244 | | |
232 | 245 | | |
233 | | - | |
234 | | - | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
235 | 250 | | |
236 | 251 | | |
237 | 252 | | |
| |||
330 | 345 | | |
331 | 346 | | |
332 | 347 | | |
| 348 | + | |
| 349 | + | |
| 350 | + | |
| 351 | + | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| 360 | + | |
| 361 | + | |
| 362 | + | |
| 363 | + | |
| 364 | + | |
| 365 | + | |
| 366 | + | |
| 367 | + | |
| 368 | + | |
| 369 | + | |
| 370 | + | |
| 371 | + | |
| 372 | + | |
| 373 | + | |
| 374 | + | |
| 375 | + | |
| 376 | + | |
| 377 | + | |
333 | 378 | | |
334 | 379 | | |
335 | 380 | | |
| |||
0 commit comments