From: Bruno Haible Date: Thu, 11 May 2017 13:22:13 +0000 (+0200) Subject: doc: Clarify doc about socket functions on native Windows. X-Git-Tag: v1.0~6172 X-Git-Url: https://gitweb.git.savannah.gnu.org/gitweb/?a=commitdiff_plain;h=df7f87dfe6213527e3042fc5feb95a3f5b1c7a59;p=gnulib.git doc: Clarify doc about socket functions on native Windows. This reworks doc that was added on 2008-09-29. * doc/posix-functions/select.texi: Fix copy-and-paste mistake and use clearer wording. * doc/posix-functions/accept.texi: Use clearer wording. * doc/posix-functions/bind.texi: Likewise. * doc/posix-functions/connect.texi: Likewise. * doc/posix-functions/getpeername.texi: Likewise. * doc/posix-functions/getsockname.texi: Likewise. * doc/posix-functions/getsockopt.texi: Likewise. * doc/posix-functions/ioctl.texi: Likewise. * doc/posix-functions/listen.texi: Likewise. * doc/posix-functions/recv.texi: Likewise. * doc/posix-functions/recvfrom.texi: Likewise. * doc/posix-functions/send.texi: Likewise. * doc/posix-functions/sendto.texi: Likewise. * doc/posix-functions/setsockopt.texi: Likewise. * doc/posix-functions/shutdown.texi: Likewise. * doc/posix-functions/socket.texi: Likewise. --- diff --git a/ChangeLog b/ChangeLog index e2b473b4e9..f5f34cc62c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,25 @@ +2017-05-11 Bruno Haible + + doc: Clarify doc about socket functions on native Windows. + This reworks doc that was added on 2008-09-29. + * doc/posix-functions/select.texi: Fix copy-and-paste mistake and use + clearer wording. + * doc/posix-functions/accept.texi: Use clearer wording. + * doc/posix-functions/bind.texi: Likewise. + * doc/posix-functions/connect.texi: Likewise. + * doc/posix-functions/getpeername.texi: Likewise. + * doc/posix-functions/getsockname.texi: Likewise. + * doc/posix-functions/getsockopt.texi: Likewise. + * doc/posix-functions/ioctl.texi: Likewise. + * doc/posix-functions/listen.texi: Likewise. + * doc/posix-functions/recv.texi: Likewise. + * doc/posix-functions/recvfrom.texi: Likewise. + * doc/posix-functions/send.texi: Likewise. + * doc/posix-functions/sendto.texi: Likewise. + * doc/posix-functions/setsockopt.texi: Likewise. + * doc/posix-functions/shutdown.texi: Likewise. + * doc/posix-functions/socket.texi: Likewise. + 2017-05-10 Bruno Haible poll: Fix link error on native Windows. diff --git a/doc/posix-functions/accept.texi b/doc/posix-functions/accept.texi index 65dab3719e..a92ea3f057 100644 --- a/doc/posix-functions/accept.texi +++ b/doc/posix-functions/accept.texi @@ -14,9 +14,9 @@ the @code{accept} function cannot 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. +On Windows platforms (excluding Cygwin), error codes from this function +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/bind.texi b/doc/posix-functions/bind.texi index 49f6e65de9..1eb52848ab 100644 --- a/doc/posix-functions/bind.texi +++ b/doc/posix-functions/bind.texi @@ -9,9 +9,9 @@ Gnulib module: bind Portability problems fixed by Gnulib: @itemize @item -On Windows platforms (excluding Cygwin), error codes for @code{bind} -are not placed in @code{errno}, and @code{WSAGetLastError} must be -used instead. +On Windows platforms (excluding Cygwin), error codes from this function +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/connect.texi b/doc/posix-functions/connect.texi index f2fcd66c47..0e9b3a91ec 100644 --- a/doc/posix-functions/connect.texi +++ b/doc/posix-functions/connect.texi @@ -9,9 +9,9 @@ Gnulib module: connect Portability problems fixed by Gnulib: @itemize @item -On Windows platforms (excluding Cygwin), error codes for -@code{connect} are not placed in @code{errno}, and -@code{WSAGetLastError} must be used instead. +On Windows platforms (excluding Cygwin), error codes from this function +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/getpeername.texi b/doc/posix-functions/getpeername.texi index 5d2cefaf2b..5b2776e78f 100644 --- a/doc/posix-functions/getpeername.texi +++ b/doc/posix-functions/getpeername.texi @@ -9,9 +9,9 @@ Gnulib module: getpeername Portability problems fixed by Gnulib: @itemize @item -On Windows platforms (excluding Cygwin), error codes for -@code{getpeername} are not placed in @code{errno}, and -@code{WSAGetLastError} must be used instead. +On Windows platforms (excluding Cygwin), error codes from this function +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/getsockname.texi b/doc/posix-functions/getsockname.texi index e0df7caea1..7d462a72b0 100644 --- a/doc/posix-functions/getsockname.texi +++ b/doc/posix-functions/getsockname.texi @@ -9,9 +9,9 @@ Gnulib module: getsockname Portability problems fixed by Gnulib: @itemize @item -On Windows platforms (excluding Cygwin), error codes for -@code{getsockname} are not placed in @code{errno}, and -@code{WSAGetLastError} must be used instead. +On Windows platforms (excluding Cygwin), error codes from this function +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 28cc41f7bb..9e7d26e433 100644 --- a/doc/posix-functions/getsockopt.texi +++ b/doc/posix-functions/getsockopt.texi @@ -9,9 +9,9 @@ Gnulib module: getsockopt Portability problems fixed by Gnulib: @itemize @item -On Windows platforms (excluding Cygwin), error codes for -@code{getsockopt} are not placed in @code{errno}, and -@code{WSAGetLastError} must be used instead. +On Windows platforms (excluding Cygwin), error codes from this function +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/ioctl.texi b/doc/posix-functions/ioctl.texi index 0afe64bb1b..c4e24151e2 100644 --- a/doc/posix-functions/ioctl.texi +++ b/doc/posix-functions/ioctl.texi @@ -10,7 +10,7 @@ Portability problems fixed by Gnulib: @itemize @item On Windows platforms (excluding Cygwin), @code{ioctl} is called -@code{ioctlsocket}, and error codes for this function are not placed in +@code{ioctlsocket}, and error codes from this function are not placed in @code{errno}, and @code{WSAGetLastError} must be used instead. @item On glibc platforms, the second parameter is of type @code{unsigned long} diff --git a/doc/posix-functions/listen.texi b/doc/posix-functions/listen.texi index 0c16ede1aa..44d8c3297c 100644 --- a/doc/posix-functions/listen.texi +++ b/doc/posix-functions/listen.texi @@ -9,9 +9,9 @@ Gnulib module: listen Portability problems fixed by Gnulib: @itemize @item -On Windows platforms (excluding Cygwin), error codes for @code{listen} -are not placed in @code{errno}, and @code{WSAGetLastError} must be -used instead. +On Windows platforms (excluding Cygwin), error codes from this function +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/recv.texi b/doc/posix-functions/recv.texi index 028966edda..d39238ac74 100644 --- a/doc/posix-functions/recv.texi +++ b/doc/posix-functions/recv.texi @@ -13,9 +13,9 @@ This function has the return type @code{int} instead of @code{ssize_t} on some platforms: OSF/1 5.1. @item -On Windows platforms (excluding Cygwin), error codes for @code{recv} -are not placed in @code{errno}, and @code{WSAGetLastError} must be -used instead. +On Windows platforms (excluding Cygwin), error codes from this function +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/recvfrom.texi b/doc/posix-functions/recvfrom.texi index c376548800..f591d0c2f9 100644 --- a/doc/posix-functions/recvfrom.texi +++ b/doc/posix-functions/recvfrom.texi @@ -13,9 +13,9 @@ This function has the return type @code{int} instead of @code{ssize_t} on some platforms: OSF/1 5.1. @item -On Windows platforms (excluding Cygwin), error codes for -@code{recvfrom} are not placed in @code{errno}, and -@code{WSAGetLastError} must be used instead. +On Windows platforms (excluding Cygwin), error codes from this function +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/select.texi b/doc/posix-functions/select.texi index 26fb2022ad..a5a77de082 100644 --- a/doc/posix-functions/select.texi +++ b/doc/posix-functions/select.texi @@ -13,8 +13,9 @@ 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. +On Windows platforms (excluding Cygwin), error codes from this function +are not placed in @code{errno}, and @code{WSAGetLastError} must be used +instead. @item This function fails when the @code{nfds} argument is 0 on some platforms: Interix 3.5. diff --git a/doc/posix-functions/send.texi b/doc/posix-functions/send.texi index e3151f71e6..72651b0e80 100644 --- a/doc/posix-functions/send.texi +++ b/doc/posix-functions/send.texi @@ -13,9 +13,9 @@ This function has the return type @code{int} instead of @code{ssize_t} on some platforms: OSF/1 5.1. @item -On Windows platforms (excluding Cygwin), error codes for @code{send} -are not placed in @code{errno}, and @code{WSAGetLastError} must be -used instead. +On Windows platforms (excluding Cygwin), error codes from this function +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/sendto.texi b/doc/posix-functions/sendto.texi index fcb3f61c46..152c4f093c 100644 --- a/doc/posix-functions/sendto.texi +++ b/doc/posix-functions/sendto.texi @@ -13,9 +13,9 @@ This function has the return type @code{int} instead of @code{ssize_t} on some platforms: OSF/1 5.1. @item -On Windows platforms (excluding Cygwin), error codes for @code{sendto} -are not placed in @code{errno}, and @code{WSAGetLastError} must be -used instead. +On Windows platforms (excluding Cygwin), error codes from this function +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/setsockopt.texi b/doc/posix-functions/setsockopt.texi index 3fe6871d9f..fe2dabda6a 100644 --- a/doc/posix-functions/setsockopt.texi +++ b/doc/posix-functions/setsockopt.texi @@ -9,9 +9,9 @@ Gnulib module: setsockopt Portability problems fixed by Gnulib: @itemize @item -On Windows platforms (excluding Cygwin), error codes for -@code{setsockopt} are not placed in @code{errno}, and -@code{WSAGetLastError} must be used instead. +On Windows platforms (excluding Cygwin), error codes from this function +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/shutdown.texi b/doc/posix-functions/shutdown.texi index 1c49142a26..51dea63f82 100644 --- a/doc/posix-functions/shutdown.texi +++ b/doc/posix-functions/shutdown.texi @@ -9,9 +9,9 @@ Gnulib module: shutdown Portability problems fixed by Gnulib: @itemize @item -On Windows platforms (excluding Cygwin), error codes for -@code{shutdown} are not placed in @code{errno}, and -@code{WSAGetLastError} must be used instead. +On Windows platforms (excluding Cygwin), error codes from this function +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/socket.texi b/doc/posix-functions/socket.texi index a91ebd6d76..19bb497c23 100644 --- a/doc/posix-functions/socket.texi +++ b/doc/posix-functions/socket.texi @@ -14,9 +14,9 @@ the @code{socket} function cannot 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{socket} -are not placed in @code{errno}, and @code{WSAGetLastError} must be -used instead. +On Windows platforms (excluding Cygwin), error codes from this function +are not placed in @code{errno}, and @code{WSAGetLastError} must be used +instead. @end itemize Portability problems not fixed by Gnulib: