Add sbintime.9 manual page
Needs ReviewPublic
Actions

Authored by khng on Sun, Jun 28, 9:36 PM.

Details

Reviewers

imp
ziaee

Group Reviewers

manpages

Summary

sbintime.9 is a manual page that documents the usage of sbintime_t and
its helper functions.

MFC after: 1 week

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 74366
Build 71249: arc lint + arc unit

Event Timeline

khng created this revision.Sun, Jun 28, 9:36 PM

Herald added a subscriber: ziaee. · View Herald TranscriptSun, Jun 28, 9:36 PM

khng requested review of this revision.Sun, Jun 28, 9:36 PM

Harbormaster completed remote builds in B74365: Diff 180887.Sun, Jun 28, 9:36 PM

ziaee added inline comments.Sun, Jun 28, 10:09 PM

share/man/man9/sbintime.9
2–25	This is the updated preferred license in our license guide and style.9

ziaee added a reviewer: manpages.Sun, Jun 28, 10:09 PM

Addressed ziaee@'s comments.

Harbormaster completed remote builds in B74366: Diff 180888.Sun, Jun 28, 10:25 PM

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
65	We usually use imperative tone across our docs
71
78	ditto
85	ditto
91	ditto
96	ditto
102	ditto
107	ditto
113	ditto
118	ditto
125	ditto
132	ditto
139	ditto

Addressed ziaee@'s comments.

Harbormaster completed remote builds in B74371: Diff 180897.Sun, Jun 28, 11:58 PM

Editorial looks good from manpages but I'd wait for someone who understands sbintime to review also. Thanks for writing this!

This revision is now accepted and ready to land.Mon, Jun 29, 1:40 AM

markj added a subscriber: markj.Wed, Jul 1, 7:08 PM

markj added inline comments.

share/man/man9/sbintime.9
62	IMO it'd be helpful to state the unit: the lower 32 bits are counting with a base unit of 1/2^{32} seconds, so (sbintime_t)0x1 corresponds to ~0.25ns. At least, that's my understanding.
150	Probably at least bintime.9 and callout.9 should link back to this page.