From: Georg Brandl <georg@python.org>
Date: Thu, 12 Oct 2006 11:41:11 +0000 (+0000)
Subject: Add a note to fpectl docs that it's not built by default
X-Git-Tag: v2.6a1~2572
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=10f0f691d3773011192532bd5030af98cd90b94f;p=python

Add a note to fpectl docs that it's not built by default
(bug #1556261).
---

diff --git a/Doc/lib/libfpectl.tex b/Doc/lib/libfpectl.tex
index 814e226575..9cbf86e682 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.