]> granicus.if.org Git - python/commitdiff
Updated the socketpair() docstring and documentation to explain that the
authorDave Cole <djc@object-craft.com.au>
Mon, 23 Aug 2004 05:16:23 +0000 (05:16 +0000)
committerDave Cole <djc@object-craft.com.au>
Mon, 23 Aug 2004 05:16:23 +0000 (05:16 +0000)
default famility is AF_UNIX if defined for the platform, otherwise the
default is AF_INET.

Doc/lib/libsocket.tex
Modules/socketmodule.c

index 73590b4ce20f85dd9db722e338fd57becd8c5cb2..762d76286accc6f4a37d5b3401f7d841f4588cdd 100644 (file)
@@ -307,8 +307,9 @@ success, a new \class{SSLObject} is returned.
 Build a pair of connected socket objects using the given address
 family, socket type and protocol number.  Address family, socket type
 and protocol number are as for the \function{socket()} function above.
-Availability: \UNIX.
-\versionadded{2.4}
+The default family is AF_UNIX if defined for the platform, otherwise
+the default is AF_INET.
+Availability: \UNIX.  \versionadded{2.4}
 \end{funcdesc}
 
 \begin{funcdesc}{fromfd}{fd, family, type\optional{, proto}}
index a9a7b006a7b607b9b248f63d85e98080cdef08a8..4249045683704120d5f2f6cb53ed6a2bc5a9e1b4 100644 (file)
@@ -3011,7 +3011,8 @@ Return the protocol number for the named protocol.  (Rarely used.)");
 
 #ifdef HAVE_SOCKETPAIR
 /* 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*/
 static PyObject *
@@ -3058,7 +3059,8 @@ PyDoc_STRVAR(socketpair_doc,
 \n\
 Create a pair of socket objects from the sockets returned by the platform\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 */