mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

Copyedit of os.symlink() docs.

Browse source
This commit is contained in:
Georg Brandl 2010-10-06 08:52:48 +00:00
parent a102ae3426
commit 64a41edb03
1 changed files with 13 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

28
Doc/library/os.rst
View file

@ -1371,27 +1371,25 @@ Files and Directories
.. function:: symlink(source, link_name) .. function:: symlink(source, link_name)
symlink(source, link_name, target_is_directory=False)
Create a symbolic link pointing to *source* named *link_name*. Create a symbolic link pointing to *source* named *link_name*.
On Windows, symlink version takes an additional, optional parameter, On Windows, symlink version takes an additional optional parameter,
*target_is_directory*, which defaults to False. *target_is_directory*, which defaults to ``False``.
symlink(source, link_name, target_is_directory=False) On Windows, a symlink represents a file or a directory, and does not morph to
the target dynamically. For this reason, when creating a symlink on Windows,
if the target is not already present, the symlink will default to being a
file symlink. If *target_is_directory* is set to ``True``, the symlink will
be created as a directory symlink. This parameter is ignored if the target
exists (and the symlink is created with the same type as the target).
On Windows, a symlink represents a file or a directory, and does not Symbolic link support was introduced in Windows 6.0 (Vista). :func:`symlink`
morph to the target dynamically. For this reason, when creating a will raise a :exc:`NotImplementedError` on Windows versions earlier than 6.0.
symlink on Windows, if the target is not already present, the symlink The *SeCreateSymbolicLinkPrivilege* is required in order to create symlinks.
will default to being a file symlink. If *target_is_directory* is set to
True, the symlink will be created as a directory symlink. This
parameter is ignored if the target exists (and the symlink is created
with the same type as the target).
Symbolic link support was introduced in Windows 6.0 (Vista). *symlink* Availability: Unix, Windows.
will raise a NotImplementedError on Windows versions earlier than 6.0. The
SeCreateSymbolicLinkPrivilege is required in order to create symlinks.
Availability: Unix, Windows
.. versionchanged:: 3.2 .. versionchanged:: 3.2
Added support for Windows 6.0 (Vista) symbolic links. Added support for Windows 6.0 (Vista) symbolic links.