changeset 30233:8bf8bbba1c84

documentation update for mingw socket functions 2008-08-24 Paolo Bonzini <bonzini@gnu.org> * doc/posix-functions/accept.texi: Update mingw problems. * doc/posix-functions/bind.texi: Update mingw problems. * doc/posix-functions/close.texi: Update mingw problems. * doc/posix-functions/connect.texi: Update mingw problems. * doc/posix-functions/getpeername.texi: Update mingw problems. * doc/posix-functions/getsockname.texi: Update mingw problems. * doc/posix-functions/getsockopt.texi: Update mingw problems. * doc/posix-functions/ioctl.texi: Update mingw problems. * doc/posix-functions/listen.texi: Update mingw problems. * doc/posix-functions/recv.texi: Update mingw problems. * doc/posix-functions/recvfrom.texi: Update mingw problems. * doc/posix-functions/select.texi: Update mingw problems. * doc/posix-functions/send.texi: Update mingw problems. * doc/posix-functions/sendto.texi: Update mingw problems. * doc/posix-functions/setsockopt.texi: Update mingw problems. * doc/posix-functions/socket.texi: Update mingw problems.
author Paolo Bonzini <bonzini@gnu.org>
date Mon, 29 Sep 2008 13:23:50 +0200
parents 93e5702f1344
children 7741d88d82fe
files ChangeLog doc/posix-functions/accept.texi doc/posix-functions/bind.texi doc/posix-functions/close.texi doc/posix-functions/connect.texi doc/posix-functions/getpeername.texi doc/posix-functions/getsockname.texi doc/posix-functions/getsockopt.texi doc/posix-functions/ioctl.texi doc/posix-functions/listen.texi doc/posix-functions/recv.texi doc/posix-functions/recvfrom.texi doc/posix-functions/select.texi doc/posix-functions/send.texi doc/posix-functions/sendto.texi doc/posix-functions/setsockopt.texi doc/posix-functions/socket.texi
diffstat 17 files changed, 110 insertions(+), 58 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Mon Sep 29 12:02:35 2008 +0200
+++ b/ChangeLog	Mon Sep 29 13:23:50 2008 +0200
@@ -1,3 +1,22 @@
+2008-08-24  Paolo Bonzini  <bonzini@gnu.org>
+
+	* doc/posix-functions/accept.texi: Update mingw problems.
+	* doc/posix-functions/bind.texi: Update mingw problems.
+	* doc/posix-functions/close.texi: Update mingw problems.
+	* doc/posix-functions/connect.texi: Update mingw problems.
+	* doc/posix-functions/getpeername.texi: Update mingw problems.
+	* doc/posix-functions/getsockname.texi: Update mingw problems.
+	* doc/posix-functions/getsockopt.texi: Update mingw problems.
+	* doc/posix-functions/ioctl.texi: Update mingw problems.
+	* doc/posix-functions/listen.texi: Update mingw problems.
+	* doc/posix-functions/recv.texi: Update mingw problems.
+	* doc/posix-functions/recvfrom.texi: Update mingw problems.
+	* doc/posix-functions/select.texi: Update mingw problems.
+	* doc/posix-functions/send.texi: Update mingw problems.
+	* doc/posix-functions/sendto.texi: Update mingw problems.
+	* doc/posix-functions/setsockopt.texi: Update mingw problems.
+	* doc/posix-functions/socket.texi: Update mingw problems.
+
 2008-09-29  Paolo Bonzini  <bonzini@gnu.org>
             Bruno Haible  <bruno@clisp.org>
 
--- a/doc/posix-functions/accept.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/accept.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,17 +4,26 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/accept.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), the descriptors returned by
+the @code{accept} function can not be used in calls to @code{read},
+@code{write}, and @code{close}; you have to use @code{recv}, @code{send},
+@code{closesocket} in these cases instead.
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
 @item
-This function is missing on some platforms:
-mingw.
+On BeOS, the descriptors returned by the @code{accept} function can not be used
+in calls to @code{read}, @code{write}, and @code{close}; you have to use
+@code{recv}, @code{send}, @code{closesocket} in these cases instead.
 @item
 Some platforms don't have a @code{socklen_t} type; in this case this function's
 third argument type is @samp{int *}.
--- a/doc/posix-functions/bind.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/bind.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,15 +4,15 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/bind.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
-@item
-This function is missing on some platforms:
-mingw.
 @end itemize
--- a/doc/posix-functions/close.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/close.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,12 +4,20 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/close.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), @code{socket} and @code{accept}
+do not return file descriptors that can be closed by @code{close}.
+Instead, @code{closesocket} must be used.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
+@item
+On BeOS, @code{socket} and @code{accept} do not return file descriptors
+that can be closed by @code{close}.  Instead, @code{closesocket} must be
+used.
 @end itemize
