Page MenuHomeFreeBSD

Document stack_save_td and stack_save_td_running.
ClosedPublic

Authored by markj on Jul 29 2015, 9:56 PM.
Tags
None
Referenced Files
Unknown Object (File)
Feb 28 2024, 10:49 AM
Unknown Object (File)
Feb 28 2024, 9:04 AM
Unknown Object (File)
Jan 11 2024, 2:09 PM
Unknown Object (File)
Dec 20 2023, 1:47 AM
Unknown Object (File)
Nov 21 2023, 3:10 AM
Unknown Object (File)
Sep 15 2023, 4:14 PM
Unknown Object (File)
Sep 10 2023, 9:16 PM
Unknown Object (File)
Aug 27 2023, 2:44 PM
Subscribers

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

markj retitled this revision from to Document stack_save_td and stack_save_td_running..
markj edited the test plan for this revision. (Show Details)
share/man/man9/stack.9
95 ↗(On Diff #7487)

Do we need this introductory word ? It makes the functions described the second class citizens, at least for my non-native english parser.

100 ↗(On Diff #7487)

locked ? I realized what you mean, but it is too obscure. You should say that the stack is captured for e.g. running thread, and a prerequisite for calling the function is ownership of the thread lock.

wblock added inline comments.
share/man/man9/stack.9
95 ↗(On Diff #7487)

Sentences that start with a pause are halting to read. Maybe rearrange to say

.Fn stack_save_td
​and
​.Fn stack_save_td_running
can also be used ....
99 ↗(On Diff #7487)

I think "can" is better than "may" here. "Can" implies a capability, while "may" implies permission. But it's not really clear which of those this sentence is saying.

102 ↗(On Diff #7487)

"provided that it is" seems unnecessary, can be just "that is".

106 ↗(On Diff #7487)

This is somewhat vague. What happens if it does not succeed?

153 ↗(On Diff #7487)

How about just "on" instead of "upon"?

164 ↗(On Diff #7487)

Again, "may" usually implies permission. Here, "might" could be better, but the sentence is vague. Only the two possibilities are named. Are there others, so this really is that it might be one of these two, or are these the only two error returns?

Probably "is" is better than "may", at least in this case.

is returned if the thread was running...

167 ↗(On Diff #7487)

is returned if the operation is not implemented.

(I think the intent is that EOPNOTSUPP is the return value when the operation is not implemented, not that it is one possible value that might be returned when the operation is not implemented.)

  • Address review comments.
markj marked 5 inline comments as done.Aug 1 2015, 1:33 AM
markj added inline comments.
share/man/man9/stack.9
95 ↗(On Diff #7561)

Hm, I guess my intent was to indicate that they're logically related to stack_save(9). But describing them all in the same paragraph accomplishes that already.

99 ↗(On Diff #7561)

Fixed, but I note that most of the existing text uses "may" instead of "can".

100 ↗(On Diff #7561)

Fixed, thanks.

102 ↗(On Diff #7561)

Fixed, thanks.

106 ↗(On Diff #7561)

I just removed that note - it's covered in the return values section anyway.

151 ↗(On Diff #7561)

Fixed.

162 ↗(On Diff #7561)

These are currently the only two possible error return values, but other architectures could conceivably add others depending on their implementation details.

165 ↗(On Diff #7561)

Indeed, thank you.

wblock added a reviewer: wblock.

Sorry, was under the impression something else was holding this up. Please check with igor and mandoc -Tlint before commit. Thanks!

This revision is now accepted and ready to land.Aug 12 2015, 10:08 PM
This revision was automatically updated to reflect the committed changes.
markj marked 4 inline comments as done.