Bug #1460564: document that socket.fromfd() duplicates the given

file descriptor.
 (backport from rev. 43523)

diff --git a/Doc/lib/libsocket.tex b/Doc/lib/libsocket.tex
index e3d9a92a85b4d9b8f3b33618bb7e3385cc901250..8e0d5d3615f016aa7babbafcfb423ff4dc14ff4f 100644 (file)
--- a/Doc/lib/libsocket.tex
+++ b/Doc/lib/libsocket.tex
@@ -314,10 +314,11 @@ Availability: \UNIX.  \versionadded{2.4}
 \end{funcdesc}
 
 \begin{funcdesc}{fromfd}{fd, family, type\optional{, proto}}
-Build a socket object from an existing file descriptor (an integer as
-returned by a file object's \method{fileno()} method).  Address family,
-socket type and protocol number are as for the \function{socket()} function
-above.  The file descriptor should refer to a socket, but this is not
+Duplicate the file descriptor \var{fd} (an integer as returned by a file
+object's \method{fileno()} method) and build a socket object from the
+result.  Address family, socket type and protocol number are as for the
+\function{socket()} function above.
+The file descriptor should refer to a socket, but this is not
 checked --- subsequent operations on the object may fail if the file
 descriptor is invalid.  This function is rarely needed, but can be
 used to get or set socket options on a socket passed to a program as

diff --git a/Modules/socketmodule.c b/Modules/socketmodule.c
index a5d2bf3c437bf15649e60c9d6d3f18f598da8bd8..5a148666dc0056b4f843ad307887f251d1c281d8 100644 (file)
--- a/Modules/socketmodule.c
+++ b/Modules/socketmodule.c
@@ -3113,7 +3113,8 @@ socket_fromfd(PyObject *self, PyObject *args)
 PyDoc_STRVAR(fromfd_doc,
 "fromfd(fd, family, type[, proto]) -> socket object\n\
 \n\
-Create a socket object from the given file descriptor.\n\
+Create a socket object from a duplicate of the given\n\
+file descriptor.\n\
 The remaining arguments are the same as for socket().");
 
 #endif /* NO_DUP */