Page MenuHomeFreeBSD

ntsync.4: add the man page
ClosedPublic

Authored by kib on Fri, Jun 19, 12:52 PM.
Tags
None
Referenced Files
F160504647: D57659.id180091.diff
Thu, Jun 25, 4:44 AM
F160476135: D57659.id180479.diff
Wed, Jun 24, 9:59 PM
F160420979: D57659.diff
Wed, Jun 24, 7:35 AM
Unknown Object (File)
Wed, Jun 24, 2:21 AM
Unknown Object (File)
Tue, Jun 23, 10:21 PM
Unknown Object (File)
Tue, Jun 23, 1:30 AM
Unknown Object (File)
Tue, Jun 23, 1:30 AM
Unknown Object (File)
Tue, Jun 23, 1:09 AM
Subscribers

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

kib requested review of this revision.Fri, Jun 19, 12:52 PM

This is the first version of the man page, written from scratch. There are quite a lot of details that are worth explaining but currently not. I might do it sometime in the future.

share/man/man4/ntsync.4
2

Please prepend a blank comment line for conformance with our style guides and consistency with C style comments.

share/man/man4/ntsync.4
2

Where is it stated in the style.mdoc.5?

I did some grepping of the man pages, and I do not see the empty comment line at the start of the man pages for most cases.

share/man/man4/ntsync.4
2

Where is it stated in the style.mdoc.5?

It has nothing to do with manpages. It is stated in the license guide and in style.9

I did some grepping of the man pages, and I do not see the empty comment line at the start of the man pages for most cases.

Yes, no one listens to me, but it is wrong.

kib marked 2 inline comments as done.Fri, Jun 19, 8:25 PM
kib added inline comments.
share/man/man4/ntsync.4
2

I do not see it in style.9 either.

share/man/man4/ntsync.4
2

the license shown in style.9 has a blank comment line. the actual source of style.9 has a blank line before it. the needs to look the same in every language. i do not understated how this is contestable at all or controversial about this or why someone would want to deviate.

Not sure how welcome is proofreading at this particular stage, but I'll note a few typos. The content itself seems fine.

share/man/man4/ntsync.4
35

waited

46

belongs

148

That's missing a word or two.

154

This is a somewhat awkward sentence, at least when rendered by man.

164

Its size is passed

174

signalling (a typo)

183

a semaphore

kib marked 8 inline comments as done.Fri, Jun 19, 10:23 PM
kib added inline comments.
share/man/man4/ntsync.4
2

There is no blank comment line in style.9 C example, this is just a multiline C comment formatted properly.

In the style.9 itself, there is the blank line in the beginning only because you put it there, it serves no purpose. Git blame clearly shows that the 'failed experiment' of the addition of the '-' mark was performed, then instead if removing the .\"- line, it was replaced by .\". IOW there is no point.

154

Indeed, and ETIMEDOUT which is returned for timeout is somewhat special so I mentioned it.

kib marked an inline comment as done.

Handle Alex' comments.

share/man/man4/ntsync.4
2

The point is so that they are all formatted the same.

found a few extra nits

share/man/man4/ntsync.4
30

tag requires a width or the linter complains

31–35

There should not be periods if these are not sentences, but if they are sentences, the beginning should be capitalized. Also typo on signaled.

kib marked 4 inline comments as done.

Tweaks

Thanks for writing this!

This revision is now accepted and ready to land.Tue, Jun 23, 11:53 PM
This revision was automatically updated to reflect the committed changes.