languages/dart-sdk
languages/dart-sdk
1
0
Fork 0
mirror of https://github.com/dart-lang/sdk synced 2024-10-14 17:59:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify that Links on Windows have types and that the target of the symlink need not exist.

Browse source 
CoreLibraryReviewExempt: documentation-only change
Bug: https://github.com/dart-lang/sdk/issues/30665
Bug: https://github.com/dart-lang/sdk/issues/52972
Change-Id: Ia7f02fb578d67e78dd8209d7514db0436142a085
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/328661
Commit-Queue: Brian Quinlan <bquinlan@google.com>
Reviewed-by: Alexander Aprelev <aam@google.com>
This commit is contained in:
Brian Quinlan 2023-09-29 16:22:33 +00:00 committed by Commit Queue
parent 02f91a1064
commit c3168c4e3b
1 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
sdk/lib/io/link.dart
View file

@ -34,6 +34,9 @@ abstract interface class Link implements FileSystemEntity {
/// Creates a symbolic link in the file system.
///
/// The created link will point to the path at [target], whether that path
/// exists or not.
///
/// Returns a `Future<Link>` that completes with
/// the link when it has been created. If the link path already exists,
/// the future will complete with an error.
@ -45,9 +48,14 @@ abstract interface class Link implements FileSystemEntity {
/// not affected, unless they are also in [path].
///
/// On the Windows platform, this call will create a true symbolic link
/// instead of a Junction. In order to create a symbolic link on Windows, Dart
/// must be run in Administrator mode or the system must have Developer Mode
/// enabled, otherwise a [FileSystemException] will be raised with
/// instead of a junction. The link represents a file or directory and
/// does not change its type after creation. If [target] exists then
/// the type of the link will match the type [target], otherwise a file
/// symlink is created.
///
/// In order to create a symbolic link on Windows, Dart must be run in
/// Administrator mode or the system must have Developer Mode enabled,
/// otherwise a [FileSystemException] will be raised with
/// `ERROR_PRIVILEGE_NOT_HELD` set as the errno when this call is made.
///
/// On other platforms, the POSIX `symlink()` call is used to make a symbolic