Skip to content

Commit 540c0d9

Browse files
miss-islingtonerlend-aaslandAA-Turner
authored
[3.12] Docs: Remove links to external C functions and macros in os.rst (GH-108138) (#108143)
Docs: Remove links to external C functions and macros in os.rst (GH-108138) (cherry picked from commit c31c61c) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Adam Turner <[email protected]>
1 parent 0c21298 commit 540c0d9

File tree

1 file changed

+27
-25
lines changed

1 file changed

+27
-25
lines changed

Doc/library/os.rst

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ process and user.
215215

216216
On some platforms, including FreeBSD and macOS, setting ``environ`` may
217217
cause memory leaks. Refer to the system documentation for
218-
:c:func:`putenv`.
218+
:c:func:`!putenv`.
219219

220220
You can delete items in this mapping to unset environment variables.
221221
:func:`unsetenv` will be called automatically when an item is deleted from
@@ -564,7 +564,7 @@ process and user.
564564
.. note::
565565

566566
On some platforms, including FreeBSD and macOS, setting ``environ`` may
567-
cause memory leaks. Refer to the system documentation for :c:func:`putenv`.
567+
cause memory leaks. Refer to the system documentation for :c:func:`!putenv`.
568568

569569
.. audit-event:: os.putenv key,value os.putenv
570570

@@ -646,15 +646,15 @@ process and user.
646646

647647
.. function:: setpgrp()
648648

649-
Call the system call :c:func:`setpgrp` or ``setpgrp(0, 0)`` depending on
649+
Call the system call :c:func:`!setpgrp` or ``setpgrp(0, 0)`` depending on
650650
which version is implemented (if any). See the Unix manual for the semantics.
651651

652652
.. availability:: Unix, not Emscripten, not WASI.
653653

654654

655655
.. function:: setpgid(pid, pgrp, /)
656656

657-
Call the system call :c:func:`setpgid` to set the process group id of the
657+
Call the system call :c:func:`!setpgid` to set the process group id of the
658658
process with id *pid* to the process group with id *pgrp*. See the Unix manual
659659
for the semantics.
660660

@@ -1077,7 +1077,7 @@ as internal buffering of data.
10771077
.. function:: fsync(fd)
10781078

10791079
Force write of file with filedescriptor *fd* to disk. On Unix, this calls the
1080-
native :c:func:`fsync` function; on Windows, the MS :c:func:`_commit` function.
1080+
native :c:func:`!fsync` function; on Windows, the MS :c:func:`!_commit` function.
10811081

10821082
If you're starting with a buffered Python :term:`file object` *f*, first do
10831083
``f.flush()``, and then do ``os.fsync(f.fileno())``, to ensure that all internal
@@ -2304,7 +2304,7 @@ features:
23042304

23052305
.. function:: lstat(path, *, dir_fd=None)
23062306

2307-
Perform the equivalent of an :c:func:`lstat` system call on the given path.
2307+
Perform the equivalent of an :c:func:`!lstat` system call on the given path.
23082308
Similar to :func:`~os.stat`, but does not follow symbolic links. Return a
23092309
:class:`stat_result` object.
23102310

@@ -3147,14 +3147,16 @@ features:
31473147

31483148
Windows file attributes: ``dwFileAttributes`` member of the
31493149
``BY_HANDLE_FILE_INFORMATION`` structure returned by
3150-
:c:func:`GetFileInformationByHandle`. See the ``FILE_ATTRIBUTE_*``
3150+
:c:func:`!GetFileInformationByHandle`.
3151+
See the :const:`!FILE_ATTRIBUTE_* <stat.FILE_ATTRIBUTE_ARCHIVE>`
31513152
constants in the :mod:`stat` module.
31523153

31533154
.. attribute:: st_reparse_tag
31543155

3155-
When :attr:`st_file_attributes` has the ``FILE_ATTRIBUTE_REPARSE_POINT``
3156+
When :attr:`st_file_attributes` has the :const:`~stat.FILE_ATTRIBUTE_REPARSE_POINT`
31563157
set, this field contains the tag identifying the type of reparse point.
3157-
See the ``IO_REPARSE_TAG_*`` constants in the :mod:`stat` module.
3158+
See the :const:`IO_REPARSE_TAG_* <stat.IO_REPARSE_TAG_SYMLINK>`
3159+
constants in the :mod:`stat` module.
31583160

31593161
The standard module :mod:`stat` defines functions and constants that are
31603162
useful for extracting information from a :c:struct:`stat` structure. (On
@@ -3212,7 +3214,7 @@ features:
32123214

32133215
.. function:: statvfs(path)
32143216

3215-
Perform a :c:func:`statvfs` system call on the given path. The return value is
3217+
Perform a :c:func:`!statvfs` system call on the given path. The return value is
32163218
an object whose attributes describe the filesystem on the given path, and
32173219
correspond to the members of the :c:struct:`statvfs` structure, namely:
32183220
:attr:`f_bsize`, :attr:`f_frsize`, :attr:`f_blocks`, :attr:`f_bfree`,
@@ -4303,7 +4305,7 @@ written in Python, such as a mail server's external command delivery program.
43034305
setpgroup=None, resetids=False, setsid=False, setsigmask=(), \
43044306
setsigdef=(), scheduler=None)
43054307

4306-
Wraps the :c:func:`posix_spawn` C library API for use from Python.
4308+
Wraps the :c:func:`!posix_spawn` C library API for use from Python.
43074309

43084310
Most users should use :func:`subprocess.run` instead of :func:`posix_spawn`.
43094311

@@ -4339,44 +4341,44 @@ written in Python, such as a mail server's external command delivery program.
43394341
Performs ``os.dup2(fd, new_fd)``.
43404342

43414343
These tuples correspond to the C library
4342-
:c:func:`posix_spawn_file_actions_addopen`,
4343-
:c:func:`posix_spawn_file_actions_addclose`, and
4344-
:c:func:`posix_spawn_file_actions_adddup2` API calls used to prepare
4345-
for the :c:func:`posix_spawn` call itself.
4344+
:c:func:`!posix_spawn_file_actions_addopen`,
4345+
:c:func:`!posix_spawn_file_actions_addclose`, and
4346+
:c:func:`!posix_spawn_file_actions_adddup2` API calls used to prepare
4347+
for the :c:func:`!posix_spawn` call itself.
43464348

43474349
The *setpgroup* argument will set the process group of the child to the value
43484350
specified. If the value specified is 0, the child's process group ID will be
43494351
made the same as its process ID. If the value of *setpgroup* is not set, the
43504352
child will inherit the parent's process group ID. This argument corresponds
4351-
to the C library :c:macro:`POSIX_SPAWN_SETPGROUP` flag.
4353+
to the C library :c:macro:`!POSIX_SPAWN_SETPGROUP` flag.
43524354

43534355
If the *resetids* argument is ``True`` it will reset the effective UID and
43544356
GID of the child to the real UID and GID of the parent process. If the
43554357
argument is ``False``, then the child retains the effective UID and GID of
43564358
the parent. In either case, if the set-user-ID and set-group-ID permission
43574359
bits are enabled on the executable file, their effect will override the
43584360
setting of the effective UID and GID. This argument corresponds to the C
4359-
library :c:macro:`POSIX_SPAWN_RESETIDS` flag.
4361+
library :c:macro:`!POSIX_SPAWN_RESETIDS` flag.
43604362

43614363
If the *setsid* argument is ``True``, it will create a new session ID
4362-
for ``posix_spawn``. *setsid* requires :c:macro:`POSIX_SPAWN_SETSID`
4363-
or :c:macro:`POSIX_SPAWN_SETSID_NP` flag. Otherwise, :exc:`NotImplementedError`
4364+
for ``posix_spawn``. *setsid* requires :c:macro:`!POSIX_SPAWN_SETSID`
4365+
or :c:macro:`!POSIX_SPAWN_SETSID_NP` flag. Otherwise, :exc:`NotImplementedError`
43644366
is raised.
43654367

43664368
The *setsigmask* argument will set the signal mask to the signal set
43674369
specified. If the parameter is not used, then the child inherits the
43684370
parent's signal mask. This argument corresponds to the C library
4369-
:c:macro:`POSIX_SPAWN_SETSIGMASK` flag.
4371+
:c:macro:`!POSIX_SPAWN_SETSIGMASK` flag.
43704372

43714373
The *sigdef* argument will reset the disposition of all signals in the set
43724374
specified. This argument corresponds to the C library
4373-
:c:macro:`POSIX_SPAWN_SETSIGDEF` flag.
4375+
:c:macro:`!POSIX_SPAWN_SETSIGDEF` flag.
43744376

43754377
The *scheduler* argument must be a tuple containing the (optional) scheduler
43764378
policy and an instance of :class:`sched_param` with the scheduler parameters.
43774379
A value of ``None`` in the place of the scheduler policy indicates that is
43784380
not being provided. This argument is a combination of the C library
4379-
:c:macro:`POSIX_SPAWN_SETSCHEDPARAM` and :c:macro:`POSIX_SPAWN_SETSCHEDULER`
4381+
:c:macro:`!POSIX_SPAWN_SETSCHEDPARAM` and :c:macro:`!POSIX_SPAWN_SETSCHEDULER`
43804382
flags.
43814383

43824384
.. audit-event:: os.posix_spawn path,argv,env os.posix_spawn
@@ -4389,7 +4391,7 @@ written in Python, such as a mail server's external command delivery program.
43894391
setpgroup=None, resetids=False, setsid=False, setsigmask=(), \
43904392
setsigdef=(), scheduler=None)
43914393

