Skip to content

Proposals: dependency protocols, comline.packet@1, IPC framings, doc links - #174

Merged
Kinflou merged 1 commit into
mainfrom
proposals/dependency-protocols
Nov 14, 2026
Merged

Kinflou merged 1 commit into
mainfrom
proposals/dependency-protocols

Conversation

@Kinflou

@Kinflou Kinflou commented Nov 14, 2026

Copy link
Copy Markdown
Member

Proposal pages from 2026-11-14, with the decisions recorded in them. Closes #173.

Dependency protocols (new section)

proposals/dependency-protocols/ answers which numbers address a dependency's protocol on a connection, and which version the handshake checks it against.

  • Step 0: a protocol the package doesn't reach isn't addressed (generation#143).
  • Part 1, accepted: profiles state their facts (including a new one_way fact) and limits; capabilities are derived from them (core#276).
  • A, accepted: a multi-package handshake comline@3 with a new datagram@4 framing. A dependency's protocol joins by use, and dual-accept (accept_previous) is opt-in in the shared runtime core (core#277).
  • C, accepted: a connection per package.
  • B, rejected as a default.

Packet dispatch

packet-dispatch.md moves to packet-dispatch/index.md. A new page, comline.packet@1, is the official packet framing, with its layout decided as P1–P9 (core#123).

IPC

New Framings section: what IPC asks of a framing, and Comline's own framings over IPC.

  • The transport ties handles to a frame (T1).
  • Every child channel starts with a handshake.
  • A shared-memory ring marks frames with handles.
  • D-Bus is the first platform framing.

Automatic documentation

auto-documentation.md moves to auto-documentation/index.md. A new draft page covers links to dependencies' docs and the reference for built-ins, the overview with the configuration, and highlighting everywhere code appears (generation#144). It amends the "comline.toml only" config decision, and that amendment still needs approval.

Notes

  • Inbound links and the nav follow the two moves.
  • zensical build --strict passes locally, and the unrendered-template check is clean.
  • The reference restructure in progress locally (reference/package/…, the per-version datagram pages) isn't in this PR. Four links that would point into it link to the current pages instead, and the types reference is named but not linked.

…links

- dependency-protocols/: which numbers address a dependency's protocol on a
  connection. Decided 2026-11-14: step 0 (unreached protocols aren't
  addressed), Part 1 (profile facts, `one_way`, `limits`, capabilities),
  A (`comline@3` with `datagram@4`) and C (a connection per package)
  accepted, B rejected (core#276, core#277, generation#143).
- packet-dispatch/comline.packet@1.md: the official packet framing, its
  layout decided (P1-P9, core#123). packet-dispatch.md moves to
  packet-dispatch/index.md.
- ipc.md: framings over IPC. The transport ties handles to a frame, every
  child channel starts with a handshake, a shared-memory ring marks frames
  with handles, and D-Bus is the first platform framing.
- auto-documentation/links-overview-highlighting.md (draft): links to
  dependencies' and built-ins' docs, the overview with the configuration,
  and highlighting everywhere (generation#144). auto-documentation.md
  moves to auto-documentation/index.md.

Inbound links and the nav follow the two moves.
@Kinflou
Kinflou merged commit 5258e69 into main Nov 14, 2026
8 checks passed
@Kinflou
Kinflou deleted the proposals/dependency-protocols branch November 14, 2026 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Publish the dependency-protocols, comline.packet@1, IPC and auto-doc proposals

1 participant