]> git.ipfire.org Git - thirdparty/man-pages.git/commitdiff
NAME: Make description clearer
authorMichael Kerrisk <mtk.manpages@gmail.com>
Thu, 24 Jul 2008 14:29:55 +0000 (14:29 +0000)
committerMichael Kerrisk <mtk.manpages@gmail.com>
Thu, 24 Jul 2008 14:29:55 +0000 (14:29 +0000)
SYNOPSIS: Add feature test macro requirements.
SYNOPSIS: Remove unneeded "Compile with" piece.
CONFORMING TO: Add POSIX.1-2001.
Add RETURN VALUE and ERRORS sections.

man3/fmax.3
man3/fmin.3

index f0775574830dc7fcf742ca7d7b77943c96d1787b..9fc15503d0bf1f4557f9925ec5210b1691177095 100644 (file)
@@ -1,9 +1,11 @@
 .\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
+.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
+.\"     <mtk.manpages@gmail.com>
 .\" Distributed under GPL
 .\"
-.TH FMAX 3 2002-07-28 "" "Linux Programmer's Manual"
+.TH FMAX 3 2008-07-25 "" "Linux Programmer's Manual"
 .SH NAME
-fmax, fmaxf, fmaxl \- find maximum value
+fmax, fmaxf, fmaxl \- determine maximum of two floating-point numbers
 .SH SYNOPSIS
 .B #include <math.h>
 .sp
@@ -13,13 +15,37 @@ fmax, fmaxf, fmaxl \- find maximum value
 .br
 .BI "long double fmaxl(long double " x ", long double " y );
 .sp
-Compile with \fI\-std=c99\fP; link with \fI\-lm\fP.
+Link with \fI\-lm\fP.
+.sp
+.in -4n
+Feature Test Macro Requirements for glibc (see
+.BR feature_test_macros (7)):
+.in
+.sp
+.ad l
+.BR fmax (),
+.BR fmaxf (),
+.BR fmaxl ():
+_XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE; or
+.I cc\ -std=c99
+.ad b
 .SH DESCRIPTION
-Return the larger value of
+These functions return the larger value of
+.I x
+and
+.IR y .
+.SH RETURN VALUE
+These functions return the maximum of
 .I x
 and
 .IR y .
+
+If one argument is a NaN, the other argument is returned.
+
+If both arguments are NaN, a NaN is returned.
+.SH ERRORS
+No errors occur.
 .SH "CONFORMING TO"
-C99.
+C99, POSIX.1-2001.
 .SH "SEE ALSO"
 .BR fmin (3)
index 9a423baeb880ea9a8a7e05812e69a34a72883d03..6cf91bd8a57e71a7760a9bd1c803b85aaa29b515 100644 (file)
@@ -1,9 +1,11 @@
 .\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
+.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
+.\"     <mtk.manpages@gmail.com>
 .\" Distributed under GPL
 .\"
-.TH FMIN 3 2002-07-28 "" "Linux Programmer's Manual"
+.TH FMIN 3 2008-07-25 "" "Linux Programmer's Manual"
 .SH NAME
-fmin, fminf, fminl \- find minimum value
+fmin, fminf, fminl \- determine minimum of two floating-point numbers
 .SH SYNOPSIS
 .B #include <math.h>
 .sp
@@ -13,13 +15,37 @@ fmin, fminf, fminl \- find minimum value
 .br
 .BI "long double fminl(long double " x ", long double " y );
 .sp
-Compile with \fI\-std=c99\fP; link with \fI\-lm\fP.
+Link with \fI\-lm\fP.
+.sp
+.in -4n
+Feature Test Macro Requirements for glibc (see
+.BR feature_test_macros (7)):
+.in
+.sp
+.ad l
+.BR fmin (),
+.BR fminf (),
+.BR fminl ():
+_XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE; or
+.I cc\ -std=c99
+.ad b
 .SH DESCRIPTION
-Return the lesser value of
+These functions the lesser value of
+.I x
+and
+.IR y .
+.SH RETURN VALUE
+These functions return the minimum of
 .I x
 and
 .IR y .
+
+If one argument is a NaN, the other argument is returned.
+
+If both arguments are NaN, a NaN is returned.
+.SH ERRORS
+No errors occur.
 .SH "CONFORMING TO"
-C99.
+C99, POSIX.1-2001.
 .SH "SEE ALSO"
 .BR fmax (3)