Skip to content

Commit f81a6c5

Browse files
authored
gh-95415: Make availability directive consistent (GH-95416)
1 parent 2fbee85 commit f81a6c5

17 files changed

+208
-101
lines changed

Doc/library/_thread.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,9 @@ This module defines the following constants and functions:
140140
information (4 KiB pages are common; using multiples of 4096 for the stack size is
141141
the suggested approach in the absence of more specific information).
142142

143-
.. availability:: Windows, systems with POSIX threads.
143+
.. availability:: Windows, pthreads.
144+
145+
Unix platforms with POSIX threads support.
144146

145147

146148
.. data:: TIMEOUT_MAX

Doc/library/codecs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1530,7 +1530,7 @@ functions can be used directly if desired.
15301530

15311531
This module implements the ANSI codepage (CP_ACP).
15321532

1533-
.. availability:: Windows only.
1533+
.. availability:: Windows.
15341534

15351535
.. versionchanged:: 3.3
15361536
Support any error handler.

Doc/library/crypt.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ the :manpage:`crypt(3)` routine in the running system. Therefore, any
3636
extensions available on the current implementation will also be available on
3737
this module.
3838

39-
.. availability:: Unix. Not available on VxWorks.
39+
.. availability:: Unix, not VxWorks.
4040

4141
Hashing Methods
4242
---------------

Doc/library/intro.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,7 @@ Notes on availability
6060
* If not separately noted, all functions that claim "Availability: Unix" are
6161
supported on macOS, which builds on a Unix core.
6262

63+
* If an availability note contains both a minimum Kernel version and a minimum
64+
libc version, then both conditions must hold. For example a feature with note
65+
*Availability: Linux >= 3.17 with glibc >= 2.27* requires both Linux 3.17 or
66+
newer and glibc 2.27 or newer.

Doc/library/os.rst

Lines changed: 42 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ process and user.
301301
and ``'surrogateescape'`` error handler. Use :func:`os.getenvb` if you
302302
would like to use a different encoding.
303303

304-
.. availability:: most flavors of Unix, Windows.
304+
.. availability:: Unix, Windows.
305305

306306

307307
.. function:: getenvb(key, default=None)
@@ -316,7 +316,7 @@ process and user.
316316
:func:`getenvb` is only available if :data:`supports_bytes_environ`
317317
is ``True``.
318318

319-
.. availability:: most flavors of Unix.
319+
.. availability:: Unix.
320320

321321
.. versionadded:: 3.2
322322

@@ -706,7 +706,7 @@ process and user.
706706
:func:`socket.gethostname` or even
707707
``socket.gethostbyaddr(socket.gethostname())``.
708708

709-
.. availability:: recent flavors of Unix.
709+
.. availability:: Unix.
710710

711711
.. versionchanged:: 3.3
712712
Return type changed from a tuple to a tuple-like object
@@ -824,7 +824,7 @@ as internal buffering of data.
824824
It will always copy no bytes and return 0 as if the file was empty
825825
because of a known Linux kernel issue.
826826

827-
.. availability:: Linux kernel >= 4.5 or glibc >= 2.27.
827+
.. availability:: Linux >= 4.5 with glibc >= 2.27.
828828

829829
.. versionadded:: 3.8
830830

@@ -1164,7 +1164,7 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
11641164
descriptors are :ref:`non-inheritable <fd_inheritance>`. For a (slightly) more
11651165
portable approach, use the :mod:`pty` module.
11661166

1167-
.. availability:: some flavors of Unix.
1167+
.. availability:: Unix.
11681168

11691169
.. versionchanged:: 3.4
11701170
The new file descriptors are now non-inheritable.
@@ -1190,7 +1190,7 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
11901190
Return a pair of file descriptors ``(r, w)`` usable for reading and writing,
11911191
respectively.
11921192

1193-
.. availability:: some flavors of Unix.
1193+
.. availability:: Unix.
11941194

11951195
.. versionadded:: 3.3
11961196

@@ -1269,9 +1269,9 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
12691269

12701270
Combine the functionality of :func:`os.readv` and :func:`os.pread`.
12711271

1272-
.. availability:: Linux 2.6.30 and newer, FreeBSD 6.0 and newer,
1273-
OpenBSD 2.7 and newer, AIX 7.1 and newer. Using flags requires
1274-
Linux 4.6 or newer.
1272+
.. availability:: Linux >= 2.6.30, FreeBSD >= 6.0, OpenBSD >= 2.7, AIX >= 7.1.
1273+
1274+
Using flags requires Linux >= 4.6.
12751275

12761276
.. versionadded:: 3.7
12771277

@@ -1286,7 +1286,7 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
12861286
If no bytes were read, it will return ``-1`` and set errno to
12871287
:data:`errno.EAGAIN`.
12881288

1289-
.. availability:: Linux 4.14 and newer.
1289+
.. availability:: Linux >= 4.14.
12901290

