summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2006-10-12 11:41:11 (GMT)
committerGeorg Brandl <georg@python.org>2006-10-12 11:41:11 (GMT)
commit10f0f691d3773011192532bd5030af98cd90b94f (patch)
tree793bf8eb7fdfb8194c41c36b7ad8e4f29ab43b41
parent2c1375c8db6d62128f594aec3820292576daff8b (diff)
downloadcpython-10f0f691d3773011192532bd5030af98cd90b94f.zip
cpython-10f0f691d3773011192532bd5030af98cd90b94f.tar.gz
cpython-10f0f691d3773011192532bd5030af98cd90b94f.tar.bz2
Add a note to fpectl docs that it's not built by default
(bug #1556261).
-rw-r--r--Doc/lib/libfpectl.tex7
1 files changed, 6 insertions, 1 deletions
diff --git a/Doc/lib/libfpectl.tex b/Doc/lib/libfpectl.tex
index 814e226..9cbf86e 100644
--- a/Doc/lib/libfpectl.tex
+++ b/Doc/lib/libfpectl.tex
@@ -7,6 +7,11 @@
\sectionauthor{Lee Busby}{busby1@llnl.gov}
\modulesynopsis{Provide control for floating point exception handling.}
+\note{The \module{fpectl} module is not built by default, and its usage
+ is discouraged and may be dangerous except in the hand of
+ experts. See also the section \ref{fpectl-limitations} on
+ limitations for more details.}
+
Most computers carry out floating point operations\index{IEEE-754}
in conformance with the so-called IEEE-754 standard.
On any real computer,
@@ -95,7 +100,7 @@ FloatingPointError: in math_1
\end{verbatim}
-\subsection{Limitations and other considerations}
+\subsection{Limitations and other considerations \label{fpectl-limitations}}
Setting up a given processor to trap IEEE-754 floating point
errors currently requires custom code on a per-architecture basis.