From: Fred Drake Date: Fri, 21 Dec 2001 17:44:43 +0000 (+0000) Subject: Add notes that fromfd() and s.makefile() are Unix-specific. X-Git-Tag: v2.1.2c1~33 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9531fb4d2094976094654e122633056931f658c3;p=thirdparty%2FPython%2Fcpython.git Add notes that fromfd() and s.makefile() are Unix-specific. This fixes SF bug #495896. Fix up various markup consistency & style guide conformance nits. --- diff --git a/Doc/lib/libsocket.tex b/Doc/lib/libsocket.tex index 6598bf02c649..82d073ca5a47 100644 --- a/Doc/lib/libsocket.tex +++ b/Doc/lib/libsocket.tex @@ -114,7 +114,7 @@ returned. \begin{funcdesc}{gethostbyname}{hostname} Translate a host name to IP address format. The IP address is -returned as a string, e.g., \code{'100.50.200.5'}. If the host name +returned as a string, such as \code{'100.50.200.5'}. If the host name is an IP address itself it is returned unchanged. See \function{gethostbyname_ex()} for a more complete interface. \end{funcdesc} @@ -150,7 +150,7 @@ To find the fully qualified domain name, use the function \end{funcdesc} \begin{funcdesc}{getprotobyname}{protocolname} -Translate an Internet protocol name (e.g.\ \code{'icmp'}) to a constant +Translate an Internet protocol name (for example, \code{'icmp'}) to a constant suitable for passing as the (optional) third argument to the \function{socket()} function. This is usually only needed for sockets opened in ``raw'' mode (\constant{SOCK_RAW}); for the normal socket @@ -180,8 +180,9 @@ 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 -standard input or output (e.g.\ a server started by the \UNIX{} inet +standard input or output (such as a server started by the \UNIX{} inet daemon). +Availability: \UNIX. \end{funcdesc} \begin{funcdesc}{ntohl}{x} @@ -209,8 +210,8 @@ no-op; otherwise, it performs a 2-byte swap operation. \end{funcdesc} \begin{funcdesc}{inet_aton}{ip_string} -Convert an IP address from dotted-quad string format -(e.g.\ '123.45.67.89') to 32-bit packed binary format, as a string four +Convert an IP address from dotted-quad string format (for example, +'123.45.67.89') to 32-bit packed binary format, as a string four characters in length. Useful when conversing with a program that uses the standard C library @@ -226,7 +227,7 @@ valid depends on the underlying C implementation of \begin{funcdesc}{inet_ntoa}{packed_ip} Convert a 32-bit packed IP address (a string four characters in length) to its standard dotted-quad string representation -(e.g. '123.45.67.89'). +(for example, '123.45.67.89'). Useful when conversing with a program that uses the standard C library and needs objects of type \ctype{struct in_addr}, which is the C type @@ -292,7 +293,7 @@ instead of raising an exception for errors returned by the C-level \cfunction{connect()} call (other problems, such as ``host not found,'' can still raise exceptions). The error indicator is \code{0} if the operation succeeded, otherwise the value of the \cdata{errno} -variable. This is useful, e.g., for asynchronous connects. +variable. This is useful to support, for example, asynchronous connects. \strong{Note:} This method has historically accepted a pair of parameters for \constant{AF_INET} addresses instead of only a tuple. This was never intentional and is no longer be available in Python @@ -344,7 +345,9 @@ socket file descriptor, so the file object and socket object may be closed or garbage-collected independently. \index{I/O control!buffering}The optional \var{mode} and \var{bufsize} arguments are interpreted the same way as by the -built-in \function{open()} function. +built-in \function{open()} function; see ``Built-in Functions'' +(section \ref{built-in-funcs}) for more information. +Availability: \UNIX. \end{methoddesc} \begin{methoddesc}[socket]{recv}{bufsize\optional{, flags}}