ntsync.4: add the man page
Needs ReviewPublic
Actions

Authored by kib on Fri, Jun 19, 12:52 PM.

Details

Reviewers

emaste
iwtcex_gmail.com

Group Reviewers

manpages

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Event Timeline

kib created this revision.Fri, Jun 19, 12:52 PM

Herald added subscribers: ziaee, imp. · View Herald TranscriptFri, 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.

Some more details.

ziaee added inline comments.Fri, Jun 19, 7:53 PM

share/man/man4/ntsync.4
2	Please prepend a blank comment line for conformance with our style guides and consistency with C style comments.

kib added inline comments.Fri, Jun 19, 8:04 PM

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.

ziaee added inline comments.Fri, Jun 19, 8:08 PM

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.

ziaee added inline comments.Fri, Jun 19, 8:33 PM

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.