Fixed the comments for PR_Poll. PR_Poll only works on sockets; the support

for files is not portable. Document the fd field of PRPollDesc.

1 files changed, 4 insertions, 1 deletions

diff --git a/pr/include/prio.h b/pr/include/prio.h
index bab22b15..12caf4ef 100644
--- a/pr/include/prio.h
+++ b/pr/include/prio.h
@@ -1880,9 +1880,12 @@ struct PRPollDesc {
 ** DESCRIPTION:
 **
 ** The call returns as soon as I/O is ready on one or more of the underlying
-** file/socket objects. A count of the number of ready descriptors is
+** socket objects. A count of the number of ready descriptors is
 ** returned unless a timeout occurs in which case zero is returned.
 **
+** PRPollDesc.fd should be set to a pointer to a PRFileDesc object
+** representing a socket. This field can be set to NULL to indicate to
+** PR_Poll that this PRFileDesc object should be ignored.
 ** PRPollDesc.in_flags should be set to the desired request
 ** (read/write/except or some combination). Upon successful return from
 ** this call PRPollDesc.out_flags will be set to indicate what kind of