send.2: document ENOTCONN for sendto w/SOCK_STREAM
ClosedPublic
Actions

Authored by knan-rfo_modirum.com on Apr 22 2020, 9:09 AM.

Details

Reviewers

Group Reviewers

docs
manpages

Commits

rS360384: Document handling of connection-mode sockets by sendto(2).

Summary

sendto on an unconnected sock_stream unix socket can return ENOTCONN, which is not documented in the man page until now. Change that.

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

knan-rfo_modirum.com created this revision.Apr 22 2020, 9:09 AM

marieheleneka_gmail.com added a subscriber: marieheleneka_gmail.com.Apr 22 2020, 9:12 AM

knan-rfo_modirum.com set the repository for this revision to rD FreeBSD doc repository - subversion.Apr 22 2020, 9:29 AM

marieheleneka_gmail.com added a reviewer: docs.Apr 22 2020, 9:30 AM

markj added a subscriber: markj.Apr 24 2020, 2:28 PM

markj added inline comments.

lib/libc/sys/send.2
79 ↗	(On Diff #70872)	Sentences should start with a capital letter.
80 ↗	(On Diff #70872)	Should be .Er ENOTCONN
82 ↗	(On Diff #70872)	This sentence contradicts the previous one, which says that these functions can be used at any time.
208 ↗	(On Diff #70872)	Usually we'd use the text from POSIX, in this case "The socket is connection-mode but is not connected." The text about implied open should be moved up to the paragraph that you're modifying above.

emaste added a subscriber: emaste.Apr 24 2020, 5:00 PM

Updated according to review comments. ENOTCONN description aligned with POSIX. Self-contradiction rewritten.

markj added inline comments.Apr 27 2020, 1:09 PM

lib/libc/sys/send.2
73 ↗	(On Diff #71037)	Extra blank line.
86 ↗	(On Diff #71037)	We should further qualify that if the socket is connected, the destination address passed by sendto() and sendmsg() is ignored. Let's just add .Xr connect 2 to the "SEE ALSO" section below, trying to avoid parentheticals.

Clarified that destination address is ignored if socket is already connected, and clarified where the destination address is sent in the sendmsg call. Formatting.

Thanks, this looks ok to me.

This revision is now accepted and ready to land.Apr 27 2020, 2:34 PM

Closed by commit rS360384: Document handling of connection-mode sockets by sendto(2). (authored by markj). · Explain WhyApr 27 2020, 4:12 PM

This revision was automatically updated to reflect the committed changes.

markj added a commit: rS360384: Document handling of connection-mode sockets by sendto(2)..

Herald added a reviewer: manpages. · View Herald TranscriptApr 27 2020, 4:12 PM

Herald added a subscriber: imp. · View Herald Transcript