laantungir/fips
1
0
Fork 0
mirror of https://github.com/jmcorgan/fips.git synced 2026-10-05 19:18:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Stop citing a design document that is not in the repository

Browse Source 
Three comments in the control snapshot module pointed readers at a
fast-path design note that exists only in my working notes and is not a
blob at any branch. Each now states the thing the document was cited for,
so the comment stands on its own.

The fourth citation, in the read handle's module doc, stays for now: the
sentence around it is also wrong about when queries read the handle, and
correcting the path alone would commit the false half. That whole block is
replaced together in a later change.
This commit is contained in:
Johnathan Corgan
2026-08-16 07:08:40 +00:00
parent b2ad24363f
commit 005942f141
1 changed files with 5 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/control/snapshot.rs
+5 -8
View File
@@ -1,8 +1,7 @@
//! Read-side state snapshots published from the node's natural mutators so
//! pure-snapshot `show_*` queries render off the rx_loop hot path.
//!
//! [`StatsSnapshot`] is the R2 reference implementation of the canonical
//! snapshot pattern (see `design/fast-path-refactoring-r0-read-handle.md`): a
//! [`StatsSnapshot`] is the reference implementation of the canonical snapshot pattern: a
//! read-only data bundle published via `ArcSwap` from the tick after
//! `StatsHistory::tick()`. It carries
//!
@@ -145,8 +144,8 @@ fn empty_acl_status() -> PeerAclStatus {
/// the pure-snapshot `show_tree` / `show_bloom` / `show_cache` / `show_routing`
/// / `show_identity_cache` queries render. Published via `ArcSwap`.
///
/// The R0 stub (`design/fast-path-refactoring-r0-read-handle.md`) names a
/// single combined `ArcSwap<RoutingSnapshot>` for R3. This is that cell: one
/// This is the single combined `ArcSwap<RoutingSnapshot>` cell for the routing
/// subsystems: one
/// cohesive routing view holding the four subsystems (tree / bloom / coord
/// cache / identity cache) plus the F-queue summary scalars.
///
@@ -405,10 +404,8 @@ pub(crate) struct IdentityRow {
/// `show_connections` / `show_transports` / `show_mmp` queries render.
/// Published via `ArcSwap`.
///
/// The R0 stub (`design/fast-path-refactoring-r0-read-handle.md`) pre-scopes
/// R4 as `entities — ArcSwap<EntitySnapshot>: peers / sessions / links /
/// connections / transports, published per-entity with `Vec<Arc<Row>>`
/// structural sharing`. This is that cell.
/// This is the `entities` cell: peers / sessions / links / connections /
/// transports, published per-entity with `Vec<Arc<Row>>` structural sharing.
///
/// **Structural sharing (the umbrella mandate).** Every entity table is a
/// `Vec<Arc<Row>>`, so a republish in which only one row changed re-allocates