summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2004-03-31 07:45:46 (GMT)
committerFred Drake <fdrake@acm.org>2004-03-31 07:45:46 (GMT)
commit34c43202eb0c7b369c2019f99b99bd1313ec503f (patch)
treea506a84c3cfac7de533de24acb174dfaa83473df
parent203b10c75a4bed11b72e909857084f326c9dad1c (diff)
downloadcpython-34c43202eb0c7b369c2019f99b99bd1313ec503f.zip
cpython-34c43202eb0c7b369c2019f99b99bd1313ec503f.tar.gz
cpython-34c43202eb0c7b369c2019f99b99bd1313ec503f.tar.bz2
Emphasize the requirement that Python.h be included first more strongly.
Closes SF bug #837228; backporting for Python 2.3.4.
-rw-r--r--Doc/api/intro.tex9
-rw-r--r--Doc/ext/extending.tex9
2 files changed, 12 insertions, 6 deletions
diff --git a/Doc/api/intro.tex b/Doc/api/intro.tex
index 364487d..d27a116 100644
--- a/Doc/api/intro.tex
+++ b/Doc/api/intro.tex
@@ -37,9 +37,12 @@ API are included in your code by the following line:
This implies inclusion of the following standard headers:
\code{<stdio.h>}, \code{<string.h>}, \code{<errno.h>},
\code{<limits.h>}, and \code{<stdlib.h>} (if available).
-Since Python may define some pre-processor definitions which affect
-the standard headers on some systems, you must include \file{Python.h}
-before any standard headers are included.
+
+\begin{notice}[warning]
+ Since Python may define some pre-processor definitions which affect
+ the standard headers on some systems, you \emph{must} include
+ \file{Python.h} before any standard headers are included.
+\end{notice}
All user visible names defined by Python.h (except those defined by
the included standard headers) have one of the prefixes \samp{Py} or
diff --git a/Doc/ext/extending.tex b/Doc/ext/extending.tex
index 95e4546..c50714e 100644
--- a/Doc/ext/extending.tex
+++ b/Doc/ext/extending.tex
@@ -46,9 +46,12 @@ The first line of our file can be:
which pulls in the Python API (you can add a comment describing the
purpose of the module and a copyright notice if you like).
-Since Python may define some pre-processor definitions which affect
-the standard headers on some systems, you must include \file{Python.h}
-before any standard headers are included.
+
+\begin{notice}[warning]
+ Since Python may define some pre-processor definitions which affect
+ the standard headers on some systems, you \emph{must} include
+ \file{Python.h} before any standard headers are included.
+\end{notice}
All user-visible symbols defined by \file{Python.h} have a prefix of
\samp{Py} or \samp{PY}, except those defined in standard header files.