4392-
Wraps the :c:func:`posix_spawnp` C library API for use from Python.
4394+
Wraps the :c:func:`!posix_spawnp` C library API for use from Python.
43934395

43944396
Similar to :func:`posix_spawn` except that the system searches
43954397
for the *executable* file in the list of directories specified by the
@@ -4570,7 +4572,7 @@ written in Python, such as a mail server's external command delivery program.
45704572

45714573
Use *show_cmd* to override the default window style. Whether this has any
45724574
effect will depend on the application being launched. Values are integers as
4573-
supported by the Win32 :c:func:`ShellExecute` function.
4575+
supported by the Win32 :c:func:`!ShellExecute` function.
45744576

45754577
:func:`startfile` returns as soon as the associated application is launched.
45764578
There is no option to wait for the application to close, and no way to retrieve
@@ -4580,7 +4582,7 @@ written in Python, such as a mail server's external command delivery program.
45804582
:func:`os.path.normpath` function to ensure that paths are properly encoded for
45814583
Win32.
45824584

4583-
To reduce interpreter startup overhead, the Win32 :c:func:`ShellExecute`
4585+
To reduce interpreter startup overhead, the Win32 :c:func:`!ShellExecute`
45844586
function is not resolved until this function is first called. If the function
45854587
cannot be resolved, :exc:`NotImplementedError` will be raised.
45864588

0 commit comments

Comments
 (0)