Project

General

Profile

Actions

Bug #6060

open

man pages for read(2), recv(3SOCKET) missing TCP-related errors

Added by David Pacheco almost 7 years ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
-
Start date:
2015-07-15
Due date:
% Done:

0%

Estimated time:
Difficulty:
Medium
Tags:
needs-triage
Gerrit CR:

Description

The man page for recv(3SOCKET) has the usual ERRORS section, but there's no indication that the list of errors there is incomplete. In fact, tcp(7p) documents a few other error conditions (like ETIMEDOUT) that can happen to any "socket operation". Specifically, ETIMEDOUT can be returned by recv(3SOCKET). This is confusing for someone who sees ETIMEDOUT returned, looks for it in the man page, and doesn't find it.

read(2) does indicate that asynchronous socket errors may be returned, but there's no indication that that might include error numbers that are not documented under ERRORS.

I'd suggest that the ERRORS section of each of these man pages start with something like:

"In addition to the error values documented below, this function may return asynchronous errors generated by the underlying socket type. For example, for a TCP socket, see additional error codes in tcp(7p)."

No data to display

Actions

Also available in: Atom PDF