12911291
.. versionadded:: 3.7
12921292

@@ -1300,7 +1300,7 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
13001300
Currently, on Linux, this feature is usable only on a file descriptor opened
13011301
using the :data:`O_DIRECT` flag.
13021302

1303-
.. availability:: Linux 4.6 and newer.
1303+
.. availability:: Linux >= 4.6.
13041304

13051305
.. versionadded:: 3.7
13061306

@@ -1339,9 +1339,9 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
13391339

13401340
Combine the functionality of :func:`os.writev` and :func:`os.pwrite`.
13411341

1342-
.. availability:: Linux 2.6.30 and newer, FreeBSD 6.0 and newer,
1343-
OpenBSD 2.7 and newer, AIX 7.1 and newer. Using flags requires
1344-
Linux 4.7 or newer.
1342+
.. availability:: Linux >= 2.6.30, FreeBSD >= 6.0, OpenBSD >= 2.7, AIX >= 7.1.
1343+
1344+
Using flags requires Linux >= 4.6.
13451345

13461346
.. versionadded:: 3.7
13471347

@@ -1351,7 +1351,7 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
13511351
Provide a per-write equivalent of the :data:`O_DSYNC` :func:`os.open` flag.
13521352
This flag effect applies only to the data range written by the system call.
13531353

1354-
.. availability:: Linux 4.7 and newer.
1354+
.. availability:: Linux >= 4.7.
13551355

13561356
.. versionadded:: 3.7
13571357

@@ -1361,7 +1361,7 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
13611361
Provide a per-write equivalent of the :data:`O_SYNC` :func:`os.open` flag.
13621362
This flag effect applies only to the data range written by the system call.
13631363

1364-
.. availability:: Linux 4.7 and newer.
1364+
.. availability:: Linux >= 4.7.
13651365

13661366
.. versionadded:: 3.7
13671367

@@ -1375,7 +1375,7 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
13751375
appended to the end of the file. However, if the *offset* argument is
13761376
``-1``, the current file *offset* is updated.
13771377

1378-
.. availability:: Linux 4.16 and newer.
1378+
.. availability:: Linux >= 4.16.
13791379

13801380
.. versionadded:: 3.10
13811381

