Commit 4c993c44 by Tobias Burnus Committed by Tobias Burnus

re PR fortran/46543 (libquadmath: Add documentation)

2010-12-08  Tobias Burnus  <burnus@net-b.de>

        PR fortran/46543
        * configure.ac: Add texinfo checks.
        * Makefile.am: Handle .texi documentation.
        * libquadmath.texi: New.
        * configure: Regenerated.
        * Makefile.in: Regenerated.

From-SVN: r167583
parent 505b439a
2010-12-08 Tobias Burnus <burnus@net-b.de>
PR fortran/46543
* configure.ac: Add texinfo checks.
* Makefile.am: Handle .texi documentation.
* libquadmath.texi: New.
* configure: Regenerated.
* Makefile.in: Regenerated.
2010-12-06 Tobias Burnus <burnus@net-b.de>
PR fortran/46817
......
......@@ -105,4 +105,46 @@ AM_MAKEFLAGS = \
MAKEOVERRIDES=
# AM_CONDITIONAL on configure option --generated-files-in-srcdir
if GENINSRC
STAMP_GENINSRC = stamp-geninsrc
else
STAMP_GENINSRC =
endif
# AM_CONDITIONAL on configure check ACX_CHECK_PROG_VER([MAKEINFO])
if BUILD_INFO
STAMP_BUILD_INFO = stamp-build-info
else
STAMP_BUILD_INFO =
endif
all-local: $(STAMP_GENINSRC)
stamp-geninsrc: libquadmath.info
cp -p $(top_builddir)/libquadmath.info $(srcdir)/libquadmath.info
@touch $@
libquadmath.info: $(STAMP_BUILD_INFO)
stamp-build-info: libquadmath.texi
$(MAKEINFO) $(AM_MAKEINFOFLAGS) $(MAKEINFOFLAGS) -I $(srcdir) -o libquadmath.info $(srcdir)/libquadmath.texi
@touch $@
CLEANFILES = $(STAMP_GENINSRC) $(STAMP_BUILD_INFO) libquadmath.info
MAINTAINERCLEANFILES = $(srcdir)/libquadmath.info
endif
# Automake Documentation:
# If your package has Texinfo files in many directories, you can use the
# variable TEXINFO_TEX to tell Automake where to find the canonical
# `texinfo.tex' for your package. The value of this variable should be
# the relative path from the current `Makefile.am' to `texinfo.tex'.
TEXINFO_TEX = ../gcc/doc/include/texinfo.tex
# Defines info, dvi, pdf and html targets
MAKEINFOFLAGS = -I $(srcdir)/../gcc/doc/include
info_TEXINFOS = libquadmath.texi
......@@ -601,6 +601,8 @@ ac_subst_vars='am__EXEEXT_FALSE
am__EXEEXT_TRUE
LTLIBOBJS
LIBOBJS
GENINSRC_FALSE
GENINSRC_TRUE
BUILD_LIBQUADMATH_FALSE
BUILD_LIBQUADMATH_TRUE
LIBQUAD_USE_SYMVER_SUN_FALSE
......@@ -653,6 +655,8 @@ LDFLAGS
CFLAGS
CC
LIBTOOL
BUILD_INFO_FALSE
BUILD_INFO_TRUE
am__untar
am__tar
AMTAR
......@@ -740,6 +744,7 @@ with_gnu_ld
enable_libtool_lock
enable_maintainer_mode
enable_multilib
enable_generated_files_in_srcdir
'
ac_precious_vars='build_alias
host_alias
......@@ -1370,7 +1375,9 @@ Optional Features:
--disable-option-checking ignore unrecognized --enable/--with options
--disable-FEATURE do not include FEATURE (same as --enable-FEATURE=no)
--enable-FEATURE[=ARG] include FEATURE [ARG=yes]
--enable-version-specific-runtime-libs Specify that runtime libraries should be installed in a compiler-specific directory
--enable-version-specific-runtime-libs
specify that runtime libraries should be installed
in a compiler-specific directory
--enable-shared[=PKGS] build shared libraries [default=yes]
--enable-static[=PKGS] build static libraries [default=yes]
--enable-fast-install[=PKGS]
......@@ -1381,6 +1388,10 @@ Optional Features:
--enable-maintainer-mode enable make rules and dependencies not useful
(and sometimes confusing) to the casual installer
--enable-multilib build many library versions (default)
--enable-generated-files-in-srcdir
put copies of generated files in source dir intended
for creating source tarballs for users without
texinfo bison or flex
Optional Packages:
--with-PACKAGE[=ARG] use PACKAGE [ARG=yes]
......@@ -2766,6 +2777,82 @@ $as_echo "$version_specific_libs" >&6; }
# See if makeinfo has been installed and is modern enough
# that we can use it.
# Extract the first word of "makeinfo", so it can be a program name with args.
set dummy makeinfo; ac_word=$2
{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5
$as_echo_n "checking for $ac_word... " >&6; }
if test "${ac_cv_prog_MAKEINFO+set}" = set; then :
$as_echo_n "(cached) " >&6
else
if test -n "$MAKEINFO"; then
ac_cv_prog_MAKEINFO="$MAKEINFO" # Let the user override the test.
else
as_save_IFS=$IFS; IFS=$PATH_SEPARATOR
for as_dir in $PATH
do
IFS=$as_save_IFS
test -z "$as_dir" && as_dir=.
for ac_exec_ext in '' $ac_executable_extensions; do
if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then
ac_cv_prog_MAKEINFO="makeinfo"
$as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5
break 2
fi
done
done
IFS=$as_save_IFS
fi
fi
MAKEINFO=$ac_cv_prog_MAKEINFO
if test -n "$MAKEINFO"; then
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $MAKEINFO" >&5
$as_echo "$MAKEINFO" >&6; }
else
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5
$as_echo "no" >&6; }
fi
if test -n "$MAKEINFO"; then
# Found it, now check the version.
{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for modern makeinfo" >&5
$as_echo_n "checking for modern makeinfo... " >&6; }
if test "${gcc_cv_prog_makeinfo_modern+set}" = set; then :
$as_echo_n "(cached) " >&6
else
ac_prog_version=`eval $MAKEINFO --version 2>&1 |
sed -n 's/^.*GNU texinfo.* \([0-9][0-9.]*\).*$/\1/p'`
case $ac_prog_version in
'') gcc_cv_prog_makeinfo_modern=no;;
4.[4-9]*|4.[1-9][0-9]*|[5-9]*|[1-9][0-9]*) gcc_cv_prog_makeinfo_modern=yes;;
*) gcc_cv_prog_makeinfo_modern=no;;
esac
fi
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $gcc_cv_prog_makeinfo_modern" >&5
$as_echo "$gcc_cv_prog_makeinfo_modern" >&6; }
else
gcc_cv_prog_makeinfo_modern=no
fi
if test $gcc_cv_prog_makeinfo_modern = no; then
MAKEINFO="${CONFIG_SHELL-/bin/sh} $ac_aux_dir/missing makeinfo"
fi
if test $gcc_cv_prog_makeinfo_modern = "yes"; then
BUILD_INFO_TRUE=
BUILD_INFO_FALSE='#'
else
BUILD_INFO_TRUE='#'
BUILD_INFO_FALSE=
fi
# Configure libtool
case `pwd` in
*\ * | *\ *)
......@@ -10250,7 +10337,7 @@ else
lt_dlunknown=0; lt_dlno_uscore=1; lt_dlneed_uscore=2
lt_status=$lt_dlunknown
cat > conftest.$ac_ext <<_LT_EOF
#line 10253 "configure"
#line 10340 "configure"
#include "confdefs.h"
#if HAVE_DLFCN_H
......@@ -10356,7 +10443,7 @@ else
lt_dlunknown=0; lt_dlno_uscore=1; lt_dlneed_uscore=2
lt_status=$lt_dlunknown
cat > conftest.$ac_ext <<_LT_EOF
#line 10359 "configure"
#line 10446 "configure"
#include "confdefs.h"
#if HAVE_DLFCN_H
......@@ -11995,6 +12082,37 @@ else
multilib_arg=
fi
# We would like our source tree to be readonly. However when releases or
# pre-releases are generated, the flex/bison generated files as well as the
# various formats of manuals need to be included along with the rest of the
# sources. Therefore we have --enable-generated-files-in-srcdir to do
# just that.
{ $as_echo "$as_me:${as_lineno-$LINENO}: checking generated-files-in-srcdir" >&5
$as_echo_n "checking generated-files-in-srcdir... " >&6; }
# Check whether --enable-generated-files-in-srcdir was given.
if test "${enable_generated_files_in_srcdir+set}" = set; then :
enableval=$enable_generated_files_in_srcdir; case "$enableval" in
yes) enable_generated_files_in_srcdir=yes ;;
no) enable_generated_files_in_srcdir=no ;;
*) as_fn_error "Unknown argument to enable/disable version-specific libs" "$LINENO" 5;;
esac
else
enable_generated_files_in_srcdir=no
fi
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $enable_generated_files_in_srcdir" >&5
$as_echo "$enable_generated_files_in_srcdir" >&6; }
if test "$enable_generated_files_in_srcdir" = yes; then
GENINSRC_TRUE=
GENINSRC_FALSE='#'
else
GENINSRC_TRUE='#'
GENINSRC_FALSE=
fi
ac_config_files="$ac_config_files Makefile"
cat >confcache <<\_ACEOF
......@@ -12102,6 +12220,10 @@ else
am__EXEEXT_FALSE=
fi
if test -z "${BUILD_INFO_TRUE}" && test -z "${BUILD_INFO_FALSE}"; then
as_fn_error "conditional \"BUILD_INFO\" was never defined.
Usually this means the macro was only invoked conditionally." "$LINENO" 5
fi
if test -z "${AMDEP_TRUE}" && test -z "${AMDEP_FALSE}"; then
as_fn_error "conditional \"AMDEP\" was never defined.
Usually this means the macro was only invoked conditionally." "$LINENO" 5
......@@ -12134,6 +12256,10 @@ if test -z "${BUILD_LIBQUADMATH_TRUE}" && test -z "${BUILD_LIBQUADMATH_FALSE}";
as_fn_error "conditional \"BUILD_LIBQUADMATH\" was never defined.
Usually this means the macro was only invoked conditionally." "$LINENO" 5
fi
if test -z "${GENINSRC_TRUE}" && test -z "${GENINSRC_FALSE}"; then
as_fn_error "conditional \"GENINSRC\" was never defined.
Usually this means the macro was only invoked conditionally." "$LINENO" 5
fi
: ${CONFIG_STATUS=./config.status}
ac_write_fail=0
......
......@@ -30,7 +30,8 @@ AM_INIT_AUTOMAKE([1.9.0 foreign subdir-objects no-dist -Wall -Werror])
AC_MSG_CHECKING([for --enable-version-specific-runtime-libs])
AC_ARG_ENABLE(version-specific-runtime-libs,
[ --enable-version-specific-runtime-libs Specify that runtime libraries should be installed in a compiler-specific directory ],
AS_HELP_STRING([--enable-version-specific-runtime-libs],
[specify that runtime libraries should be installed in a compiler-specific directory]),
[case "$enableval" in
yes) version_specific_libs=yes ;;
no) version_specific_libs=no ;;
......@@ -41,6 +42,14 @@ AC_MSG_RESULT($version_specific_libs)
GCC_NO_EXECUTABLES
# See if makeinfo has been installed and is modern enough
# that we can use it.
ACX_CHECK_PROG_VER([MAKEINFO], [makeinfo], [--version],
[GNU texinfo.* \([0-9][0-9.]*\)],
[4.[4-9]*|4.[1-9][0-9]*|[5-9]*|[1-9][0-9]*])
AM_CONDITIONAL(BUILD_INFO, test $gcc_cv_prog_makeinfo_modern = "yes")
# Configure libtool
AM_PROG_LIBTOOL
ACX_LT_HOST_FLAGS
......@@ -187,5 +196,25 @@ else
multilib_arg=
fi
# We would like our source tree to be readonly. However when releases or
# pre-releases are generated, the flex/bison generated files as well as the
# various formats of manuals need to be included along with the rest of the
# sources. Therefore we have --enable-generated-files-in-srcdir to do
# just that.
AC_MSG_CHECKING(generated-files-in-srcdir)
AC_ARG_ENABLE(generated-files-in-srcdir,
AS_HELP_STRING([--enable-generated-files-in-srcdir],
[put copies of generated files in source dir intended for creating source tarballs for users without texinfo bison or flex]),
[case "$enableval" in
yes) enable_generated_files_in_srcdir=yes ;;
no) enable_generated_files_in_srcdir=no ;;
*) AC_MSG_ERROR([Unknown argument to enable/disable version-specific libs]);;
esac],
[enable_generated_files_in_srcdir=no])
AC_MSG_RESULT($enable_generated_files_in_srcdir)
AM_CONDITIONAL(GENINSRC, test "$enable_generated_files_in_srcdir" = yes)
AC_CONFIG_FILES(Makefile)
AC_OUTPUT
\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename libquadmath.info
@settitle GCC libquadmath
@c %**end of header
@copying
Copyright @copyright{} 2010 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
and with the Back-Cover Texts as in (a) below. A copy of the
license is included in the section entitled ``GNU Free Documentation
License.''
(a) The FSF's Back-Cover Text is: ``You have the freedom to
copy and modify this GNU manual.
@end quotation
@end copying
@ifinfo
@dircategory GNU Libraries
@direntry
* libquadmath: (libquadmath). GCC Quad-Precision Math Library
@end direntry
This manual documents the GCC Quad-Precision Math Library API.
Published by the Free Software Foundation
51 Franklin Street, Fifth Floor
Boston, MA 02110-1301 USA
@insertcopying
@end ifinfo
@setchapternewpage odd
@titlepage
@title The GCC Quad-Precision Math Library
@page
@vskip 0pt plus 1filll
@comment For the @value{version-GCC} Version*
@sp 1
Published by the Free Software Foundation @*
51 Franklin Street, Fifth Floor@*
Boston, MA 02110-1301, USA@*
@sp 1
@insertcopying
@end titlepage
@summarycontents
@contents
@page
@node Top
@top Introduction
@cindex Introduction
This manual documents the usage of libquadmath, the GCC Quad-Precision
Math Library Application Programming Interface (API).
@comment
@comment When you add a new menu item, please keep the right hand
@comment aligned to the same column. Do not use tabs. This provides
@comment better formatting.
@comment
@menu
* Math Library Routines:: The Libquadmath math runtime application
programming interface.
* I/O Library Routines:: The Libquadmath I/O runtime application
programming interface.
* GNU Free Documentation License::
How you can copy and share this manual.
* Reporting Bugs:: How to report bugs in GCC Libquadmath.
@c * Index:: Index of this documentation.
@end menu
@c ---------------------------------------------------------------------
@c Math routines
@c ---------------------------------------------------------------------
@node Math Library Routines
@chapter Math Library Routines
The following mathematical functions are available:
@table @asis
@item @code{acosq}: arc cosine function
@item @code{acoshq}: inverse hyperbolic cosine function
@item @code{asinq}: arc sine function
@item @code{asinhq}: inverse hyperbolic sine function
@item @code{atanq}: arc tangent function
@item @code{atanhq}: inverse hyperbolic tangent function
@item @code{atan2q}: arc tangent function
@item @code{cbrtq}: cube root function
@item @code{ceilq}: ceiling value function
@item @code{copysignq}: copy sign of a number
@item @code{coshq}: hyperbolic cosine function
@item @code{cosq}: cosine function
@item @code{erfq}: error function
@item @code{erfcq}: complementary error function
@item @code{expq}: exponential function
@item @code{expm1q}: exponential minus 1 function
@need 800
@item @code{fabsq}: absolute value function
@item @code{finiteq}: check finiteness of value
@item @code{floorq}: floor value function
@item @code{fmodq}: remainder value function
@item @code{frexpq}: extract mantissa and exponent
@item @code{hypotq}: Eucledian distance function
@item @code{isinfq}: check for infinity
@item @code{isnanq}: check for not a number
@item @code{j0q}: Bessel function of the first kind, first order
@item @code{j1q}: Bessel function of the first kind, second order
@item @code{jnq}: Bessel function of the first kind, @var{n}-th order
@item @code{ldexpq}: load exponent of the value
@item @code{lgammaq}: logarithmic gamma function
@item @code{llroundq}: round to nearest integer value away from zero
@item @code{logq}: natural logarithm function
@item @code{log10q}: base 10 logarithm function
@item @code{log1pq}: compute natural logarithm of the value plus one
@need 800
@item @code{lroundq}: round to nearest integer value away from zero
@item @code{modfq}: decompose the floating-point number
@item @code{nanq}: return quiet NaN
@item @code{nextafterq}: next representable floating-point number
@item @code{powq}: power function
@item @code{remainderq}: remainder function
@item @code{rintq}: round-to-nearest integral value
@item @code{roundq}: round-to-nearest integral value, return @code{__float128}
@item @code{scalblnq}: compute exponent using @code{FLT_RADIX}
@item @code{scalbnq}: compute exponent using @code{FLT_RADIX}
@item @code{signbitq}: return sign bit
@item @code{sincosq}: calculate sine and cosine simulataneously
@item @code{sinhq}: hyperbolic sine function
@item @code{sinq}: sine function
@item @code{sqrtq}: square root function
@item @code{tanq}: tangent function
@item @code{tanhq}: hyperbolic tangent function
@need 800
@item @code{tgammaq}: true gamma function
@item @code{truncq}: round to integer, towards zero
@item @code{y0q}: Bessel function of the second kind, first order
@item @code{y1q}: Bessel function of the second kind, second order
@item @code{ynq}: Bessel function of the second kind, @var{n}-th order
@item @code{cabsq} complex absolute value function:
@item @code{cargq}: calculate the argument
@item @code{ccosq} complex cosine function:
@item @code{ccoshq}: complex hyperbolic cosine function
@item @code{cexpq}: complex exponential function
@item @code{cexpiq}: computes the exponential function of ``i'' times a
real value
@item @code{clogq}: complex natural logarithm
@item @code{clog10q}: complex base 10 logarithm
@item @code{cpowq}: complex power function
@item @code{csinq}: complex sine function
@item @code{csinhq}: complex hyperbolic sine function
@need 800
@item @code{csqrtq}: complex square root
@item @code{ctanq}: complex tangent function
@item @code{ctanhq}: complex hyperbolic tangent function
@end table
@c ---------------------------------------------------------------------
@c I/O routines
@c ---------------------------------------------------------------------
@node I/O Library Routines
@chapter I/O Library Routines
@menu
* @code{quadmath_strtopQ}: quadmath_strtopQ, Convert from string
* @code{quadmath_dtoaq}: quadmath_dtoaq, Convert to string
@end menu
@node quadmath_strtopQ
@section @code{quadmath_strtopQ} --- Convert from string
The function @code{dmath_strtopQ} converts a string into a
@code{__float128} number.
@table @asis
@item Syntax
@code{int quadmath_strtopQ (const char *s, char **sp, void *V)}
@c The return values are defined in gdtoa/gdtoa.h STRTOG_*
@c However, the values are currently not exported - thus we
@c do not define them here, either.
@item @emph{Arguments}:
@multitable @columnfractions .15 .70
@item @var{s} @tab input string
@item @var{sp} @tab the address of the next character in the string
@item @var{V} @tab @code{__float128} containing the converted number
@end multitable
The argument @var{sp} contains, if not @code{NULL}, the address of the
next character following the parts of the string, which have been read.
@item Example
@smallexample
#include <quadmath.h>
int main ()
@{
__float128 r;
char str[200];
quadmath_strtopQ ("1.2345678", NULL, &r);
return 0;
@}
@end smallexample
@end table
@node quadmath_dtoaq
@section @code{quadmath_dtoaq} --- Convert to string
The function @code{quadmath_dtoaq} converts a @code{__float128} floating-point
number into a string.
@table @asis
@item Syntax
@code{void quadmath_dtoaq (char *s, size_t size, size_t n, __float128 x)}
@item @emph{Arguments}:
@multitable @columnfractions .15 .70
@item @var{s} @tab output string
@item @var{size} @tab byte size of the string, including tailing NUL
@item @var{n} @tab number of digits after the decimal point
@item @var{x} @tab the number to be converted
@end multitable
@item Example
@smallexample
#include <quadmath.h>
int main ()
@{
__float128 r;
char str[200];
r = 2.0q;
r = sqrtq(r);
quadmath_dtoaq (str, sizeof (str), 20, r);
printf("%s\n", str);
/* Prints: +1.41421356237309504880e+00 */
return 0;
@}
@end smallexample
@end table
@c ---------------------------------------------------------------------
@c GNU Free Documentation License
@c ---------------------------------------------------------------------
@include fdl.texi
@c ---------------------------------------------------------------------
@c Reporting Bugs
@c ---------------------------------------------------------------------
@node Reporting Bugs
@chapter Reporting Bugs
Bugs in the GCC Quad-Precision Math Library implementation should be
reported via @value{BUGURL}.
@c ---------------------------------------------------------------------
@c Index
@c ---------------------------------------------------------------------
@c @node Index
@c @unnumbered Index
@c
@c @printindex cp
@bye
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment