sbintime.9 is a manual page that documents the usage of sbintime_t and
its helper functions.
MFC after: 1 week
Details
Details
Diff Detail
Diff Detail
- Repository
- rG FreeBSD src repository
- Lint
Lint Skipped - Unit
Tests Skipped - Build Status
Buildable 74365 Build 71248: arc lint + arc unit
Event Timeline
| share/man/man9/sbintime.9 | ||
|---|---|---|
| 1–24 | This is the updated preferred license in our license guide and style.9 | |
Comment Actions
Found another minor grammatical nit. I don't really understand enough to know why we would choose "a" or "the" for these. Also, would you please "Relnotes: yes" this?
| share/man/man9/sbintime.9 | ||
|---|---|---|
| 66 | We usually use imperative tone across our docs | |
| 72 | ||
| 79 | ditto | |
| 86 | ditto | |
| 92 | ditto | |
| 97 | ditto | |
| 103 | ditto | |
| 108 | ditto | |
| 114 | ditto | |
| 119 | ditto | |
| 126 | ditto | |
| 133 | ditto | |
| 140 | ditto | |
Comment Actions
Editorial looks good from manpages but I'd wait for someone who understands sbintime to review also. Thanks for writing this!
Comment Actions
Looks basically good. Just a couple of points, the biggest one is to use an approximation to help people reason and think about the quantity w/o burdening them with the exact value.
| share/man/man9/sbintime.9 | ||
|---|---|---|
| 65 | I'd be tempted to just round it and say 'just under 250 picoseconds'. That helps people reason about the numbers they are seeing, has the useful approximation of #/4 is nano seconds. If you want the exact value, you can do the math. | |
| 73 | I'd be tempted to say 'whole number' instead of number here to emphasize that we're truncating the value to the number of seconds. | |
| 94 | all the Xstosbt are designed to do the math w/o large truncation errors that are possible with naive math to do the conversion. Maybe say that somewhere? | |
Comment Actions
- Incorporated imp@'s suggestions
- Mentioned that Xstosbt functions were introduced in 14.0
Comment Actions
I don't understand why this man page (or any section 9 page) needs to be mentioned in the release notes. It's just documenting some internals, nothing that anyone other than a kernel developer might care about...
Comment Actions
The new doc is a new feature we spent expert time to develop during the release. We do put the doc section at the bottom since it's kind of niche, but some readers get excited about them, and it gets more eyes on it.