From 32848a0b172a6f0f4f7122cc1c7c1050f85094df Mon Sep 17 00:00:00 2001 From: Paolo Bonzini Date: Mon, 29 Sep 2008 13:23:50 +0200 Subject: [PATCH] documentation update for mingw socket functions 2008-08-24 Paolo Bonzini * 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. --- ChangeLog | 19 +++++++++++++++++++ doc/posix-functions/accept.texi | 15 ++++++++++++--- doc/posix-functions/bind.texi | 8 ++++---- doc/posix-functions/close.texi | 10 +++++++++- doc/posix-functions/connect.texi | 8 ++++---- doc/posix-functions/getpeername.texi | 8 ++++---- doc/posix-functions/getsockname.texi | 5 ++++- doc/posix-functions/getsockopt.texi | 7 +++++-- doc/posix-functions/ioctl.texi | 10 ++++++---- doc/posix-functions/listen.texi | 8 ++++---- doc/posix-functions/recv.texi | 8 ++++---- doc/posix-functions/recvfrom.texi | 8 ++++---- doc/posix-functions/select.texi | 17 ++++++++++------- doc/posix-functions/send.texi | 8 ++++---- doc/posix-functions/sendto.texi | 8 ++++---- doc/posix-functions/setsockopt.texi | 8 ++++---- doc/posix-functions/socket.texi | 13 +++++++++---- 17 files changed, 110 insertions(+), 58 deletions(-) diff --git a/ChangeLog b/ChangeLog index 42f640117..828fdab37 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,22 @@ +2008-08-24 Paolo Bonzini + + * 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 Bruno Haible diff --git a/doc/posix-functions/accept.texi b/doc/posix-functions/accept.texi index fe85c630d..be125cfa2 100644 --- a/doc/posix-functions/accept.texi +++ b/doc/posix-functions/accept.texi @@ -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 *}. diff --git a/doc/posix-functions/bind.texi b/doc/posix-functions/bind.texi index 2211dd0bc..5a2a8ff91 100644 --- a/doc/posix-functions/bind.texi +++ b/doc/posix-functions/bind.texi @@ -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 diff --git a/doc/posix-functions/close.texi b/doc/posix-functions/close.texi index ec961dca8..84bdd388f 100644 --- a/doc/posix-functions/close.texi +++ b/doc/posix-functions/close.texi @@ -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 diff --git a/doc/posix-functions/connect.texi b/doc/posix-functions/connect.texi index 498703476..5a832c9e3 100644 --- a/doc/posix-functions/connect.texi +++ b/doc/posix-functions/connect.texi @@ -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 diff --git a/doc/posix-functions/getpeername.texi b/doc/posix-functions/getpeername.texi index e22953419..0cd05a71d 100644 --- a/doc/posix-functions/getpeername.texi +++ b/doc/posix-functions/getpeername.texi @@ -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 diff --git a/doc/posix-functions/getsockname.texi b/doc/posix-functions/getsockname.texi index 0d591e477..d45469a0f 100644 --- a/doc/posix-functions/getsockname.texi +++ b/doc/posix-functions/getsockname.texi @@ -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: diff --git a/doc/posix-functions/getsockopt.texi b/doc/posix-functions/getsockopt.texi index 583bb90b8..34863f131 100644 --- a/doc/posix-functions/getsockopt.texi +++ b/doc/posix-functions/getsockopt.texi @@ -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 *}. diff --git a/doc/posix-functions/ioctl.texi b/doc/posix-functions/ioctl.texi index 56380a852..86235d897 100644 --- a/doc/posix-functions/ioctl.texi +++ b/doc/posix-functions/ioctl.texi @@ -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 diff --git a/doc/posix-functions/listen.texi b/doc/posix-functions/listen.texi index 6ffb36bcc..02631fb3e 100644 --- a/doc/posix-functions/listen.texi +++ b/doc/posix-functions/listen.texi @@ -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 diff --git a/doc/posix-functions/recv.texi b/doc/posix-functions/recv.texi index 1cebbd415..6204b09a8 100644 --- a/doc/posix-functions/recv.texi +++ b/doc/posix-functions/recv.texi @@ -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 diff --git a/doc/posix-functions/recvfrom.texi b/doc/posix-functions/recvfrom.texi index fdb54a6ab..9b15e13b4 100644 --- a/doc/posix-functions/recvfrom.texi +++ b/doc/posix-functions/recvfrom.texi @@ -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 diff --git a/doc/posix-functions/select.texi b/doc/posix-functions/select.texi index 1c6475263..81e56116b 100644 --- a/doc/posix-functions/select.texi +++ b/doc/posix-functions/select.texi @@ -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}. diff --git a/doc/posix-functions/send.texi b/doc/posix-functions/send.texi index 232082668..f7c9a4ab7 100644 --- a/doc/posix-functions/send.texi +++ b/doc/posix-functions/send.texi @@ -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 diff --git a/doc/posix-functions/sendto.texi b/doc/posix-functions/sendto.texi index 62330a6b2..47e38d266 100644 --- a/doc/posix-functions/sendto.texi +++ b/doc/posix-functions/sendto.texi @@ -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 diff --git a/doc/posix-functions/setsockopt.texi b/doc/posix-functions/setsockopt.texi index 2146c3557..f4399710a 100644 --- a/doc/posix-functions/setsockopt.texi +++ b/doc/posix-functions/setsockopt.texi @@ -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 diff --git a/doc/posix-functions/socket.texi b/doc/posix-functions/socket.texi index 46a3605f7..9675f32be 100644 --- a/doc/posix-functions/socket.texi +++ b/doc/posix-functions/socket.texi @@ -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. -- 2.11.0