2009-03-25 Craig Howland <howland@LGSInnovations.com>

	* libc/include/math.h:  (llround, llroundf): Declare.
	* libm/common/s_llround.c: New file, implementing llround().
	* libm/common/sf_llround.c: New file, implementing llroundf().
	* libm/common/sf_lround.c: Remove spurious cast in _DOUBLE_IS_32BITS
	version of function.
	* libm/common/sf_lrint.c: Ditto.
	* libm/common/sf_logb.c:  Corrected return for subnormal argument
	by replacing existing function with a version created from sf_ilogb.c.
	* libm/common/s_logb.c: Ditto, except starting point s_ilogb.c.  Also
	added documentation for logb() and logbf().
	* libm/common/s_signbit.c:  Add signbit() documentation.
	* libm/common/s_log2.c: Update return values to match what w_log2.c has,
	since log2 uses log(); add note about being derived instead of direct.
	* libm/common/sf_fma.c: Add casts to attempt to get correct results,
	as well as comments pointing out problems with the implementation.
	* libm/common/s_fma.c: Add fma() and fmaf() documentation.
	* libm/common/sf_remquo.c: Incorrect quotient returns for large values
	corrected by discarding existing function and replacing with Sun
	verion, with some enhancements.
	* libm/common/s_remquo.c: Ditto.  Add remquo() and remquof()
	documentation.
	* libm/common/s_fmax.c: Add fmax() and fmaxf() documentation.
	* libm/common/s_fmin.c: Add fmin() and fminf() documentation.
	* libm/common/s_fdim.c: Return NAN for NAN arg, add fdim() and fdimf()
	documentation.
	* libm/common/sf_fdim.c: Return NAN for NAN arg, HUGE_VALF for inf arg.
	* libm/common/s_trunc.c: Add trunc() and truncf() documentation.
	* libm/common/s_rint.c: Add rint() and rintf() documentation.
	* libm/common/s_round.c: Add round() and roundf() documentation.
	* libm/common/s_scalbn.c: Add scalbln() and scalblnf() documentation.
	* libm/common/s_infinity.c: Add infinity() and infinityf()
	documentation.
	* libm/common/s_lround.c: Add lround(), lroundf(), llround(), and
	llroundf() documentation.
	* libm/common/s_lrint.c: Add lrint(), lrintf(), llrint(), and llrintf()
	documentation.
	* libm/common/isgreater.c: New file for documenting math.h function-like
	macros isgreater(), isgreaterequal(), isless(), islessequal(),
	islessgreater(), and isunordered().
	* libm/common/s_isnan.c: Add documentation for function-like macros
	fpclassify(), isfinite(), isinf(), isnan(), and isnormal().
	* libm/common/s_nearbyint.c: Add nearbyint() and nearbyintf()
	documentation.
	* libm/common/Makefile.am: Add s_llround.c (src); sf_llround.c (fsrc);
	s_fdim.def, s_fma.def, s_fmax.def, s_fmin.def,
	s_logb.def, s_lrint.def, s_lround.def, s_nearbyint.def, s_remquo.def,
        s_rint.def, s_round.def, s_signbit.def, s_trunc.def, and
        isgreater.def (chobj);
	re-name all existing chew files (chobj) to match source file base
	names (put in underscores), delete all special targets for chew files
	(leaving all to be generated by rule).
	* libm/common/Makefile.in: regenerate.
	* libm/math/w_exp2.c: Add "base 2" to documentation description (and
	delete TRAD_SYNOPSIS).
	* libm/math/w_gamma.c: Add tgamma() and tgammaf() documentation, along
	with some history behind the function names.
	* libm/math/math.tex: Add includes for newly-added documentation (see
	.def additions to common/Makefile.am and math/Makefile.am in this
	ChangeLog list), adjusted existing .def file names to match source file
	base names (added underscores); add mention of HUGE_VALF; rename
	"Version of library" section to "Error Handling" and add some text
	about floating-point exception; added section "Standards Compliance And
	Portability".
	* libm/math/Makefile.am: Add w_exp2.def (chobj);
	re-name all existing chew files (chobj) to match source file base
	names, delete all special targets for chew files (leaving all to be
	generated by rule).
	* libm/math/Makefile.in: regenerated
	* doc/makedoc.c: Change silent ignoring of commands < 5 characters
	to a failure when reading macro file for commands < 4 characters;
	add -v (verbose) option for printing some debugging information;
	get rid of spurious translation of "@*" to "*" (no source files used @*,
	so no existing doc pages were affected); clean up some compiler
	warnings.
	* doc/doc.str: add BUGS and SEEALSO sections (to match texi2pod.pl
	which has them); Remove ITEM command (redundant with makedoc built-in
	"o", not used in any present source file so nothing is lost, anyway).
	* HOWTO: New file to hold information for maintainers regarding how
	to do things.  Initial sections on documentation and ELIX levels.

1 files changed, 92 insertions, 21 deletions

