Discussion:
doc: fix select() documentation
(too old to reply)
Bruno Haible
2017-05-11 13:26:10 UTC
Permalink
Raw Message
The sentence from
https://www.gnu.org/software/gnulib/manual/html_node/select.html

"On Windows platforms (excluding Cygwin), error codes for accept
are not placed in errno, and WSAGetLastError must be used instead."

makes little sense to me. This patch fixes the doc.


2017-05-11 Bruno Haible <***@clisp.org>

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/doc/posix-functions/accept.texi b/doc/posix-functions/accept.texi
index 65dab37..a92ea3f 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 49f6e65..1eb5284 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 f2fcd66..0e9b3a9 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 5d2cefa..5b2776e 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 e0df7ca..7d462a7 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 28cc41f..9e7d26e 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 0afe64b..c4e2415 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 0c16ede..44d8c32 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 028966e..d39238a 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 c376548..f591d0c 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 26fb202..a5a77de 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 e3151f7..72651b0 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 fcb3f61..152c4f0 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 3fe6871..fe2dabd 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 1c49142..51dea63 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 a91ebd6..19bb497 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:

Loading...