doc/ipc: copyedits #278
Merged
doc/ipc: copyedits #278
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cbiffle
reviewed
Nov 30, 2021
| @@ -272,7 +272,7 @@ A concrete mapping of these operations to IPCs might go as follows. | |||
|
|
|||
| - Message is a four-byte struct containing `fd` as a little-endian `u32`. Borrow | |||
| 0 is `buffer` and must be writable. | |||
| - Data will be written to a prefix of borrow 0, starting at offset 0. | |||
| - Data will be written to a prefix of lease 0, starting at offset 0. | |||
There was a problem hiding this comment.
Both are technically correct here, since "borrow" is the term used at the server side, while "lease" is from the client's perspective. I'm happy to accept this change though since this section is a little informal, and the old usage clearly surprised you.
| @@ -309,7 +309,7 @@ fn read(task: TaskId, fd: u32, buffer: &mut [u8]) -> Result<usize, IoError> { | |||
| let (rc, len) = sys_send( | |||
| task, | |||
| 0, | |||
| &u32.to_le_bytes(), | |||
| &fd.to_le_bytes(), | |||
cbiffle
reviewed
Dec 3, 2021
doc/timers.adoc
Outdated
| @@ -35,7 +35,7 @@ Each task gets a timer. The timer has three properties: | |||
| - A _notification set._ | |||
|
|
|||
| At periodic intervals (ticks), if the enable bit is set, the kernel checks the | |||
| deadline to see if it is in the future. If not (it is `<=` the current time), | |||
| deadline to see if it is in the future. If not (it is \<=; the current time), | |||
There was a problem hiding this comment.
Sorry to round trip this again, but, \<=; produces <=; in the HTML output -- this needs to be just \<= without the semicolon.
There was a problem hiding this comment.
You might want to keep the backticks here.
See this example: https://gist.github.com/fernandogmo/34032124e94c6b383277decd8631c687
This was referenced Dec 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The protocol uses leases, the Rust code uses borrows.