docs: correct the local image path to the socket #203

Merged

natsukium merged 1 commit from docs/shm-contradiction-194 into main 2026-09-07 22:01:16 +09:00

Conversation 0 Commits 1 Files changed 2 +9 -1

natsukium commented 2026-09-07 21:56:52 +09:00

Owner

Copy link

Fixes #194.

The IPC explanation justified deferring heavy-payload rendering suppression with "locally, image bytes already travel over shm", which the architecture overview's "No shared memory" section flatly contradicts and the code never implemented. Daemon-to-client pixels are ImageMsg::Chunk frames copied into every window subscriber's socket; the only shm in felis is the Kitty t=s producer-to-daemon transfer, which ends at the image store. The deferral itself survives, but now rests on an unmeasured local cost rather than an imagined zero one (principle 2).

Doc cascade: docs/explanation/architecture/ipc.md drops the false shm premise and names the real local cost; docs/explanation/architecture/overview.md makes the "No shared memory" section state where the one shm path begins and ends, so the two pages can no longer be read as contradicting each other. Docs-only change — no reference twin states the corrected fact, and no wire or config surface moves.

Verified: just check green (fmt, clippy, nextest, deny, proto-compat); reviewed by pi luna + pi sol; docs proofread by Gemini gemini-3.8-flash-high

Follow-ups

• #200 Issue #120 still rests on the false local-shm premise corrected by #194

Deferred

• Apply the correction to the body of issue #120 (drop the "locally, image bytes travel over shm and the waste is marginal" clause; keep the deferral; add the same-host one-socket-copy-per-image cost as the second number to measure). Reason: both fj write paths to #120 were blocked by the local permission classifier, not by Forgejo. The prepared replacement body and an equivalent comment are staged locally and can be applied with one fj call; tracked as #200. #120's own scope is unchanged.

Fixes #194. The IPC explanation justified deferring heavy-payload rendering suppression with "locally, image bytes already travel over shm", which the architecture overview's "No shared memory" section flatly contradicts and the code never implemented. Daemon-to-client pixels are `ImageMsg::Chunk` frames copied into every window subscriber's socket; the only shm in felis is the Kitty `t=s` producer-to-daemon transfer, which ends at the image store. The deferral itself survives, but now rests on an unmeasured local cost rather than an imagined zero one (principle 2). Doc cascade: `docs/explanation/architecture/ipc.md` drops the false shm premise and names the real local cost; `docs/explanation/architecture/overview.md` makes the "No shared memory" section state where the one shm path begins and ends, so the two pages can no longer be read as contradicting each other. Docs-only change — no reference twin states the corrected fact, and no wire or config surface moves. Verified: just check green (fmt, clippy, nextest, deny, proto-compat); reviewed by pi luna + pi sol; docs proofread by Gemini gemini-3.8-flash-high ## Follow-ups - #200 Issue #120 still rests on the false local-shm premise corrected by #194 ## Deferred - Apply the correction to the body of issue #120 (drop the "locally, image bytes travel over shm and the waste is marginal" clause; keep the deferral; add the same-host one-socket-copy-per-image cost as the second number to measure). Reason: both `fj` write paths to #120 were blocked by the local permission classifier, not by Forgejo. The prepared replacement body and an equivalent comment are staged locally and can be applied with one `fj` call; tracked as #200. #120's own scope is unchanged.

natsukium added 1 commit 2026-09-07 21:56:52 +09:00

docs: correct the local image path to the socket ... 0a51853f29

The IPC explanation justified deferring heavy-payload suppression with
"locally, image bytes already travel over shm", which the architecture
overview's "No shared memory" section flatly contradicts and the code
never implemented: daemon-to-client pixels are ImageMsg::Chunk frames
copied into every window subscriber's socket, and the only shm in felis
is the Kitty t=s producer-to-daemon transfer that ends at the image
store. A downstream client author was already sent looking for a local
shm path that does not exist.

The deferral survives on its own terms, but resting on an unmeasured
local cost rather than an imagined zero one, per principle 2.

Refs #194

natsukium merged commit 0a51853f29 into main 2026-09-07 22:01:16 +09:00

natsukium deleted branch docs/shm-contradiction-194 2026-09-07 22:01:17 +09:00

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

priority/P0

Must be resolved before the v0.1.0 tag

  

priority/P1

Must be settled before the first public contract freezes

  

priority/P2

Explicitly deferred until after v0.1.0

  

release/v0.1.0

Work tracked for the first tagged release

  

status/blocked

Cannot start now: waits on an upstream release, another issue, or a recorded revisit trigger

  

status/planned

Triaged with a source-grounded plan and a passed pi review; ready to implement

  

type/bug

Shipped behavior that contradicts the docs or the code's own intent; needs a product code change

  

type/design

An open scope or trade-off question; needs a recorded decision in the owning explanation doc before code

  

type/test-gap

Documented or reviewed behavior that no test pins; usually split from a review finding, needs no product code change

  

type/tracker

Parent issue that tracks child work

No labels

priority/P0

priority/P1

priority/P2

release/v0.1.0

status/blocked

status/planned

type/bug

type/design

type/test-gap

type/tracker

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

natsukium/felis!203

No description provided.