Updated the socketpair() docstring and documentation to explain that the

default famility is AF_UNIX if defined for the platform, otherwise the
default is AF_INET.
This commit is contained in:
Dave Cole 2004-08-23 05:16:23 +00:00
parent 0fc8575412
commit 07fda7e3a0
2 changed files with 7 additions and 4 deletions

View file

@ -307,8 +307,9 @@ success, a new \class{SSLObject} is returned.
Build a pair of connected socket objects using the given address Build a pair of connected socket objects using the given address
family, socket type and protocol number. Address family, socket type family, socket type and protocol number. Address family, socket type
and protocol number are as for the \function{socket()} function above. and protocol number are as for the \function{socket()} function above.
Availability: \UNIX. The default family is AF_UNIX if defined for the platform, otherwise
\versionadded{2.4} the default is AF_INET.
Availability: \UNIX. \versionadded{2.4}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{fromfd}{fd, family, type\optional{, proto}} \begin{funcdesc}{fromfd}{fd, family, type\optional{, proto}}

View file

@ -3011,7 +3011,8 @@ Return the protocol number for the named protocol. (Rarely used.)");
#ifdef HAVE_SOCKETPAIR #ifdef HAVE_SOCKETPAIR
/* Create a pair of sockets using the socketpair() function. /* Create a pair of sockets using the socketpair() function.
Arguments as for socket(). */ Arguments as for socket() except the default family is AF_UNIX if
defined for the platform, otherwise the default is AF_INET. */
/*ARGSUSED*/ /*ARGSUSED*/
static PyObject * static PyObject *
@ -3058,7 +3059,8 @@ PyDoc_STRVAR(socketpair_doc,
\n\ \n\
Create a pair of socket objects from the sockets returned by the platform\n\ Create a pair of socket objects from the sockets returned by the platform\n\
socketpair() function.\n\ socketpair() function.\n\
The arguments are the same as for socket()."); The arguments are the same as for socket() except the default family is\n\
AF_UNIX if defined for the platform, otherwise the default is AF_INET.");
#endif /* HAVE_SOCKETPAIR */ #endif /* HAVE_SOCKETPAIR */