Skip to content

Fix doc links in transport negotiation docs#1592

Merged
oferchen merged 1 commit into
masterfrom
fix-cargo-doc-exit-code-101
Oct 29, 2025
Merged

Fix doc links in transport negotiation docs#1592
oferchen merged 1 commit into
masterfrom
fix-cargo-doc-exit-code-101

Conversation

@oferchen
Copy link
Copy Markdown
Owner

Summary

  • fix broken intra-doc links in transport negotiation buffer and stream docs
  • point references at the exported NegotiatedStream and protocol sniffer types to keep rustdoc happy

Testing

  • cargo --locked run -p xtask -- docs --validate

https://chatgpt.com/codex/tasks/task_e_69028e55c26c83239968e494660e9797

@oferchen oferchen merged commit 8a9a273 into master Oct 29, 2025
@oferchen oferchen deleted the fix-cargo-doc-exit-code-101 branch October 29, 2025 22:07
oferchen added a commit that referenced this pull request May 5, 2026
#1592) (#3719)

Static, code-only audit enumerating every synchronisation channel on
the receiver-side transfer hot path, classifying each as hot or cold,
deriving ops-per-message from the source, and comparing against
upstream's single-threaded recv_files() loop. Defers all spin-budget,
park/wake, and allocator-impact questions to runtime measurements
listed in section 8.
oferchen added a commit that referenced this pull request May 7, 2026
* docs(audits): static analysis of channel overhead in transfer hot path (#1592)

Static, code-only audit enumerating every synchronisation channel on
the receiver-side transfer hot path, classifying each as hot or cold,
deriving ops-per-message from the source, and comparing against
upstream's single-threaded recv_files() loop. Defers all spin-budget,
park/wake, and allocator-impact questions to runtime measurements
listed in section 8.

* docs(audits): Rust 2024 edition migration plan
oferchen added a commit that referenced this pull request May 7, 2026
…th (#1592) (#3885)

Document remaining std::sync::mpsc and sync_channel sites in the
transfer/engine hot path, suspected sources of overhead (parking
wakeups, allocator contention, cursor false sharing), a criterion
plus perf c2c profile plan, and a per-site migration decision.
oferchen added a commit that referenced this pull request May 17, 2026
…ems (#4203)

Add a criterion bench that compares per-item send+recv cost across
`std::sync::mpsc::channel`, `crossbeam_channel::unbounded`, and
`crossbeam_channel::bounded(1024)` at 100K items. Sweeps payload sizes
{32 B, 256 B, 4 KB} and thread shapes {1S+1R, 4S+1R, 1S+4R, 4S+4R} to
expose the contention regimes that appear in the engine and receiver
pipelines. Payloads are pre-allocated outside the timed section so the
measurement isolates channel cost from allocation. Throughput is
reported via `Throughput::Elements(100_000)` so the criterion summary
gives items/sec directly.

Pure userspace synchronisation - no I/O, no platform-specific paths,
runs identically on Linux, macOS, and Windows.

Refs #1592 #1681 #1370
oferchen added a commit that referenced this pull request May 18, 2026
#1592) (#3719)

Static, code-only audit enumerating every synchronisation channel on
the receiver-side transfer hot path, classifying each as hot or cold,
deriving ops-per-message from the source, and comparing against
upstream's single-threaded recv_files() loop. Defers all spin-budget,
park/wake, and allocator-impact questions to runtime measurements
listed in section 8.
oferchen added a commit that referenced this pull request May 18, 2026
* docs(audits): static analysis of channel overhead in transfer hot path (#1592)

Static, code-only audit enumerating every synchronisation channel on
the receiver-side transfer hot path, classifying each as hot or cold,
deriving ops-per-message from the source, and comparing against
upstream's single-threaded recv_files() loop. Defers all spin-budget,
park/wake, and allocator-impact questions to runtime measurements
listed in section 8.

* docs(audits): Rust 2024 edition migration plan
oferchen added a commit that referenced this pull request May 18, 2026
…th (#1592) (#3885)

Document remaining std::sync::mpsc and sync_channel sites in the
transfer/engine hot path, suspected sources of overhead (parking
wakeups, allocator contention, cursor false sharing), a criterion
plus perf c2c profile plan, and a per-site migration decision.
oferchen added a commit that referenced this pull request May 18, 2026
…ems (#4203)

Add a criterion bench that compares per-item send+recv cost across
`std::sync::mpsc::channel`, `crossbeam_channel::unbounded`, and
`crossbeam_channel::bounded(1024)` at 100K items. Sweeps payload sizes
{32 B, 256 B, 4 KB} and thread shapes {1S+1R, 4S+1R, 1S+4R, 4S+4R} to
expose the contention regimes that appear in the engine and receiver
pipelines. Payloads are pre-allocated outside the timed section so the
measurement isolates channel cost from allocation. Throughput is
reported via `Throughput::Elements(100_000)` so the criterion summary
gives items/sec directly.

Pure userspace synchronisation - no I/O, no platform-specific paths,
runs identically on Linux, macOS, and Windows.

Refs #1592 #1681 #1370
oferchen added a commit that referenced this pull request May 18, 2026
…ems (#4203)

Add a criterion bench that compares per-item send+recv cost across
`std::sync::mpsc::channel`, `crossbeam_channel::unbounded`, and
`crossbeam_channel::bounded(1024)` at 100K items. Sweeps payload sizes
{32 B, 256 B, 4 KB} and thread shapes {1S+1R, 4S+1R, 1S+4R, 4S+4R} to
expose the contention regimes that appear in the engine and receiver
pipelines. Payloads are pre-allocated outside the timed section so the
measurement isolates channel cost from allocation. Throughput is
reported via `Throughput::Elements(100_000)` so the criterion summary
gives items/sec directly.

Pure userspace synchronisation - no I/O, no platform-specific paths,
runs identically on Linux, macOS, and Windows.

Refs #1592 #1681 #1370
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant