diff mbox series

[v2,04/10] system_data_types.7: Add float_t

Message ID 20200925111922.222149-1-colomar.6.4.3@gmail.com
State Not Applicable
Headers show
Series None | expand

Commit Message

Alejandro Colomar Sept. 25, 2020, 11:19 a.m. UTC
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---

Hi Michael,

On 2020-09-25 11:30, Michael Kerrisk (man-pages) wrote:
>> I removed the "intended" part to simplify it a bit. Do you prefer to
>> keep it?
> Well, as long as you are going to lift the detail about "most
> efficient" from the C standard, I'd be inclined to keep
> the word "intended" from the standard as well. But I do not feel
> strongly about it.
> 

Fair enough.


On 2020-09-25 11:30, Michael Kerrisk (man-pages) wrote:
>> BTW, I'll also add a note that FLT_EVAL_METHOD is defined in <float.h>
>> Would you add that to "Notes", or as part of the description?
> As part of the description I think. (And I don't mind if it's
> repeated in the double_t description.)

I think there was a misunderstanding; maybe I should have been clearer:

I meant to write about <float.h> in the "Notes" of the type,
and not in the "NOTES" of the entire page.

However, I decided to do it in the description of the type as you said,
because it was a bit simpler.

The other version would have resulted in this code, just for you to see:

[[
.TP
.I double_t
.RS
.PP
Include:
.IR <math.h> .
.PP
The implementation's most efficient floating type at least as wide as
.IR double .
Its type depends on the value of the macro
.BR FLT_EVAL_METHOD :
.TP
0
.I double_t
is
.IR double .
.TP
1
.I double_t
is
.IR double .
.TP
2
.I double_t
is
.IR "long double" .
.IP
For other values of
.BR FLT_EVAL_METHOD ,
the type of
.I double_t
is implementation-defined.
.PP
Conforming to: C99 and later; POSIX.1-2001 and later.
.PP
Notes: The macro
.B FLT_EVAL_METHOD
is defined in
.IR <float.h> .
.PP
See also the
.I float_t
type in this page.
.RE
]]


Cheers,

Alex

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

Comments

Michael Kerrisk \(man-pages\) Sept. 25, 2020, 12:01 p.m. UTC | #1
Hi Alex,

On 9/25/20 1:19 PM, Alejandro Colomar wrote:
> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
> ---
> 
> Hi Michael,
> 
> On 2020-09-25 11:30, Michael Kerrisk (man-pages) wrote:
>>> I removed the "intended" part to simplify it a bit. Do you prefer to
>>> keep it?
>> Well, as long as you are going to lift the detail about "most
>> efficient" from the C standard, I'd be inclined to keep
>> the word "intended" from the standard as well. But I do not feel
>> strongly about it.
>>
> 
> Fair enough.
> 
> 
> On 2020-09-25 11:30, Michael Kerrisk (man-pages) wrote:
>>> BTW, I'll also add a note that FLT_EVAL_METHOD is defined in <float.h>
>>> Would you add that to "Notes", or as part of the description?
>> As part of the description I think. (And I don't mind if it's
>> repeated in the double_t description.)
> 
> I think there was a misunderstanding; maybe I should have been clearer:
> 
> I meant to write about <float.h> in the "Notes" of the type,
> and not in the "NOTES" of the entire page.

Okay -- got it now.

> 
> However, I decided to do it in the description of the type as you said,
> because it was a bit simpler.
> 
> The other version would have resulted in this code, just for you to see:

I think the path you took was better. I've applied the patch and 
done some very light editing.

Thanks,

Michael


> 
> [[
> .TP
> .I double_t
> .RS
> .PP
> Include:
> .IR <math.h> .
> .PP
> The implementation's most efficient floating type at least as wide as
> .IR double .
> Its type depends on the value of the macro
> .BR FLT_EVAL_METHOD :
> .TP
> 0
> .I double_t
> is
> .IR double .
> .TP
> 1
> .I double_t
> is
> .IR double .
> .TP
> 2
> .I double_t
> is
> .IR "long double" .
> .IP
> For other values of
> .BR FLT_EVAL_METHOD ,
> the type of
> .I double_t
> is implementation-defined.
> .PP
> Conforming to: C99 and later; POSIX.1-2001 and later.
> .PP
> Notes: The macro
> .B FLT_EVAL_METHOD
> is defined in
> .IR <float.h> .
> .PP
> See also the
> .I float_t
> type in this page.
> .RE
> ]]
> 
> 
> Cheers,
> 
> Alex
> 
>  man7/system_data_types.7 | 42 ++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 42 insertions(+)
> 
> diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
> index b04457bbf..aa5ab95e9 100644
> --- a/man7/system_data_types.7
> +++ b/man7/system_data_types.7
> @@ -147,6 +147,48 @@ Conforming to: C99 and later; POSIX.1-2001 and later.
>  .IP
>  See also:
>  .BR fenv (3)
> +.\"------------------------------------- float_t ----------------------/
> +.TP
> +.I float_t
> +.IP
> +Include:
> +.IR <math.h> .
> +.IP
> +The implementation's most efficient floating type at least as wide as
> +.IR float .
> +Its type depends on the value of the macro
> +.BR FLT_EVAL_METHOD ,
> +defined in
> +.IR <float.h> :
> +.RS
> +.TP
> +0
> +.I float_t
> +is
> +.IR float .
> +.TP
> +1
> +.I float_t
> +is
> +.IR double .
> +.TP
> +2
> +.I float_t
> +is
> +.IR "long double" .
> +.IP
> +For other values of
> +.BR FLT_EVAL_METHOD ,
> +the type of
> +.I float_t
> +is implementation-defined.
> +.RE
> +.IP
> +Conforming to: C99 and later; POSIX.1-2001 and later.
> +.IP
> +See also the
> +.I double_t
> +type in this page.
>  .\"------------------------------------- gid_t ------------------------/
>  .TP
>  .I gid_t
>
diff mbox series

Patch

diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index b04457bbf..aa5ab95e9 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -147,6 +147,48 @@  Conforming to: C99 and later; POSIX.1-2001 and later.
 .IP
 See also:
 .BR fenv (3)
+.\"------------------------------------- float_t ----------------------/
+.TP
+.I float_t
+.IP
+Include:
+.IR <math.h> .
+.IP
+The implementation's most efficient floating type at least as wide as
+.IR float .
+Its type depends on the value of the macro
+.BR FLT_EVAL_METHOD ,
+defined in
+.IR <float.h> :
+.RS
+.TP
+0
+.I float_t
+is
+.IR float .
+.TP
+1
+.I float_t
+is
+.IR double .
+.TP
+2
+.I float_t
+is
+.IR "long double" .
+.IP
+For other values of
+.BR FLT_EVAL_METHOD ,
+the type of
+.I float_t
+is implementation-defined.
+.RE
+.IP
+Conforming to: C99 and later; POSIX.1-2001 and later.
+.IP
+See also the
+.I double_t
+type in this page.
 .\"------------------------------------- gid_t ------------------------/
 .TP
 .I gid_t