--- a/doc/posix-functions/connect.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/connect.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,15 +4,15 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/connect.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
-@item
-This function is missing on some platforms:
-mingw.
 @end itemize
--- a/doc/posix-functions/getpeername.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/getpeername.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,18 +4,18 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/getpeername.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
 @item
-This function is missing on some platforms:
-mingw.
-@item
 Some platforms don't have a @code{socklen_t} type; in this case this function's
 third argument type is @samp{int *}.
 @end itemize
--- a/doc/posix-functions/getsockname.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/getsockname.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,10 +4,13 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/getsockname.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
--- a/doc/posix-functions/getsockopt.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/getsockopt.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,17 +4,20 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/getsockopt.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
 @item
 This function is missing on some platforms:
-mingw, BeOS.
+BeOS.
 @item
 Some platforms don't have a @code{socklen_t} type; in this case this function's
 fifth argument type is @samp{int *}.
--- a/doc/posix-functions/ioctl.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/ioctl.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,17 +4,19 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/ioctl.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
+@item
+@code{ioctl} is called @code{ioctlsocket} under mingw
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
 @item
-This function is missing on some platforms:
-mingw.
-@item
 Most @code{ioctl} requests are platform and hardware specific.
 @end itemize
--- a/doc/posix-functions/listen.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/listen.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,15 +4,15 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/listen.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
-@item
-This function is missing on some platforms:
-mingw.
 @end itemize
--- a/doc/posix-functions/recv.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/recv.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,15 +4,15 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/recv.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
-@item
-This function is missing on some platforms:
-mingw.
 @end itemize
--- a/doc/posix-functions/recvfrom.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/recvfrom.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,18 +4,18 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/recvfrom.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
 @item
-This function is missing on some platforms:
-mingw.
-@item
 Some platforms don't have a @code{socklen_t} type; in this case this function's
 sixth argument type is @samp{int *}.
 @end itemize
--- a/doc/posix-functions/select.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/select.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,26 +4,29 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/select.html}
 
-Gnulib module: ---
+Gnulib module: sys_select
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), @code{select} can only be
+called on descriptors created by the @code{socket} function, not on regular
+file descriptors.
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
 @item
-This function is missing on some platforms:
-mingw.
-@item
 When you call @code{select} with a timeout, some implementations modify the
 timeout parameter so that upon return from the function, it contains the
 amount of time not slept.  Other implementations leave the timeout parameter
 unmodified.
 @item
-On Windows platforms (excluding Cygwin) and on BeOS, @code{select} can only be
-called on descriptors created by the @code{socket} function, not on regular
-file descriptors.
+On BeOS, @code{select} can only be called on descriptors created by the
+@code{socket} function, not on regular file descriptors.
 @item
 On Linux, when some file descriptor refers to a regular file, @code{select}
 may fail, setting @code{errno} to @code{EBADF}.
--- a/doc/posix-functions/send.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/send.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,15 +4,15 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/send.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
-@item
-This function is missing on some platforms:
-mingw.
 @end itemize
--- a/doc/posix-functions/sendto.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/sendto.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,15 +4,15 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/sendto.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
-@item
-This function is missing on some platforms:
-mingw.
 @end itemize
--- a/doc/posix-functions/setsockopt.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/setsockopt.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,17 +4,17 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/setsockopt.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
 @item
-This function is missing on some platforms:
-mingw.
-@item
 Many socket options are not available on all platforms.
 @end itemize
--- a/doc/posix-functions/socket.texi	Mon Sep 29 12:02:35 2008 +0200
+++ b/doc/posix-functions/socket.texi	Mon Sep 29 13:23:50 2008 +0200
@@ -4,18 +4,23 @@
 
 POSIX specification: @url{http://www.opengroup.org/susv3xsh/socket.html}
 
-Gnulib module: ---
+Gnulib module: sys_socket
 
 Portability problems fixed by Gnulib:
 @itemize
+@item
+On Windows platforms (excluding Cygwin), the descriptors returned by
+the @code{socket} function can not be used in calls to @code{read},
+@code{write}, and @code{close}; you have to use @code{recv}, @code{send},
+@code{closesocket} in these cases instead.
+@item
+On Windows platforms (excluding Cygwin), error codes for @code{accept} are not
+placed in @code{errno}, and @code{WSAGetLastError} must be used instead.
 @end itemize
 
 Portability problems not fixed by Gnulib:
 @itemize
 @item
-This function is missing on some platforms:
-mingw.
-@item
 On BeOS, the descriptors returned by the @code{socket} function can not be used
 in calls to @code{read}, @code{write}, and @code{close}; you have to use
 @code{recv}, @code{send}, @code{closesocket} in these cases instead.