[PATCH] clean up newlib documentation

Bob Wilson bwilson@tensilica.com
Wed Oct 22 16:29:00 GMT 2003

Since no one "official" has yet answered my question about copyright 
requirements etc. for contributing a new port, I thought I might get started 
by contributing some fixes to the newlib documentation.  This is a big patch, 
but there are only a few separate issues:

* There are lots of places where the hyphenation is incorrect.  The patch 
fixes a lot of places where "floating-point", "single-precision" and 
"double-precision" need to be hyphenated but were not.

* The current documentation uses all 3 of "nonzero", "non-zero" and "non 
zero".  The last variant ("non zero") seems incorrect so I replaced it with 
"nonzero", which is what the GCC project uses.  I didn't attempt to fix all 
the uses of "non-zero".

* The locale documentation uses double single quotes inside of code, e.g., 
<<``C''>>, which is not right.  It might look fine for some output formats, 
but it ought be just regular double quotes.

* There are many places where both TeX and non-TeX versions of a description 
are provided, especially for libm.  This was written with @iftex and @ifinfo.  
If you then produce HTML output, you end up with neither version, which is 
really bad, especially because this shows up in the middle of sentences, etc.  
The patch changes these cases to use @iftex and @ifnottex.

* There are several glaring typos in the docs, e.g., "exp1.0nt" instead of 
"exponent".  I fixed these, as well as a few comment typos that I stumbled 

I tested this by running "make info" and browsing through the output.

Is this OK to commit?  I think I have write access for newlib from working on 
binutils.  If someone else would like to commit this for me, that would be 
fine, too.

2003-10-17  Bob Wilson  <bob.wilson@acm.org>

	* libc/locale/locale.c: Use double quotes in code.
	* libc/locale/locale.tex: Likewise.
	* libc/libc.texinfo: Hyphenate "floating-point".
	* libc/machine/necv70/necv70.tex: Likewise.
	* libc/stdio/sprintf.c: Likewise.
	* libc/stdio/sscanf.c: Likewise.
	* libc/stdlib/atof.c: Likewise.
	* libc/stdlib/ldtoa.c: Fix comment typo.
	* libc/stdlib/div.c: Use @ifnottex instead of @ifinfo.
	* libc/stdlib/ldiv.c: Likewise.
	* libm/common/s_expm1.c: Likewise.
	* libm/common/s_ilogb.c: Hyphenate "floating-point".  Use "nonzero".
	* libm/common/s_infinity: Hyphenate "double- and single-precision".
	* libm/common/s_nan.c: Likewise.  Also correct the FUNCTION summary.
	* libm/common/s_nextafter.c: Fix typo.  Hyphenate "double-precision"
	and "floating-point".
	* libm/common/s_scalbn.c: Correct the FUNCTION summary.
	* libm/math/e_pow.c: Fix comment typo.
	* libm/math/math.tex: Hyphenate "single-precision" and "floating-point".
	* libm/math/s_asinh.c: Use @ifnottex instead of @ifinfo.
	* libm/math/s_atan.c: Likewise.
	* libm/math/s_frexp.c: Likewise.  Also use "nonzero".
	* libm/math/s_isnan.c: Hyphenate "single-precision" and
	"floating-point".  Use "nonzero".
	* libm/math/s_ldexp.c: Use @ifnottex instead of @ifinfo.
	* libm/math/w_acos.c: Likewise.
	* libm/math/w_acosh.c: Likewise.
	* libm/math/w_asin.c: Likewise.
	* libm/math/w_atan2.c: Likewise.
	* libm/math/w_atanh.c: Likewise.
	* libm/math/w_cosh.c: Likewise.
	* libm/math/w_exp.c: Likewise.
	* libm/math/w_exp2.c: Likewise.  Add missing @end and missing @tex
	version of 2^x in the description.
	* libm/math/w_fmod.c: Use @ifnottex instead of @ifinfo.
	* libm/math/w_gamma.c: Likewise.
	* libm/math/w_hypot.c: Likewise.
	* libm/math/w_j0.c: Likewise.
	* libm/math/w_sinh.c: Likewise.
	* libm/math/w_pow.c: Replace "exp1.0nt" with "exponent".
	* libm/mathfp/mathfp.tex: Hyphenate "single-precision" and
	* libm/mathfp/e_acosh.c: Use @ifnottex instead of @ifinfo.
	* libm/mathfp/e_atanh.c: Likewise.
	* libm/mathfp/e_hypot.c: Likewise.
	* libm/mathfp/er_lgamma.c: Likewise.
	* libm/mathfp/s_acos.c: Likewise.
	* libm/mathfp/s_asine.c: Likewise.
	* libm/mathfp/s_asinh.c: Likewise.
	* libm/mathfp/s_atan.c: Likewise.
	* libm/mathfp/s_atan2.c: Likewise.
	* libm/mathfp/s_atangent.c: Likewise.
	* libm/mathfp/s_cosh.c: Likewise.
	* libm/mathfp/s_exp.c: Likewise.
	* libm/mathfp/s_fmod.c: Likewise.
	* libm/mathfp/s_frexp.c: Likewise.  Also use "nonzero".
	* libm/mathfp/s_isnan.c: Hyphenate "single-precision" and
	"floating-point".  Use "nonzero".
	* libm/math/s_pow.c: Replace "exp1.0nt" with "exponent".
	* libm/mathfp/s_ldexp.c: Use @ifnottex instead of @ifinfo.
	* libm/mathfp/s_sineh.c: Likewise.
	* libm/mathfp/w_jn.c: Likewise.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: newlib-doc-diffs
Type: text/x-diff
Size: 45086 bytes
Desc: not available
URL: <http://sourceware.org/pipermail/newlib/attachments/20031022/784d6bd4/attachment.bin>

More information about the Newlib mailing list