]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-106861: Docs: Add availability directives to all Unix-only modules (#108975)
authorxzmeng <aumo@foxmail.com>
Tue, 31 Oct 2023 16:14:27 +0000 (00:14 +0800)
committerGitHub <noreply@github.com>
Tue, 31 Oct 2023 16:14:27 +0000 (18:14 +0200)
Doc/library/fcntl.rst
Doc/library/grp.rst
Doc/library/posix.rst
Doc/library/pty.rst
Doc/library/pwd.rst
Doc/library/resource.rst
Doc/library/syslog.rst
Doc/library/termios.rst
Doc/library/tty.rst

index 969a79fa87339582de702a7ab9906873c926f64a..309ad652d4af34af596edb8d73062ffd335af193 100644 (file)
@@ -18,7 +18,7 @@ interface to the :c:func:`fcntl` and :c:func:`ioctl` Unix routines.  For a
 complete description of these calls, see :manpage:`fcntl(2)` and
 :manpage:`ioctl(2)` Unix manual pages.
 
-.. include:: ../includes/wasm-notavail.rst
+.. availability:: Unix, not Emscripten, not WASI.
 
 All functions in this module take a file descriptor *fd* as their first
 argument.  This can be an integer file descriptor, such as returned by
index 8f88f82e1c21adc845b5697ebd76ae017913fc8b..274a353103b488b4ae3002e605c25ca2c051c442 100644 (file)
@@ -10,7 +10,7 @@
 This module provides access to the Unix group database. It is available on all
 Unix versions.
 
-.. include:: ../includes/wasm-notavail.rst
+.. availability:: Unix, not Emscripten, not WASI.
 
 Group database entries are reported as a tuple-like object, whose attributes
 correspond to the members of the ``group`` structure (Attribute field below, see
index 0413f9d02a8d57bb39233def592d8c91de910e33..5871574b442667e52bf57210141a419afc27b10c 100644 (file)
@@ -11,6 +11,8 @@ This module provides access to operating system functionality that is
 standardized by the C Standard and the POSIX standard (a thinly disguised Unix
 interface).
 
+.. availability:: Unix.
+
 .. index:: pair: module; os
 
 **Do not import this module directly.**  Instead, import the module :mod:`os`,
index ad4981c97119faf6a0e26f2c95f69b10594f7327..af9378464edb9f69166926f57a7febd405672bcf 100644 (file)
@@ -16,6 +16,8 @@ The :mod:`pty` module defines operations for handling the pseudo-terminal
 concept: starting another process and being able to write to and read from its
 controlling terminal programmatically.
 
+.. availability:: Unix.
+
 Pseudo-terminal handling is highly platform dependent. This code is mainly
 tested on Linux, FreeBSD, and macOS (it is supposed to work on other POSIX
 platforms but it's not been thoroughly tested).
index 300419301b9ff52b659412e654960a947cb3e1e2..dbe68cd14ec4d4e4d4314ccc2e0158afefb7122a 100644 (file)
@@ -10,7 +10,7 @@
 This module provides access to the Unix user account and password database.  It
 is available on all Unix versions.
 
-.. include:: ../includes/wasm-notavail.rst
+.. availability:: Unix, not Emscripten, not WASI.
 
 Password database entries are reported as a tuple-like object, whose attributes
 correspond to the members of the ``passwd`` structure (Attribute field below,
index a5324c82c634841ee5642138ee0534cebdd4cb9b..ef65674d1b0a787382181abd32f9775a8cd93a96 100644 (file)
@@ -13,7 +13,7 @@
 This module provides basic mechanisms for measuring and controlling system
 resources utilized by a program.
 
-.. include:: ../includes/wasm-notavail.rst
+.. availability:: Unix, not Emscripten, not WASI.
 
 Symbolic constants are used to specify particular system resources and to
 request usage information about either the current process or its children.
index f29ef03267b1ba3d06e1164f350d154c5a8b80ea..b5ab446e0096edae310526797e027c95bb3add3f 100644 (file)
@@ -11,12 +11,12 @@ This module provides an interface to the Unix ``syslog`` library routines.
 Refer to the Unix manual pages for a detailed description of the ``syslog``
 facility.
 
+.. availability:: Unix, not Emscripten, not WASI.
+
 This module wraps the system ``syslog`` family of routines.  A pure Python
 library that can speak to a syslog server is available in the
 :mod:`logging.handlers` module as :class:`SysLogHandler`.
 
-.. include:: ../includes/wasm-notavail.rst
-
 The module defines the following functions:
 
 
index 03806178e9d3fbd89b6600f1a5f5ab7be8529ad1..57705ddc4e64705f2a92fa109c682c7b42cf29a9 100644 (file)
@@ -16,6 +16,8 @@ complete description of these calls, see :manpage:`termios(3)` Unix manual
 page.  It is only available for those Unix versions that support POSIX
 *termios* style tty I/O control configured during installation.
 
+.. availability:: Unix.
+
 All functions in this module take a file descriptor *fd* as their first
 argument.  This can be an integer file descriptor, such as returned by
 ``sys.stdin.fileno()``, or a :term:`file object`, such as ``sys.stdin`` itself.
index a4777772e1fc6c84a398ce7d094643bc4268f8c7..20ba7d7e0a45b309937d8c9f9103c31ab4bbdccc 100644 (file)
@@ -15,6 +15,8 @@
 The :mod:`tty` module defines functions for putting the tty into cbreak and raw
 modes.
 
+.. availability:: Unix.
+
 Because it requires the :mod:`termios` module, it will work only on Unix.
 
 The :mod:`tty` module defines the following functions: