diff mbox series

system_data_types.7: Add 'fd_set'

Message ID 20201008080451.8248-1-colomar.6.4.3@gmail.com
State New
Headers show
Series system_data_types.7: Add 'fd_set' | expand

Commit Message

Alejandro Colomar Oct. 8, 2020, 8:04 a.m. UTC
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---

Hi Michael,

There's no link for this type, because it would conflict with FD_SET.3,
which is a link to select(2).

Cheers,

Alex


 man7/system_data_types.7 | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

Comments

Michael Kerrisk \(man-pages\) via Libc-alpha Oct. 8, 2020, 10:43 a.m. UTC | #1
Hi Alex,

Thanks for the patch. See below.

On Thu, 8 Oct 2020 at 10:05, Alejandro Colomar <colomar.6.4.3@gmail.com> wrote:
>
> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
> ---
>
> Hi Michael,
>
> There's no link for this type, because it would conflict with FD_SET.3,
> which is a link to select(2).

Okay.

>  man7/system_data_types.7 | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
>
> diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
> index b0e0d2b48..adddf823f 100644
> --- a/man7/system_data_types.7
> +++ b/man7/system_data_types.7
> @@ -151,6 +151,23 @@ See also the
>  .I float_t
>  type in this page.
>  .RE
> +.\"------------------------------------- fd_set -----------------------/
> +.TP
> +.I fd_set
> +.RS
> +Include:
> +.IR <sys/select.h> .
> +Alternatively,
> +.IR <sys/time.h> .
> +.PP
> +A structure holding a fixed size buffer of file descriptors.

"buffer" feels wrong.

I think this would be better as something like:

"A structured type that can represent a set of file descriptors."

And then you could perhaps say somewhere: "In the glibc
implementation, the maximum file descriptor number that can be
represented is 1023."

Thanks

Michael
diff mbox series

Patch

diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index b0e0d2b48..adddf823f 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -151,6 +151,23 @@  See also the
 .I float_t
 type in this page.
 .RE
+.\"------------------------------------- fd_set -----------------------/
+.TP
+.I fd_set
+.RS
+Include:
+.IR <sys/select.h> .
+Alternatively,
+.IR <sys/time.h> .
+.PP
+A structure holding a fixed size buffer of file descriptors.
+.PP
+Conforming to:
+POSIX.1-2001 and later.
+.PP
+See also:
+.BR select (2)
+.RE
 .\"------------------------------------- fenv_t -----------------------/
 .TP
 .I fenv_t