gh-95415: Make availability directive consistent (GH-95416) #95416
Conversation
tiran
commented
Jul 29, 2022
•
- Issue: Make "availability" directive consistent and parsable #95415
tiran
force-pushed
the
gh-95415-availability-doc
branch
from
1c52b29
to
1e6b8cf
Compare
tiran
changed the title
|
Thanks @tiran for the PR |
|
Sorry, @tiran, I could not cleanly backport this to |
|
GH-95438 is a backport of this pull request to the 3.11 branch. |
| .. availability:: most Unix platforms, possibly others. | ||
| .. availability:: Unix. | ||
|
|
||
| most Unix platforms. |
There was a problem hiding this comment.
| most Unix platforms. | |
| Most Unix platforms. |
| @@ -429,7 +431,7 @@ since it is impossible to detect the termination of alien threads. | |||
| system-wide) from the time the thread is created until the thread | |||
| has been terminated. | |||
|
|
|||
| .. availability:: Requires :func:`get_native_id` function. | |||
| .. availability:: Windows, FreeBSD, Linux, macOS, OpenBSD, NetBSD, AIX, DragonFlyBSD. | |||
There was a problem hiding this comment.
I would keep the previous sentence under the list of platforms.
| known_platforms = frozenset({ | ||
| "AIX", "Android", "BSD", "DragonFlyBSD", "Emscripten", "FreeBSD", | ||
| "Linux", "NetBSD", "OpenBSD", "POSIX", "Solaris", "Unix", "VxWorks", | ||
| "WASI", "Windows", "macOS", | ||
| # libc | ||
| "BSD libc", "glibc", "musl", | ||
| # POSIX platforms with pthreads | ||
| "pthreads", | ||
| }) |
There was a problem hiding this comment.
| known_platforms = frozenset({ | |
| "AIX", "Android", "BSD", "DragonFlyBSD", "Emscripten", "FreeBSD", | |
| "Linux", "NetBSD", "OpenBSD", "POSIX", "Solaris", "Unix", "VxWorks", | |
| "WASI", "Windows", "macOS", | |
| # libc | |
| "BSD libc", "glibc", "musl", | |
| # POSIX platforms with pthreads | |
| "pthreads", | |
| }) | |
| known_platforms = frozenset({ | |
| "AIX", "Android", "BSD", "DragonFlyBSD", "Emscripten", "FreeBSD", | |
| "Linux", "NetBSD", "OpenBSD", "POSIX", "Solaris", "Unix", "VxWorks", | |
| "WASI", "Windows", "macOS", | |
| # libc | |
| "BSD libc", "glibc", "musl", | |
| # POSIX platforms with pthreads | |
| "pthreads", | |
| }) |
| @@ -706,7 +706,7 @@ process and user. | |||
| :func:`socket.gethostname` or even | |||
| ``socket.gethostbyaddr(socket.gethostname())``. | |||
|
|
|||
| .. availability:: recent flavors of Unix. | |||
| .. availability:: Unix. | |||
There was a problem hiding this comment.
Should these get a note like Might not be available on less recent flavors of Unix. or Might not be available on some flavors of Unix.? Even better would be to be more specific (e.g. Not available on Unix flavors that ...).
There was a problem hiding this comment.
uname is available on all Unix-like platforms that we support. It was standardized in IEEE Std 1003.1-2001, https://pubs.opengroup.org/onlinepubs/009604599/functions/uname.html . Every POSIX-like OS released in the last 20 years should have it.