diff --git a/newlib/libm/common/s_isnan.c b/newlib/libm/common/s_isnan.c
index b0c40369a..5ae6c9b81 100644
--- a/newlib/libm/common/s_isnan.c
+++ b/newlib/libm/common/s_isnan.c
@@ -13,8 +13,21 @@
 
 /*
 FUNCTION
-	<<isnan>>, <<isnanf>>, <<isinf>>, <<isinff>>, <<finite>>, <<finitef>>---test for exceptional numbers
+<<fpclassify>>, <<isfinite>>, <<isinf>>, <<isnan>>, and <<isnormal>>--floating-point classification macros; <<finite>>, <<finitef>>, <<isinf>>, <<isinff>>, <<isnan>>, <<isnanf>>--test for exceptional numbers
 
+@c C99 (start
+INDEX
+	fpclassify
+INDEX
+	isfinite
+INDEX
+	isinf
+INDEX
+	isnan
+INDEX
+	isnormal
+@c C99 end)
+@c SUSv2 (start
 INDEX
 	isnan
 INDEX
@@ -28,8 +41,18 @@ INDEX
 	isinff
 INDEX
 	finitef
+@c SUSv2 end)
 
 ANSI_SYNOPSIS
+	[C99 standard macros:]
+	#include <math.h>
+	int fpclassify(real-floating <[x]>);
+	int isfinite(real-floating <[x]>);
+	int isinf(real-floating <[x]>);
+	int isnan(real-floating <[x]>);
+	int isnormal(real-floating <[x]>);
+
+	[Archaic SUSv2 functions:]
 	#include <ieeefp.h>
 	int isnan(double <[arg]>);
 	int isinf(double <[arg]>);
@@ -38,30 +61,64 @@ ANSI_SYNOPSIS
 	int isinff(float <[arg]>);
 	int finitef(float <[arg]>);
 
-TRAD_SYNOPSIS
-	#include <ieeefp.h>
-	int isnan(<[arg]>)
-	double <[arg]>;
-	int isinf(<[arg]>)
-	double <[arg]>;
-	int finite(<[arg]>);
-	double <[arg]>;
-	int isnanf(<[arg]>);
-	float <[arg]>;
-	int isinff(<[arg]>);
-	float <[arg]>;
-	int finitef(<[arg]>);
-	float <[arg]>;
-
-
 DESCRIPTION
-	These functions provide information on the floating-point
+<<fpclassify>>, <<isfinite>>, <<isinf>>, <<isnan>>, and <<isnormal>> are macros
+defined for use in classifying floating-point numbers.  This is a help because
+of special "values" like NaN and infinities.  In the synopses shown,
+"real-floating" indicates that the argument is an expression of real floating
+type.  These function-like macros are C99 and POSIX-compliant, and should be
+used instead of the now-archaic SUSv2 functions.
+
+The <<fpclassify>> macro classifies its argument value as NaN, infinite, normal,
+subnormal, zero, or into another implementation-defined category.  First, an
+argument represented in a format wider than its semantic type is converted to
+its semantic type.  Then classification is based on the type of the argument.
+The <<fpclassify>> macro returns the value of the number classification macro
+appropriate to the value of its argument:
+
+o+
+o FP_INFINITE
+	<[x]> is either plus or minus infinity;
+o FP_NAN
+	<[x]> is "Not A Number" (plus or minus);
+o FP_NORMAL
+	<[x]> is a "normal" number (i.e. is none of the other special forms);
+o FP_SUBNORMAL
+	<[x]> is too small be stored as a regular normalized number (i.e. loss of precision is likely); or
+o FP_ZERO
+	<[x]> is 0 (either plus or minus).
+o-
+
+The "<<is>>" set of macros provide a useful set of shorthand ways for
+classifying floating-point numbers, providing the following equivalent
+relations:
+
+o+
+o <<isfinite>>(<[x]>)
+returns non-zero if <[x]> is finite.  (It is equivalent to
+(<<fpclassify>>(<[x]>) != FP_INFINITE  &&  <<fpclassify>>(<[x]>) != FP_NAN).)
+
+o <<isinf>>(<[x]>)
+returns non-zero if <[x]> is infinite.  (It is equivalent to
+(<<fpclassify>>(<[x]>) == FP_INFINITE).)
+
+o <<isnan>>(<[x]>)
+returns non-zero if <[x]> is NaN.  (It is equivalent to
+(<<fpclassify>>(<[x]>) == FP_NAN).)
+
+o <<isnormal>>(<[x]>)
+returns non-zero if <[x]> is normal.  (It is equivalent to
+(<<fpclassify>>(<[x]>) == FP_NORMAL).)
+o-
+
+	The archaic SUSv2 functions provide information on the floating-point
 	argument supplied.
 
-	There are five major number formats:
+	There are five major number formats ("exponent" referring to the
+	biased exponent in the binary-encoded number):
 	o+
 	o zero
-	  A number which contains all zero bits.
+	  A number which contains all zero bits, excluding the sign bit.
 	o subnormal
 	  A number with a zero exponent but a nonzero fraction.
 	o normal
@@ -85,7 +142,21 @@ DESCRIPTION
 	and <<isinf>> are macros that operate on multiple types of
 	floating-point.  The SUSv2 standard declares <<isnan>> as
 	a function taking double.  Newlib has decided to declare
-	them both as macros in math.h and as functions in ieeefp.h.
+	them both as macros in math.h and as functions in ieeefp.h to
+	maintain backward compatibility.
+
+RETURNS
+@comment Formatting note:  "$@" forces a new line
+The fpclassify macro returns the value corresponding to the appropriate FP_ macro.@*
+The isfinite macro returns nonzero if <[x]> is finite, else 0.@*
+The isinf macro returns nonzero if <[x]> is infinite, else 0.@*
+The isnan macro returns nonzero if <[x]> is an NaN, else 0.@*
+The isnormal macro returns nonzero if <[x]> has a normal value, else 0.
+
+PORTABILITY
+math.h macros are C99, POSIX.
+
+ieeefp.h funtions are outdated and should be avoided.
 
 QUICKREF
 	isnan - pure