Skip to content

Commit f0bf08e

Browse files
committed
docs(rng-buf): Fix encoding in README
Replace smart quotes with ASCII quotes and backticks and fix minor grammatical issues in the RNG buffer proposal README.
1 parent 03937a7 commit f0bf08e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

proposals/0001-rng-buf/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -206,9 +206,9 @@ with atomic publishing of flags ensure that the other side will never observe a
206206
- Driver: Write descriptor fields ? memory barrier ? atomic Release-store flags
207207
- Device: Atomic Acquire-load flags ? memory barrier ? read descriptor fields
208208

209-
Because the packed ring reuses the same descriptor slot for both “available” and “used” states and both
210-
sides only poll a single next slot, each side needs to differentiate between “this change belongs to
211-
the current lap in the ring” and “this is an old value from the previous lap.” This is done using
209+
Because the packed ring reuses the same descriptor slot for both `available` and `used` states and both
210+
sides only poll a single next slot, each side needs to differentiate between "this change belongs to
211+
the current lap in the ring" and "this is an old value from the previous lap." This is done using
212212
"wrap" counters:
213213

214214
- Each side keeps a boolean "wrap" flag that toggles when it passes the last descriptor in the ring,
@@ -230,12 +230,12 @@ Each of these memory regions begins with an 8-byte header that stores a relative
230230
the next free byte in the stack.
231231

232232
When pushing, the payload which is flatbuffer-serialized message is written at the current stack
233-
pointer, followed by the 8-byte footer that containins just written payload’s starting offset.
233+
pointer, followed by the 8-byte footer that containins just written payload's starting offset.
234234
Finally, the header is advanced to point past the footer. This makes each item a pair of
235235
`payload + back-pointer`, so the top of the stack can always be found in O(1) without extra
236236
metadata.
237237

238-
Popping from the stack mirrors this process. The guest reads stack pointer from the input stack’s
238+
Popping from the stack mirrors this process. The guest reads stack pointer from the input stack's
239239
header. It then reads the 8-byte back-pointer located just before stack pointer to get last element
240240
offset in the buffer. It treats the slice starting at that offset as the flatbuffer-serialized
241241
payload. The last step is to deserialize the slice, rewind the stack pointer to just consumed
@@ -360,7 +360,7 @@ attempt to snapshot a sandbox with such pending requests will result in a snapsh
360360
- Do not support indirect descriptor table (can be deffered to future work if needed),
361361
- Do not support feature negotiation, set of features is fixed for driver and device,
362362
- Only support packed queue,
363-
- Introduce inline data optimization in descriptor (only if benchmarks supports the claim)
363+
- Introduce inline data optimization in descriptor (only if benchmarks support the claim)
364364

365365
### Type System Design
366366

0 commit comments

Comments
 (0)