Skip to content

Commit 95f2884

Browse files
committed
docs: Correct glossary definition of "crank"
1 parent fe98131 commit 95f2884

1 file changed

Lines changed: 11 additions & 10 deletions

File tree

docs/glossary.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,15 @@ kernel's storage methods.
4646

4747
An object registered with the [kernel](#kernel) that [vats](#vat) can invoke via `E()`.
4848
Kernel services run in the kernel's own context (not in a vat) and are registered using
49-
`kernel.registerKernelServiceObject()`. Services marked `systemOnly` can only be accessed
50-
by [system subclusters](#system-subcluster). See the
49+
`kernel.registerKernelServiceObject()`. Because service implementations do not participate
50+
in the kernel's reference management, they cannot return [exos](#exo). Services marked
51+
`systemOnly` can only be accessed by [system subclusters](#system-subcluster). See the
5152
[KernelServiceManager](../packages/ocap-kernel/src/KernelServiceManager.ts).
5253

5354
### supervisor
5455

55-
A component that manages the lifecycle and communication of a [vat](#vat). The
56-
[VatSupervisor](../packages/ocap-kernel/src/VatSupervisor.ts) handles [message
56+
A kernel-space component that manages the lifecycle and communication of a [vat](#vat).
57+
The [VatSupervisor](../packages/ocap-kernel/src/VatSupervisor.ts) handles [message
5758
delivery](#delivery), [syscalls](#syscall), and vat initialization.
5859

5960
### liveslots
@@ -65,8 +66,8 @@ runtime environment for vat code and handles object persistence, promise managem
6566
### crank
6667

6768
A single execution cycle in the kernel's [run queue](#run-queue). Each crank processes one
68-
item from the run queue, delivering messages or notifications to [vats](#vat). Cranks can
69-
be aborted and rolled back if errors occur. See the
69+
item from the run queue, delivering a single message or notification to [a vat](#vat).
70+
Cranks can be aborted and rolled back if errors occur. See the
7071
[KernelQueue](../packages/ocap-kernel/src/KernelQueue.ts) for the run loop implementation.
7172

7273
### syscall
@@ -78,9 +79,9 @@ persistent storage. See [VatSyscall](../packages/ocap-kernel/src/VatSyscall.ts)
7879

7980
### delivery
8081

81-
The process of sending a message or notification to a [vat](#vat). Deliveries can be of
82-
type 'message', 'notify', 'dropExports', 'retireExports', 'retireImports', or
83-
'bringOutYourDead'. See the [router](#router)
82+
The process of sending a message or notification to a [vat](#vat) in a [crank](#crank).
83+
Deliveries can be of type 'message', 'notify', 'dropExports', 'retireExports',
84+
'retireImports', or 'bringOutYourDead'. See the [kernel router](#kernel-router)
8485
([KernelRouter](../packages/ocap-kernel/src/KernelRouter.ts)) for delivery logic.
8586

8687
### marshaling
@@ -152,7 +153,7 @@ this queue. See the [KernelQueue](../packages/ocap-kernel/src/KernelQueue.ts) cl
152153
[queue methods](../packages/ocap-kernel/src/store/methods/queue.ts) for implementation
153154
details.
154155

155-
### router
156+
### kernel router
156157

157158
The component responsible for routing messages to the correct [vat](#vat) based on target
158159
references and promise states. The router handles [delivery](#delivery) logic. See the

0 commit comments

Comments
 (0)