@@ -1495,7 +1495,7 @@ or `the MSDN <https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Windo
14951495
make sense to block because there are no writers connected to the write end
14961496
of the pipe.
14971497

1498-
.. availability:: Linux kernel >= 2.6.17 and glibc >= 2.5
1498+
.. availability:: Linux >= 2.6.17 with glibc >= 2.5
14991499

15001500
.. versionadded:: 3.10
15011501

@@ -3334,7 +3334,7 @@ features:
33343334
the file descriptor, and as such multiple files can have the same name
33353335
without any side effects.
33363336

3337-
.. availability:: Linux 3.17 or newer with glibc 2.27 or newer.
3337+
.. availability:: Linux >= 3.17 with glibc >= 2.27.
33383338

33393339
.. versionadded:: 3.8
33403340

@@ -3359,8 +3359,9 @@ features:
33593359

33603360
These flags can be passed to :func:`memfd_create`.
33613361

3362-
.. availability:: Linux 3.17 or newer with glibc 2.27 or newer. The
3363-
``MFD_HUGE*`` flags are only available since Linux 4.14.
3362+
.. availability:: Linux >= 3.17 with glibc >= 2.27
3363+
3364+
The ``MFD_HUGE*`` flags are only available since Linux 4.14.
33643365

33653366
.. versionadded:: 3.8
33663367

@@ -3412,7 +3413,7 @@ features:
34123413
finally:
34133414
os.close(fd)
34143415

3415-
.. availability:: Linux 2.6.27 or newer with glibc 2.8 or newer.
3416+
.. availability:: Linux >= 2.6.27 with glibc >= 2.8
34163417

34173418
.. versionadded:: 3.10
34183419

@@ -3421,7 +3422,7 @@ features:
34213422
Read value from an :func:`eventfd` file descriptor and return a 64 bit
34223423
unsigned int. The function does not verify that *fd* is an :func:`eventfd`.
34233424

3424-
.. availability:: See :func:`eventfd`
3425+
.. availability:: Linux >= 2.6.27
34253426

34263427
.. versionadded:: 3.10
34273428

@@ -3430,15 +3431,15 @@ features:
34303431
Add value to an :func:`eventfd` file descriptor. *value* must be a 64 bit
34313432
unsigned int. The function does not verify that *fd* is an :func:`eventfd`.
34323433

3433-
.. availability:: See :func:`eventfd`
3434+
.. availability:: Linux >= 2.6.27
34343435

34353436
.. versionadded:: 3.10
34363437

34373438
.. data:: EFD_CLOEXEC
34383439

34393440
Set close-on-exec flag for new :func:`eventfd` file descriptor.
34403441

3441-
.. availability:: See :func:`eventfd`
3442+
.. availability:: Linux >= 2.6.27
34423443

34433444
.. versionadded:: 3.10
34443445

@@ -3447,7 +3448,7 @@ features:
34473448
Set :const:`O_NONBLOCK` status flag for new :func:`eventfd` file
34483449
descriptor.
34493450

3450-
.. availability:: See :func:`eventfd`
3451+
.. availability:: Linux >= 2.6.27
34513452

34523453
.. versionadded:: 3.10
34533454

@@ -3456,7 +3457,7 @@ features:
34563457
Provide semaphore-like semantics for reads from a :func:`eventfd` file
34573458
descriptor. On read the internal counter is decremented by one.
34583459

3459-
.. availability:: Linux 2.6.30 or newer with glibc 2.8 or newer.
3460+
.. availability:: Linux >= 2.6.30
34603461

34613462
.. versionadded:: 3.10
34623463

@@ -3861,7 +3862,7 @@ written in Python, such as a mail server's external command delivery program.
38613862
Calling ``forkpty()`` in a subinterpreter is no longer supported
38623863
(:exc:`RuntimeError` is raised).
38633864

3864-
.. availability:: some flavors of Unix.
3865+
.. availability:: Unix.
38653866

38663867

38673868
.. function:: kill(pid, sig)
@@ -3917,7 +3918,7 @@ written in Python, such as a mail server's external command delivery program.
39173918

39183919
See the :manpage:`pidfd_open(2)` man page for more details.
39193920

3920-
.. availability:: Linux 5.3+
3921+
.. availability:: Linux >= 5.3
39213922
.. versionadded:: 3.9
39223923

39233924
.. data:: PIDFD_NONBLOCK
@@ -3927,7 +3928,7 @@ written in Python, such as a mail server's external command delivery program.
39273928
then an attempt to wait on the file descriptor using :manpage:`waitid(2)`
39283929
will immediately return the error :data:`~errno.EAGAIN` rather than blocking.
39293930

3930-
.. availability:: Linux 5.10+
3931+
.. availability:: Linux >= 5.10
39313932
.. versionadded:: 3.12
39323933

39333934

@@ -4077,7 +4078,9 @@ written in Python, such as a mail server's external command delivery program.
40774078

40784079
.. versionadded:: 3.8
40794080

4080-
.. availability:: See :func:`posix_spawn` documentation.
4081+
.. availability:: POSIX
4082+
4083+
See :func:`posix_spawn` documentation.
40814084

40824085

40834086
.. function:: register_at_fork(*, before=None, after_in_parent=None, \
@@ -4177,7 +4180,9 @@ written in Python, such as a mail server's external command delivery program.
41774180

41784181
.. audit-event:: os.spawn mode,path,args,env os.spawnl
41794182

4180-
.. availability:: Unix, Windows. :func:`spawnlp`, :func:`spawnlpe`, :func:`spawnvp`
4183+
.. availability:: Unix, Windows.
4184+
4185+
:func:`spawnlp`, :func:`spawnlpe`, :func:`spawnvp`
41814186
and :func:`spawnvpe` are not available on Windows. :func:`spawnle` and
41824187
:func:`spawnve` are not thread-safe on Windows; we advise you to use the
41834188
:mod:`subprocess` module instead.
@@ -4381,7 +4386,7 @@ written in Python, such as a mail server's external command delivery program.
43814386
This is a Linux-specific *idtype* that indicates that *id* is a file
43824387
descriptor that refers to a process.
43834388

4384-
.. availability:: Linux 5.4+
4389+
.. availability:: Linux >= 5.4
43854390

43864391
.. versionadded:: 3.9
43874392

@@ -4523,7 +4528,9 @@ written in Python, such as a mail server's external command delivery program.
45234528
This option causes child processes to be reported if they have been continued
45244529
from a job control stop since their status was last reported.
45254530

4526-
.. availability:: some Unix systems.
4531+
.. availability:: Unix.
4532+
4533+
Some Unix systems.
45274534

45284535

45294536
.. data:: WUNTRACED
@@ -4929,7 +4936,7 @@ Random numbers
49294936
See also the `Linux getrandom() manual page
49304937
<http://man7.org/linux/man-pages/man2/getrandom.2.html>`_.
49314938

4932-
.. availability:: Linux 3.17 and newer.
4939+
.. availability:: Linux >= 3.17.
49334940

49344941
.. versionadded:: 3.6
49354942

Doc/library/pipes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The :mod:`pipes` module defines a class to abstract the concept of a *pipeline*
2323
Because the module uses :program:`/bin/sh` command lines, a POSIX or compatible
2424
shell for :func:`os.system` and :func:`os.popen` is required.
2525

26-
.. availability:: Unix. Not available on VxWorks.
26+
.. availability:: Unix, not VxWorks.
2727

2828
The :mod:`pipes` module defines the following class:
2929

0 commit comments

Comments
 (0)