You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 9b50973
Browse filesBrowse the repository at this point in the historyBrowse files
Docs: the guards bind, because the pages they guard are clean (R5 int12, documentation wave)
The three documentation lanes are cherry-picked above this commit. Each one
passed its own gates on its own base; this is what the union of the three
needs, and nothing else.
The guards go binding. `--strict-docs` was L14-A's ruling that a guard may
report rather than fail while the drift it names is exactly what the next two
lanes exist to remove. Those lanes have landed: the anchor checker reports
bad=0 on every page and the lint 0 offenders, so the flag is removed rather
than flipped -- a guard that can be asked not to bind is decoration. The
advisory *mechanism* stays in `ci_preflight.py`, with its self-test, for the
next guard that lands before its drift is gone; no stage uses it today.
`CONTRIBUTING.md` joins both guards' globs: L14-B rewrote it whole and checked
it by hand, and nothing kept it true.
The anchors. L14-C's 528 header comment lines moved 307 of the anchors in
L14-B's rewritten `pine-to-native.md`, which is what happens when two lanes
branch from the same tip and one of them edits the headers the other cites.
`--fix` re-anchored 277 of them; the remaining 30 are symbols the checker
refuses to guess at (`side` on eight lines, `Cancel` on two). Each was
resolved by mapping its line through the 7485a40a..HEAD diff of the header it
cites and reading both texts: all 30 old lines survive verbatim, so the
coordinate moved and the claim did not. Two of the 30 differ from the
checker's first candidate -- `cancel_where` is the `NativeRequestField`
overload, not the one-argument one, and `FromOwnerFill::ticks` is the flag,
not `TrailTicks::ticks`.
The two page anchors `native-engine.md` links to, `{#pine_to_native_map}` and
`{#pine_to_native_map_trades}`, were dropped by L14-B's rewrite (it split the
one "Concept map" section into ten). Restored as `@anchor` commands so that
L14-B's per-section ids are kept as well.
Doxygen builds at 0 warnings over all inputs, not only over the guarded set.
Four references from L14-B's pages pointed at files outside `INPUT`. The
front doors are now published -- `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`,
`LEGAL.md`, `SECURITY.md` -- and the two engineering records they also named
are cited by path instead, because `docs/README.md` states that split and a
record is not a page.
The lint's last offender was its own false positive: `Series<T>::operator[](k)`
inside a code span reads as a markdown link to a file named `k`. An inline code
span is not a link, for the same reason L14-A ruled that a fenced block is not
a citation; only the span's content is masked, so a real link whose label is
code is still read. Two self-tests, one each way. The fourteen other offenders
name their epoch correctly -- historical baselines, frozen providers, and P2c's
`lifecycle_v2` removal epoch, which is forward, not stale -- so each carries
the `<!-- verified HEAD -->` marker the rule provides.
P2c landed on main after all three lanes branched, so the migration page still
offered the deprecated spelling as the primary one: its `risk_free_rate` row
now names `sharpe_monthly` / `sortino_monthly` and records `sharpe_tv` /
`sortino_tv` as the deprecated aliases of the same two doubles, with the
serialized report key unchanged. ADR-0001 keeps both sections whole -- P2c's
"Deprecated public spellings" table and L14-C's rewritten feature-gate rulings
-- which `check_kernel_residuals.py` (109 archive hits against 119 ruled
identifiers and 11 ruled texts, 0 findings) and `check_native_feature_rulings.py`
both still parse.
The floors, recomputed on this tree under lane Q12's ran-rows rule:
`KERNEL_MIN_TESTS` 189 -> 193 (194 registered, the WebSocket row still skips)
and `RELEASE_MIN_TESTS` 554 -> 558. Both +4, the same four rows: L14-A's
`test_doc_anchors` and `test_doc_lint`, and L14-B's two example hosts.
Cross-lane corrections the union tree still needed: `native-engine.md`'s
"all thirteen sources" is fifteen (L14-B added two examples), `docs/ci.md`'s
"three guards" is four and its "ten native examples" fifteen, and the kernel
row floor the page quotes is the recomputed one. The three L14-C flagged in
L14-B's pages -- README's opt-in sentence and `index.md`'s two counts -- were
already true here: L14-B's later commits fixed them after L14-C read them.
Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
Copy file name to clipboardExpand all lines: docs/adr/0001-kernel-adapter-boundary.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -300,10 +300,10 @@ citations, 264 are in `src/source/` and its headers; 6 sit in kernel files
300
300
COVERAGE block carries one line per public member of `NativeStrategyHost` with either its C
301
301
spelling or the reason it has none, and `scripts/check_native_c_api_surface.py` proves the
302
302
block is exactly that class's public surface. `strategy_create` / `run_backtest` stay
303
-
codegen-emitted (`include/pineforge/pineforge.h:434`), which is why a C host frees its report
303
+
codegen-emitted (`include/pineforge/pineforge.h:530`), which is why a C host frees its report
304
304
with `strategy_native_report_free_v1`.
305
-
-**The examples are a gated target with executed assertions.**Thirteen Pine-free hosts ship
306
-
under `examples/native/` — eleven C++ and two C — each including only
305
+
-**The examples are a gated target with executed assertions.**Fifteen Pine-free hosts ship
306
+
under `examples/native/` — thirteen C++ and two C — each including only
307
307
`<pineforge/native_host.hpp>` (or `native_c_api.h`), linking `PineForge::kernel`, and checking
308
308
its own numbers before it prints its summary line. `PINEFORGE_BUILD_EXAMPLES`
309
309
(`CMakeLists.txt:37`, default OFF) builds them (`add_subdirectory``CMakeLists.txt:305`) and
@@ -419,8 +419,8 @@ on a Release and on a Debug archive: `0 findings`, both profiles, with these ali
419
419
|---|---|---|---|---|
420
420
|`pf_equity_stats_t::sharpe_tv`|`sharpe_monthly`| public C ABI (`include/pineforge/pineforge.h`, `PF_ABI_VERSION` 4) | the next `PF_ABI_VERSION` (5) | The field is month-end-resampled equity simple returns (chart timezone, open-time bucketing), risk-free 2 %/yr, annualized ×√12, sample (N−1) stddev — a construction whose name is its resampling period, not its calibration source. The published header is the contract of every compiled FFI consumer, so both names are one `double` behind a C11 anonymous union of two same-typed members: identical offset (48), identical `sizeof(pf_equity_stats_t)` (120), identical `offsetof(pf_metrics_t, equity)` (648), pinned by `static_assert` in `src/c_abi.cpp` and exercised from C by `tests/test_c_abi.c`. |
421
421
|`pf_equity_stats_t::sortino_tv`|`sortino_monthly`| public C ABI (as above) | the next `PF_ABI_VERSION` (5) | Same resampling as `sharpe_monthly`, population downside deviation vs the monthly risk-free. Aliased on the same terms; offset 56. |
422
-
|`exit_legs::Domain::Coof`|`FillRecalc`| standalone C++ ABI `pineforge::exit_legs::lifecycle_v1` (`include/pineforge/exit_leg_lifecycle.hpp`) |`lifecycle_v2`| The domain is the fill-recalculation re-entry pass: the host re-runs its script after a fill and observes the rest of the same bar. `coof` abbreviates `calc_on_order_fills`, the Pine adapter's name for it (the same abbreviation the `coof_*` reflection rows carry, ruled above). An enumerator alias adds a name and no value: `Coof == FillRecalc == 1`, the underlying type stays `uint8_t`, `Domain::RawTicks` stays 4 (so `valid_frame`'s range check is unchanged), and no `switch` gains a case. Twin-parity-frozen TUs keep compiling their old spelling unchanged. |
423
-
|`exit_legs::Domain::MagnifierCoof`|`MagnifierFillRecalc`| standalone C++ ABI `lifecycle_v1` (as above) |`lifecycle_v2`| The same re-entry pass on a magnified sub-bar. `MagnifierCoof == MagnifierFillRecalc == 3`. |
422
+
| `exit_legs::Domain::Coof` | `FillRecalc` | standalone C++ ABI `pineforge::exit_legs::lifecycle_v1` (`include/pineforge/exit_leg_lifecycle.hpp`) | `lifecycle_v2` | The domain is the fill-recalculation re-entry pass: the host re-runs its script after a fill and observes the rest of the same bar. `coof` abbreviates `calc_on_order_fills`, the Pine adapter's name for it (the same abbreviation the `coof_*` reflection rows carry, ruled above). An enumerator alias adds a name and no value: `Coof == FillRecalc == 1`, the underlying type stays `uint8_t`, `Domain::RawTicks` stays 4 (so `valid_frame`'s range check is unchanged), and no `switch` gains a case. Twin-parity-frozen TUs keep compiling their old spelling unchanged. |<!-- verified HEAD -->
423
+
| `exit_legs::Domain::MagnifierCoof` | `MagnifierFillRecalc` | standalone C++ ABI `lifecycle_v1` (as above) | `lifecycle_v2` | The same re-entry pass on a magnified sub-bar. `MagnifierCoof == MagnifierFillRecalc == 3`. |<!-- verified HEAD -->
424
424
425
425
**The serialized report keys do not change.**`sharpe_tv` and `sortino_tv` remain the JSON keys of
426
426
the report dictionaries built by `docker/run_json.py` (`_stats_dict`, driven off the ctypes
@@ -614,7 +614,7 @@ buildable archive with no source-layer object in it; size with `Sized` or with y
614
614
let the kernel record the equity curve, the per-bar broker hashes and the open-position row, or
615
615
record them yourself; declare higher-timeframe series and an auxiliary finer feed in the run
616
616
spec; declare a margin model, a risk block and a price grid; and submit, replace, cancel, bracket
617
-
and trail through one request type. Thirteen example hosts do exactly that, each asserting its own
617
+
and trail through one request type. Fifteen example hosts do exactly that, each asserting its own
618
618
numbers in a gated CTest row, and the `kernel` profile of `scripts/ci_verify.py` runs the whole
0 commit comments