[Python-checkins] r52308 - python/branches/release25-maint/Doc/lib/libfpectl.tex

[georg.brandl]

Author: georg.brandl
Date: Thu Oct 12 13:41:15 2006
New Revision: 52308

Modified:
   python/branches/release25-maint/Doc/lib/libfpectl.tex
Log:
Add a note to fpectl docs that it's not built by default
(bug #1556261).
 (backport from rev. 52307)

Modified: python/branches/release25-maint/Doc/lib/libfpectl.tex
==============================================================================
--- python/branches/release25-maint/Doc/lib/libfpectl.tex	(original)
+++ python/branches/release25-maint/Doc/lib/libfpectl.tex	Thu Oct 12 13:41:15 2006
@@ -7,6 +7,11 @@
 \sectionauthor{Lee Busby}{busby1 at 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 @@
 \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.