summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPetr Viktorin <encukou@gmail.com>2022-04-22 10:44:43 (GMT)
committerGitHub <noreply@github.com>2022-04-22 10:44:43 (GMT)
commit82ec638ab706577c043056a57e2a2322b43ef94a (patch)
tree5965e5df5711633e727b1756aa65a77f3c730f11
parentbcf14ae4336fced718c00edc34b9191c2b48525a (diff)
downloadcpython-82ec638ab706577c043056a57e2a2322b43ef94a.zip
cpython-82ec638ab706577c043056a57e2a2322b43ef94a.tar.gz
cpython-82ec638ab706577c043056a57e2a2322b43ef94a.tar.bz2
Docs: Clarify availability of PyOS_CheckStack (GH-91816)
-rw-r--r--Doc/c-api/sys.rst6
-rw-r--r--Include/pythonrun.h1
2 files changed, 4 insertions, 3 deletions
diff --git a/Doc/c-api/sys.rst b/Doc/c-api/sys.rst
index de94e3f..66216ee 100644
--- a/Doc/c-api/sys.rst
+++ b/Doc/c-api/sys.rst
@@ -96,9 +96,9 @@ Operating System Utilities
Return true when the interpreter runs out of stack space. This is a reliable
check, but is only available when :const:`USE_STACKCHECK` is defined (currently
- on Windows using the Microsoft Visual C++ compiler). :const:`USE_STACKCHECK`
- will be defined automatically; you should never change the definition in your
- own code.
+ on certain versions of Windows using the Microsoft Visual C++ compiler).
+ :const:`USE_STACKCHECK` will be defined automatically; you should never
+ change the definition in your own code.
.. c:function:: PyOS_sighandler_t PyOS_getsig(int i)
diff --git a/Include/pythonrun.h b/Include/pythonrun.h
index 0271577..1b208b7 100644
--- a/Include/pythonrun.h
+++ b/Include/pythonrun.h
@@ -24,6 +24,7 @@ PyAPI_DATA(int) (*PyOS_InputHook)(void);
#if defined(WIN32) && !defined(MS_WIN64) && !defined(_M_ARM) && defined(_MSC_VER) && _MSC_VER >= 1300
/* Enable stack checking under Microsoft C */
+// When changing the platforms, ensure PyOS_CheckStack() docs are still correct
#define USE_STACKCHECK
#endif