[PATCH] system_data_types.7: Add 'fd_set'

[PATCH] system_data_types.7: Add 'fd_set'

[Alejandro Colomar]

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(+)

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
-- 
2.28.0

Re: [PATCH] system_data_types.7: Add 'fd_set'

[Michael Kerrisk (man-pages)]

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

[PATCH] system_data_types.7: Add 'fd_set'

[Alejandro Colomar]

Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---

Hi Michael,

I found that POSIX defines the limit in a macro, so I used that.

Thanks,

Alex

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

diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index b0e0d2b48..a4a2e0ab8 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -151,6 +151,28 @@ 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 type that can represent a set of file descriptors.
+According to POSIX,
+the maximum number of file descriptors in an
+.I fd_set
+structure is the value of the macro
+.BR FD_SETSIZE .
+.PP
+Conforming to:
+POSIX.1-2001 and later.
+.PP
+See also:
+.BR select (2)
+.RE
 .\"------------------------------------- fenv_t -----------------------/
 .TP
 .I fenv_t
-- 
2.28.0

Re: [PATCH] system_data_types.7: Add 'fd_set'

[Michael Kerrisk (man-pages)]

On 10/9/20 10:42 AM, Alejandro Colomar wrote:
> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
> ---
> 
> Hi Michael,
> 
> I found that POSIX defines the limit in a macro, so I used that.
> 
> Thanks,
> 
> Alex

Thanks, Alex. Patch applied.

Cheers,

Michael

>  man7/system_data_types.7 | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
> 
> diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
> index b0e0d2b48..a4a2e0ab8 100644
> --- a/man7/system_data_types.7
> +++ b/man7/system_data_types.7
> @@ -151,6 +151,28 @@ 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 type that can represent a set of file descriptors.
> +According to POSIX,
> +the maximum number of file descriptors in an
> +.I fd_set
> +structure is the value of the macro
> +.BR FD_SETSIZE .
> +.PP
> +Conforming to:
> +POSIX.1-2001 and later.
> +.PP
> +See also:
> +.BR select (2)
> +.RE
>  .\"------------------------------------- fenv_t -----------------------/
>  .TP
>  .I fenv_t
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/