]> git.ipfire.org Git - thirdparty/man-pages.git/commitdiff
Added RETURN VALUE section.
authorMichael Kerrisk <mtk.manpages@gmail.com>
Fri, 1 Aug 2008 05:26:38 +0000 (05:26 +0000)
committerMichael Kerrisk <mtk.manpages@gmail.com>
Fri, 1 Aug 2008 05:26:38 +0000 (05:26 +0000)
Added ERRORS section; noted that errno is not set; see
also http://sources.redhat.com/bugzilla/show_bug.cgi?id=6801.
Updated CONFORMING TO.

man3/remquo.3

index e9cca4d3d88b07dc1a5dc1cfd4f9ead8749d210c..aa85d10a5828e5accad6c4b71c20e73c0134d205 100644 (file)
@@ -1,8 +1,10 @@
 .\" 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
 .\" based on glibc infopages
 .\" polished, aeb
-.TH REMQUO 3 2007-07-26 "GNU" "Linux Programmer's Manual"
+.TH REMQUO 3 2008-07-29 "GNU" "Linux Programmer's Manual"
 .SH NAME
 remquo, remquof, remquol \- remainder and part of quotient
 .SH SYNOPSIS
@@ -39,7 +41,7 @@ by
 A few bits of the quotient are stored via the
 .I quo
 pointer.
-The remainder is returned as function value.
+The remainder is returned as the function result.
 
 The value of the remainder is the same as that computed by the
 .BR remainder (3)
@@ -58,8 +60,57 @@ Note that the actual quotient might not fit in an integer.
 .\"
 .\" glibc, UnixWare: return 3 bits
 .\" MacOS 10: return 7 bits
+.SH RETURN VALUE
+On success, these functions return the same value as
+the analogous functions described in
+.BR remainder (3).
+
+If
+.I x
+or
+.I y
+is a NaN, a NaN is returned.
+
+If
+.I x
+is an infinity,
+and
+.I y
+is not a NaN,
+a "domain error" occurs, and
+a NaN is returned.
+
+If
+.I y
+is zero,
+and
+.I x
+is not a NaN,
+a "domain error" occurs, and
+a NaN is returned.
+.SH ERRORS
+See
+.BR math_error (7)
+for information on how to determine whether an error has occurred
+when calling these functions.
+.PP
+The following errors can occur:
+.TP
+Domain error: \fIx\fP is an infinity or \fIy\fP is 0, \
+and the other argument is not a NaN
+.\" .I errno
+.\" is set to
+.\" .BR EDOM .
+An invalid floating-point exception
+.RB ( FE_INVALID )
+is raised.
+.PP
+These functions do not set
+.IR errno .
+.\" FIXME . Is it intentional that these functions do not set errno?
+.\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6802
 .SH "CONFORMING TO"
-C99.
+C99, POSIX.1-2001.
 .SH "SEE ALSO"
 .BR fmod (3),
 .BR logb (3),