Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
91 commits
Select commit Hold shift + click to select a range
b20e9f7
fix(monitor): look for the plugin where horus install puts it
starswallow Sep 4, 2026
6640fda
fix(control): make horus node restart actually restart the node
starswallow Sep 4, 2026
3028b02
fix(safety): count consecutive deadline misses, not budget overruns
starswallow Sep 4, 2026
88688dc
fix(safety): make the max_deadline_misses emergency stop reachable
starswallow Sep 4, 2026
51ade03
fix(run): apply [network] on every path that spawns a run child
starswallow Sep 4, 2026
01d5939
fix(log): HORUS_LOG_FILE actually starts the file drain
starswallow Sep 4, 2026
ff8239f
fix(topic): try_send and send_blocking move the staleness counter
starswallow Sep 5, 2026
8c87bf3
fix(topic): tell the 17th participant why it has no comms
starswallow Sep 5, 2026
dbd4d94
fix(python): a refusal for want of backpressure is not a timeout
starswallow Sep 5, 2026
f557cdd
fix(python): make subs= type auto-detection actually run
starswallow Sep 5, 2026
5770e6e
fix(cli): three flags that did not do what they said
starswallow Sep 5, 2026
8de0220
test(log): fix a race in the drain wiring test that CI caught
starswallow Sep 5, 2026
6e1d7a0
fix(topic): give a participant registration back when its handle drops
starswallow Sep 5, 2026
d0fa1df
fix(topic): stop advertising a migration drain that is not performed
starswallow Sep 5, 2026
c4f981b
fix(rt): a safing callback that panics must not cancel the safety action
starswallow Sep 5, 2026
d5b507c
fix: a watchdog is never tightened, and topic metrics count real traffic
starswallow Sep 5, 2026
65f461a
fix(launch): --status told the truth about nothing, and namespace: li…
starswallow Sep 5, 2026
a92dc95
fix(python): an untyped topic accepts a message object, and the quick…
starswallow Sep 5, 2026
69a80b9
fix(drivers): honour `simulated`, and name an exec driver after its e…
starswallow Sep 5, 2026
c556dac
fix(cpp): a param value must not come back silently clipped
starswallow Sep 5, 2026
5f568ab
fix(install): a prefix install must export the variable it depends on
starswallow Sep 5, 2026
c9b7096
merge: origin/main into fix/docs-runtime-divergence
starswallow Sep 5, 2026
e09c9fa
merge: drop the duplicated monitor lookup, keep main's
starswallow Sep 5, 2026
fa4a59a
merge: origin/main (#192, #193) into fix/docs-runtime-divergence
starswallow Sep 5, 2026
c8e5735
Initial plan
Copilot Sep 5, 2026
1233a88
Harden CI shared-memory cleanup
Copilot Sep 5, 2026
cf6b35b
test(cpp): cover the get_string re-call, which nothing exercised
starswallow Sep 5, 2026
69a6b3b
test(topic): stress the participant release under concurrent churn
starswallow Sep 5, 2026
f97a5e2
fix(topic): count a handle taking a role its sibling already holds
starswallow Sep 5, 2026
84d2dec
test(monitor): pin the opt-in on the project-local plugin lookup
starswallow Sep 5, 2026
8264221
fix(tests): stop leaking a shared-memory namespace per isolated child
starswallow Sep 5, 2026
4fde12f
fix(topic): pool-backed try_send moves the staleness counter too
starswallow Sep 5, 2026
a9ca7d9
fix(control): horus node restart must reach a node on an executor
starswallow Sep 5, 2026
ca021a0
test: three of this branch's own guards did not guard
starswallow Sep 5, 2026
8fc089f
test: anchor the safing-order guard on code, not on a comment
starswallow Sep 5, 2026
316dc0f
fix: three more defects in this branch's own work
starswallow Sep 5, 2026
3162491
fix: an error that asked for the impossible, and a stale doc-comment
starswallow Sep 5, 2026
cf23bb6
fix: three more declared-but-not-delivered defects
starswallow Sep 5, 2026
e6e9681
revert: restore four files the previous commit truncated
starswallow Sep 5, 2026
0609bb1
fix: two hints that could never fire, and a preferred section nobody …
starswallow Sep 5, 2026
b9841bd
fix: --sim did nothing at all on the Python driver path
starswallow Sep 5, 2026
4982855
fix(python): a Python doc example was compiled as Rust
starswallow Sep 5, 2026
ba88c7e
fix(install): the stale-prefix removal used a GNU-only regex
starswallow Sep 5, 2026
a4ee330
fix: a C++ log line reached horus log with no time on it
starswallow Sep 5, 2026
4725035
fix(install): the Rust version gate failed closed when it could not c…
starswallow Sep 5, 2026
d6fdf1c
fix: scheduler introspection invented answers while the scheduler ran
starswallow Sep 5, 2026
d42d532
fix: safing diagnostics were queued with nothing to drain them
starswallow Sep 5, 2026
7867ad2
fix(uninstall): the HORUS_PREFIX export survived the uninstall
starswallow Sep 5, 2026
94e5560
fix(uninstall): a prefix install's PATH line outlived the uninstall
starswallow Sep 5, 2026
b3cc642
fix(uninstall): the fish prefix cleanup reported removals it never made
starswallow Sep 5, 2026
7de6fc5
Merge origin/main into fix/docs-runtime-divergence
starswallow Sep 5, 2026
3b1ffa3
fix: horus node pause did nothing to three of the four node classes
starswallow Sep 5, 2026
386e401
fix: nothing ever called the warning that .no_alloc() is unenforced
starswallow Sep 5, 2026
c2334ca
fix: the blackbox never recorded a single network event
starswallow Sep 5, 2026
9c7b4ac
test: exempt the compute-diag child switch from the env-var doc guard
starswallow Sep 5, 2026
9764e2b
fix(scheduling): three of the four executors dropped their last diagn…
starswallow Sep 5, 2026
8f25e79
fix: replay lost the recorded node order, and two docs contradicted t…
starswallow Sep 5, 2026
1a5af5e
fix: three more places the code did not do what its own file says
starswallow Sep 5, 2026
e09a635
fix(scheduling): a diagnostic being written when a drain ran was lost…
starswallow Sep 6, 2026
aacebb2
Merge commit '1a5af5ef15a74f1de0ae279920257928d117e486' into merge/ma…
starswallow Sep 6, 2026
31e292b
fix: nine findings from the review, one of which could delete a user'…
starswallow Sep 6, 2026
f725ec9
docs(scheduler): the restart path clears two different pauses, not one
starswallow Sep 6, 2026
1e5297b
Merge main (#203, the jitter budget) into fix/docs-runtime-divergence
starswallow Sep 6, 2026
fd22aea
Merge remote-tracking branch 'origin/main' into fix/189-review-followups
starswallow Sep 6, 2026
27a032f
ci: pin the documentation half of this audit alongside the code half
starswallow Sep 6, 2026
6fa2268
fix(uninstall): my own guard broke the one case the guard is about
starswallow Sep 6, 2026
af303ea
docs(rustdoc): let a maintainer read horus_core's internals on stable
starswallow Sep 6, 2026
8e37a65
fix(docs): five documentation defects the hidden modules had been con…
starswallow Sep 6, 2026
43a89c0
fix(env): one vocabulary for boolean environment variables
starswallow Sep 6, 2026
99ceb66
docs: reunite RuntimeParams with its own documentation
starswallow Sep 6, 2026
3a46ccc
docs: correct two onboarding claims that CI had already falsified
starswallow Sep 6, 2026
f5499e6
fix(py): declare peek_topic_type in the stubs, and make the error run…
starswallow Sep 6, 2026
fb82689
review: three findings on the maintainability branch, one of them wrong
starswallow Sep 6, 2026
a40481b
fix(docs): disambiguate the env module link
starswallow Sep 6, 2026
2df41ef
ci(actions): bump the actions group across 1 directory with 3 updates
dependabot[bot] Sep 14, 2026
fffc882
deps(npm): bump puppeteer
dependabot[bot] Sep 14, 2026
0830a1a
deps(cargo): bump dirs from 6.0.0 to 7.0.0
dependabot[bot] Sep 14, 2026
ff16540
fix: read macOS POSIX shared memory in topic readers
Sep 16, 2026
f54a779
Merge remote-tracking branch 'origin/dependabot/npm_and_yarn/horus_ma…
Sep 20, 2026
5f7d2da
Merge remote-tracking branch 'origin/dependabot/github_actions/action…
Sep 20, 2026
7cfef96
Merge remote-tracking branch 'pr/215' into integration/pr-stack
Sep 20, 2026
66b258a
Merge remote-tracking branch 'origin/copilot/fix-ci-failures' into in…
Sep 20, 2026
cb9c840
Merge remote-tracking branch 'origin/fix/maintainability-for-humans' …
Sep 20, 2026
6b82e0d
Merge remote-tracking branch 'origin/fix/docs-runtime-divergence' int…
Sep 20, 2026
24b92cc
fix(topic): count sent/received in the handle's LocalState, not an Ar…
Sep 20, 2026
cd50ffa
ci(parity): run the macOS topic-reader regression on macOS
Sep 20, 2026
0d89b04
fix(topic): the traffic counters live on RingTopic, not LocalState
Sep 20, 2026
0811d2f
fix(deps): RUSTSEC-2026-0285 — rustls 0.23.43 accepts cross-encryptio…
Sep 20, 2026
1bd0454
docs(topic): MockTopic is cfg-gated, so the rustdoc link cannot resolve
Sep 20, 2026
e74a2bf
fix(scheduling): a restart whose init() fails stops the node
Sep 20, 2026
2825154
fix(topic): the metrics counters move on every public send/recv API
Sep 20, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ jobs:
# Setup shared memory for HORUS tests
- name: Setup Shared Memory
run: |
rm -rf /dev/shm/horus_*
# Create namespaced SHM directory structure
SHM_DIR="/dev/shm/horus_ci_${GITHUB_RUN_ID:-$$}"
# No sudo: sudo mkdir leaves these root-owned, which is what made
Expand Down Expand Up @@ -226,6 +227,25 @@ jobs:
env:
RUST_BACKTRACE: 1

# Doctests. `--lib` above does NOT run them, and no other job did either:
# before this step, `grep -rn -- '--doc' .github/workflows/` returned
# nothing, so every `///` example in the workspace was unverified. The
# `Documentation` job runs `cargo doc`, which builds the pages and does
# not compile the examples in them.
#
# This matters because the examples are the first code a new contributor
# copies. Measured on the tree that added this step: 21 passed, 0 failed.
#
# It is a thin gate today and the number says why: 193 of the workspace's
# examples are fenced ```rust,ignore``` and are skipped, so this compiles
# 21 of 214. Converting the ignores that only need to type-check to
# ```no_run``` is the follow-up that gives this step its teeth; the step
# has to exist first or there is nothing to convert them into.
- name: Doctests
run: cargo test --workspace --exclude horus_py --doc
env:
RUST_BACKTRACE: 1

# The resolver's crates.io/PyPI tests carry #[ignore] so a contributor
# without network access gets a green suite and a failure means the
# resolver is wrong rather than the network. CI does have access, so it
Expand Down Expand Up @@ -360,6 +380,19 @@ jobs:
# also the right call — docs should describe the crate as it ships,
# i.e. with its default features on.
cargo doc --workspace --no-deps --exclude horus_manager
# Again with horus_core's internals visible.
#
# Ten of its eleven modules are `#[doc(hidden)]` by default, and
# rustdoc does not resolve links inside a hidden module — so the run
# above holds `-D warnings` over roughly a quarter of the crate and
# silently skips the rest. Four broken links had accumulated behind
# that gap, including a `[`HorusError::OutOfRange`]` naming a variant
# the error refactor deleted, and two pointing at private items.
#
# `internal-docs` is docs-only: it gates nothing but the
# `#[doc(hidden)]` attributes, so this compiles no extra code. The
# published documentation is still what the first command renders.
cargo doc -p horus_core --no-deps --features internal-docs
env:
RUSTDOCFLAGS: ${{ (github.ref == 'refs/heads/main' || github.base_ref == 'main') && '-D warnings' || '' }}

Expand Down
16 changes: 16 additions & 0 deletions .github/workflows/cross-platform-parity.yml
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,22 @@ jobs:
env:
HORUS_NAMESPACE: ci_macos_unit_${{ github.run_id }}

# The one horus_core test that is macOS-only, and the reason this job
# exists for it at all: no other macOS job builds horus_core's test
# targets, so `macos_reader_opens_a_live_posix_topic` — the regression
# that `horus topic echo`/`hz`/`bw` read the POSIX named region rather
# than a nonexistent file at the public topic path — was compiled by
# nothing and run by nothing. The filter runs exactly that test; the
# rest of horus_core's macOS suite has pre-existing host-dependent
# failures that are out of scope here.
- name: macOS topic reader regression (#215)
run: |
cargo test -p horus_core --lib -- \
macos_reader_opens_a_live_posix_topic --test-threads=1
env:
HORUS_NAMESPACE: ci_macos_reader_${{ github.run_id }}
RUST_BACKTRACE: 1

# The two tests that execute install.sh's and uninstall.sh's own shell
# code instead of reading it as text — completion_install_contract runs
# the marked slices against a throw-away $HOME with a stub horus on PATH.
Expand Down
10 changes: 9 additions & 1 deletion .github/workflows/docs-contract.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,14 @@ env:
# Verifying a different docs commit means bumping this SHA in a PR, so the
# change is reviewed here before it runs here.
#
# Bumped from 4a612b1 to 9a1a0c1 (horus-docs main, the merge of
# horus-docs#17). That PR is the documentation half of the same bidirectional
# audit this branch is the code half of, so the two belong at the same pin:
# against 4a612b1 the contract validates this branch's runtime corrections
# against pages that still describe what the runtime did BEFORE them, which
# is the drift the audit existed to find. Exactly one commit, and 4a612b1 is
# its parent. Verified from this tree: 14 passed, 0 failed.
#
# Bumped from 38368c8 to 4a612b1 (horus-docs main, the merge of
# horus-docs#18), for the same reason 38368c8 replaced af057d9 before it.
# This branch adds six operator-facing variables — HORUS_RECORD_MAX_MB,
Expand All @@ -107,7 +115,7 @@ env:
# it: 14 passed, 0 failed. The bump is 7 commits, not 1 — horus-docs#18 is
# only the newest of them, and that suite result is what says the other six,
# written by other people for other reasons, are compatible with this branch.
DOCS_PINNED_REF: 4a612b108d51308537cdd5c737bbc0181f8354ac
DOCS_PINNED_REF: 9a1a0c107bc2e04b75cbdd08a04462e242285bce

jobs:
# ── Tier 1 ────────────────────────────────────────────────────────────────
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/integration-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ jobs:
# Setup shared memory with proper permissions
- name: Setup Shared Memory
run: |
rm -rf /dev/shm/horus_*
# Create namespaced SHM directory structure
SHM_DIR="/dev/shm/horus_ci_${GITHUB_RUN_ID:-$$}"
# No sudo: sudo mkdir leaves these root-owned, which is what made
Expand Down Expand Up @@ -124,7 +125,7 @@ jobs:
# The gate-logic tests in that file (spread_gate_*, stall_rate_*,
# clean_timing_*) are pure and fast, and DO run here -- they carry no
# timing dependency, so the reasoning above does not apply to them.
cargo test --workspace --exclude horus_py --release --test '*' -- \
cargo test --workspace --exclude horus_py --release --no-fail-fast --test '*' -- \
--test-threads=1 --nocapture \
--skip shm_fanout_latency_percentiles_cross_thread \
--skip stress_rt_isolation_from_compute_nodes \
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/multi-platform.yml
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,7 @@ jobs:

- name: Setup Shared Memory
run: |
rm -rf /dev/shm/horus_*
# Create namespaced SHM directory structure
SHM_DIR="/dev/shm/horus_ci_${GITHUB_RUN_ID:-$$}"
# No sudo: sudo mkdir leaves these root-owned, which is what made
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ jobs:

- name: Set up QEMU (foreign-architecture smoke test)
if: runner.os == 'Linux' && matrix.docker_platform != 'linux/amd64'
uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3.7.0
uses: docker/setup-qemu-action@1f40c72289eff860ee54a304f1438e3cff362e0a # v4.3.0
with:
platforms: ${{ matrix.docker_platform }}

Expand Down Expand Up @@ -350,7 +350,7 @@ jobs:
# one-liner. Runs before the Release is created so a failed attestation
# cannot leave published-but-unattested assets behind.
- name: Attest build provenance
uses: actions/attest-build-provenance@977bb373ede98d70efdf65b84cb5f73e068dcc2a # v3.0.0
uses: actions/attest-build-provenance@4d101475d8b20a2381f78447822ac1eab6504dd8 # v4.2.2
with:
subject-path: |
artifacts/*.tar.gz
Expand All @@ -375,7 +375,7 @@ jobs:
fi

- name: Create / update Release
uses: softprops/action-gh-release@3d0d9888cb7fd7b750713d6e236d1fcb99157228 # v3.0.2
uses: softprops/action-gh-release@efb35369e0ad2afab669f228072c1b0d510eae64 # v3.0.3
with:
tag_name: ${{ steps.tag.outputs.tag }}
generate_release_notes: true
Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ and `Unreleased` is left empty rather than deleted.

## Unreleased

### Fixed

- `horus topic echo`, `hz`, and `bw` now read live macOS POSIX shared-memory
topics through the public topic path.

## [0.4.1] — 2026-09-03

201 commits since 0.4.0 (2026-08-22), against a cadence rule that says cut at
Expand Down
17 changes: 10 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -757,13 +757,16 @@ repository; `:850` notes that neither substitutes for the other.
and line 794 sits inside the `cli-integration` job (`:309`) which is in the
aggregator's needs list (`:1374`).

The exception is `readme_contract.rs`'s `the_readme_quick_start_compiles`,
which is `#[ignore]`d with the reason "run in the docs-contract job"
(`readme_contract.rs:146`). Nothing runs it: no workflow mentions
`readme_contract`, `docs-contract.yml`'s cargo invocations name only the
`docs_*` targets, and `integration-tests.yml:794` passes no
`--include-ignored`. If you change the README's Quick Start, compile it
yourself:
`readme_contract.rs`'s `the_readme_quick_start_compiles` is `#[ignore]`d
with the reason "run in the docs-contract job" (`readme_contract.rs:146`),
and that job does now run it — `docs-contract.yml` invokes
`cargo test -p horus_manager --test readme_contract -- --include-ignored`.

This paragraph previously said the opposite ("Nothing runs it: no workflow
mentions `readme_contract`") and told you to compile the Quick Start by hand.
That was true when it was written and stopped being true when the invocation
was added; the prose was not updated with it. You can still run it locally,
but CI will catch a broken Quick Start without you:

```bash
cargo test -p horus_manager --test readme_contract -- --include-ignored
Expand Down
14 changes: 7 additions & 7 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions benchmarks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ the withdrawn tables dropped, and it is not comparable across kinds:
| `CrossThread-MPMC` | `PodShm` | `send` | Producer-side `send()` cost under contention |
| `CrossProc-1P1C` | `SpscShm` | `one-way` | Pub-to-sub delivery, RDTSC timestamp in payload |
| `CrossProc-2P1C` | `MpscShm` | `one-way` | Pub-to-sub delivery |
| `CrossProc-1PMC` | `SpmcShm` | `one-way` | Pub-to-sub delivery |
| `CrossProc-1PMC` | `PodShm` | `one-way` | Pub-to-sub delivery; one-to-many POD routes to broadcast |
| `CrossProc-PodShm` | `PodShm` | `broadcast` | Latest-value broadcast; readers may skip ahead |
| `RawAtomic` | — | `one-way` | Raw SHM atomic store/load — the hardware floor |

Expand Down Expand Up @@ -104,7 +104,7 @@ sudo cpupower frequency-set -g performance
echo 1 | sudo tee /sys/devices/system/cpu/intel_pstate/no_turbo
```

> Cross-process paced benchmarks (SpscShm, MpscShm, PodShm) are heavily affected by OS scheduling under `powersave` governor. The SpmcShm path (seqlock broadcast) is least affected since readers don't block.
> Cross-process paced benchmarks (SpscShm, MpscShm) are heavily affected by OS scheduling under `powersave` governor. The `PodShm` broadcast path is least affected, since its readers do not block — a one-to-many POD topology resolves to `PodShm`, not `SpmcShm`, which is why no row above names the latter.

## License

Expand Down
22 changes: 14 additions & 8 deletions docs/TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -544,8 +544,8 @@ coverage, and gates nothing.
| `cli_runtime_integration` (18 ignored), `launch_and_workflow` (5), `real_project_ipc` (3) | `horus_core/tests/` | need a debug build of `-p horus --examples` plus `horus_manager` that no job produces (`integration-tests.yml:160-166`) |
| `transient_subscribers_permanently_flip_a_topic_to_a_lossy_backend` | `participant_count_leak.rs:62` | `#[ignore]`d with the reason "documents an open defect" |
| `naive_protocol_tears_proving_the_model_can_detect_it` | `loom_pod_broadcast.rs:225` | deliberately excluded (`integration-tests.yml:186`); it is supposed to fail, so running it in CI would be wrong — but nothing checks that it *still* fails |
| `docs_parity` | `horus_manager/tests/docs_parity.rs` | all three of its tests are `#[ignore]`d with the reason "needs a horus-docs checkout; wired into the docs-contract workflow" (`:193,:259,:336`). `grep -rn docs_parity .github/` returns nothing. The suite that exists to catch *undocumented* new surface never runs |
| `readme_contract`'s `#[ignore]`d test | `readme_contract.rs:146` | reason: "slow: builds a scratch crate; run in the docs-contract job". That job does not name the target. The other 10 tests in the file do run, via `integration-tests.yml:794` |
| `docs_parity` | `horus_manager/tests/docs_parity.rs` | all three tests are `#[ignore]`d with the reason "needs a horus-docs checkout; wired into the docs-contract workflow" (`:193,:259,:336`) — and it **is** wired: `docs-contract.yml` runs `cargo test -p horus_manager --test docs_parity -- --ignored --nocapture`. This row previously read "`grep -rn docs_parity .github/` returns nothing … never runs", which was true when written and was falsified by the commit that added the invocation |
| `readme_contract`'s `#[ignore]`d test | `readme_contract.rs:146` | reason: "slow: builds a scratch crate; run in the docs-contract job". That job **does** name the target now (`docs-contract.yml`, `--include-ignored`); this row previously said it did not. The other 10 tests in the file also run, via `integration-tests.yml:794` |
| `cpp_toolchain_contract`'s `#[ignore]`d test | `cpp_toolchain_contract.rs:464` | reason: "slow: cross-compiles horus_cpp; run with `--ignored`". Nothing does. The other 19 run |
| `.config/nextest.toml` | repo root config | a fully worked per-test timeout guard (60 s × 3 hard kill at `:50`, `test-threads = 1` at `:66`, `retries = 0` at `:70`, `leak-timeout = "500ms"` at `:77`, a `ci` profile with JUnit output at `:83-101` and a `soak` profile at `:103-110`) that no workflow uses — `grep -rn nextest .github/` returns nothing, and no markdown mentions it |
| `horus_manager/tests/web_e2e/` | Puppeteer suite, `package.json:5-7` | referenced only by `.github/dependabot.yml:105`, whose own comment records that no CI workflow runs the suite and that puppeteer is `hasInstallScript: true`, so the dependency graph is exercised exclusively on workstations |
Expand All @@ -554,12 +554,18 @@ coverage, and gates nothing.
| `tests/docker/run_all.sh` | repo `tests/docker/` | `docker-distro-tests.yml:43-61` builds the five Dockerfiles and runs the image `CMD` and `test_user_workflow.sh` directly; `run_all.sh` is unreferenced. `acceptance_linux_macos.sh` and `acceptance_windows.ps1` beside it *are* used, by `cross-platform-parity.yml` and `distribution.yml` |
| `horus_core`'s doctests | 13 blocks tagged ```` ```rust ```` and one ```` ```no_run ```` in `horus_core/src` | see below |

Three of these are worse than merely unrun, and the distinction matters when you
are deciding what to fix first: `docs_parity`, `readme_contract` and
`cpp_toolchain_contract` carry `#[ignore]` *reason strings asserting they are
wired*. A reader of the source has no way to discover otherwise short of
grepping the workflows. If you add an `#[ignore]` with a reason naming a
workflow, add the invocation in the same commit.
`cpp_toolchain_contract` carries an `#[ignore]` *reason string asserting it is
wired* while nothing runs it, and a reader of the source has no way to discover
that short of grepping the workflows. If you add an `#[ignore]` whose reason
names a workflow, add the invocation in the same commit.

`docs_parity` and `readme_contract` used to be listed here for the same fault
and have since been wired up — which exposed the mirror-image hazard this table
now demonstrates twice over. **A table asserting that something is unrun is
itself untested prose, and it rots in the direction that wastes a newcomer's
time**: it sends them to hand-run a suite CI already covers, and it teaches them
to distrust the workflows. Re-derive the rows against
`grep -rn '<target>' .github/` before relying on any of them.

**On `nextest.toml`.** Its stated premise has partly expired: it says at `:8`
that "None of the jobs in `.github/workflows/ci.yml` set `timeout-minutes`", and
Expand Down
5 changes: 4 additions & 1 deletion horus_core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ tracing = "0.1"
parking_lot = "0.12"
chrono = { workspace = true }
uuid = { version = "1.0", features = ["v4", "serde"] }
dirs = "6.0"
dirs = "7.0"
lazy_static = "1.4"
rand = { workspace = true, features = ["small_rng"] }

Expand Down Expand Up @@ -75,6 +75,9 @@ horus-tf = { git = "https://github.com/softmata/horus-tf.git", rev = "d525dfcf58
workspace = true

[features]
# Render the crate-internal modules in rustdoc. Docs-only: it gates nothing
# but `#[doc(hidden)]`, so it changes no code and no dependency.
internal-docs = []
default = ["macros", "telemetry", "blackbox"]
macros = ["horus_macros"]

Expand Down
14 changes: 11 additions & 3 deletions horus_core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,17 @@ caught it (`rt_allocator.rs:21-26`, `rt_alloc_guard_installed.rs:35-38`).
## How to read the internals

`--document-private-items` is **not** enough on its own. It disables rustdoc's
private-stripping pass, not its hidden-stripping pass, so the eleven hidden
modules stay stripped. You need nightly and `--document-hidden-items`, which is
unstable and refuses to run without `-Z unstable-options`:
private-stripping pass, not its hidden-stripping pass, so the hidden modules
stay stripped. Use the `internal-docs` feature, which lifts the
`#[doc(hidden)]` attributes and works on stable:

```sh
cargo doc -p horus_core --no-deps --document-private-items \
--features internal-docs --open
```

The nightly form below still works and needs no feature, but it requires a
nightly toolchain and an unstable flag, which is why the feature exists:

```sh
RUSTDOCFLAGS="-Z unstable-options --document-hidden-items" \
Expand Down
5 changes: 3 additions & 2 deletions horus_core/src/communication/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ pub use topic::{set_topic_verbose, TOPIC_VERBOSE_OFFSET};
// Ring-buffer inspector for CLI tools (`horus topic echo`)
#[doc(hidden)]
pub use topic::{
read_latest_slot_bytes, read_slots_since, read_topic_header_info, read_topic_messages_total,
read_topic_sequence, shm_map_count, TopicHeaderInfo, TopicReader, TopicSlotRead,
peek_topic_type_name, read_latest_slot_bytes, read_slots_since, read_topic_header_info,
read_topic_messages_total, read_topic_sequence, shm_map_count, TopicHeaderInfo, TopicReader,
TopicSlotRead,
};

// Topic lifecycle hook for horus_net network replication
Expand Down
Loading
Loading