Page MenuHomeFreeBSD
Differential D54434

socket.2: Cross-reference protocol familiy man pages in section 4
AcceptedPublic
Actions

Authored by tembun_bk.ru on Wed, Dec 31, 9:22 AM.
Tags
Referenced Files
Unknown Object (File)
Sun, Jan 18, 11:24 PM
Unknown Object (File)
Sun, Jan 18, 5:30 PM
Unknown Object (File)
Sat, Jan 17, 7:00 PM
Unknown Object (File)
Fri, Jan 16, 7:29 AM
Unknown Object (File)
Fri, Jan 16, 6:37 AM
Unknown Object (File)
Fri, Jan 16, 12:17 AM
Unknown Object (File)
Mon, Jan 12, 6:28 PM
Unknown Object (File)
Mon, Jan 12, 12:26 PM
View All 26 Files
Subscribers
imp

Details

Reviewers
ziaee
glebius
kp
Group Reviewers
docs
manpages
Summary

While here, make a wider use of .Dv macro for socket types and protocol families and reference fcntl(2) flags for the type argument values.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

tembun_bk.ru created this revision.Wed, Dec 31, 9:22 AM
Herald added a subscriber: imp. · View Herald TranscriptWed, Dec 31, 9:22 AM
tembun_bk.ru requested review of this revision.Wed, Dec 31, 9:22 AM
tembun_bk.ru added inline comments.Wed, Dec 31, 9:24 AM
lib/libsys/socket.2
126–148

Here I changed .Bd to .Bl, because I've already done this for a list of protocol families above. Also, it allows to use a .Dv for values here.

tembun_bk.ru updated this revision to Diff 168799.Wed, Dec 31, 9:35 AM

Bump the .Dd.

tembun_bk.ru updated this revision to Diff 168969.Sat, Jan 3, 7:24 PM

Update diff with -U9999.

tembun_bk.ru added a reviewer: glebius.Sat, Jan 17, 9:10 AM
ziaee accepted this revision.Sat, Jan 17, 2:46 PM
ziaee added a reviewer: kp.

I think this looks great! Let's wait for a second opinion on the content and then I'd be happy to take this.

This revision is now accepted and ready to land.Sat, Jan 17, 2:46 PM
glebius added inline comments.Sat, Jan 17, 6:01 PM
lib/libsys/socket.2
84

Let's document it as legacy.

88

ipsec(4) should be referenced here.

94

The ng_ksocket reference better be removed, it will create more confusion than help. And I'd better reference netgraph(3) than netgraph(4). The former talks about how to use netgraph sockets while the latter on how build netgraph nodes.

148

Let's make it consistent: use either descriptor or socket.

Let's also make a reference to exact fcntl(2) flags that are set. Mention FD_CLOEXEC, FD_CLOFORK, and F_SETFL with O_NONBLOCK.

tembun_bk.ru updated this revision to Diff 169976.Sat, Jan 17, 7:50 PM
tembun_bk.ru marked 4 inline comments as done.
tembun_bk.ru edited the summary of this revision. (Show Details)

Implement improvements suggested by @glebius.

This revision now requires review to proceed.Sat, Jan 17, 7:50 PM
glebius accepted this revision.Mon, Jan 19, 6:31 PM

Looks great, thanks!

This revision is now accepted and ready to land.Mon, Jan 19, 6:31 PM

Revision Contents
Changeset List

PathSize
lib/
libsys/
109 lines

Diff 168969

View Options

lib/libsys/socket.2

Loading...