diff options
| author | bors <bors@rust-lang.org> | 2021-11-29 10:34:52 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2021-11-29 10:34:52 +0000 |
| commit | 8b954910c59a7a362c60959e93110892b6e9a691 (patch) | |
| tree | c566894c6cc248435e1871f774f73c61b5fea4b8 /library/std/src | |
| parent | 44723c5d59ff00daeefbf2a01f67089acd75730d (diff) | |
| parent | e15e0ba45c5d004345ab4def70d88af068ed54c7 (diff) | |
| download | rust-8b954910c59a7a362c60959e93110892b6e9a691.tar.gz rust-8b954910c59a7a362c60959e93110892b6e9a691.zip | |
Auto merge of #91350 - matthiaskrgr:rollup-nleabdj, r=matthiaskrgr
Rollup of 5 pull requests Successful merges: - #91049 (Add a caveat to std::os::windows::fs::symlink_file) - #91281 (Add demonstration test for #91161) - #91327 (Delete an unreachable codepath from format_args implementation) - #91336 (Remove unused root_parent.) - #91349 (Accumulate all values of `-C remark` option) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Diffstat (limited to 'library/std/src')
| -rw-r--r-- | library/std/src/os/windows/fs.rs | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/library/std/src/os/windows/fs.rs b/library/std/src/os/windows/fs.rs index be35ab0ca1e..31d1e3c1e42 100644 --- a/library/std/src/os/windows/fs.rs +++ b/library/std/src/os/windows/fs.rs @@ -543,6 +543,16 @@ impl FileTypeExt for fs::FileType { /// Ok(()) /// } /// ``` +/// +/// # Limitations +/// +/// Windows treats symlink creation as a [privileged action][symlink-security], +/// therefore this function is likely to fail unless the user makes changes to +/// their system to permit symlink creation. Users can try enabling Developer +/// Mode, granting the `SeCreateSymbolicLinkPrivilege` privilege, or running +/// the process as an administrator. +/// +/// [symlink-security]: https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/create-symbolic-links #[stable(feature = "symlink", since = "1.1.0")] pub fn symlink_file<P: AsRef<Path>, Q: AsRef<Path>>(original: P, link: Q) -> io::Result<()> { sys::fs::symlink_inner(original.as_ref(), link.as_ref(), false) @@ -572,6 +582,16 @@ pub fn symlink_file<P: AsRef<Path>, Q: AsRef<Path>>(original: P, link: Q) -> io: /// Ok(()) /// } /// ``` +/// +/// # Limitations +/// +/// Windows treats symlink creation as a [privileged action][symlink-security], +/// therefore this function is likely to fail unless the user makes changes to +/// their system to permit symlink creation. Users can try enabling Developer +/// Mode, granting the `SeCreateSymbolicLinkPrivilege` privilege, or running +/// the process as an administrator. +/// +/// [symlink-security]: https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/create-symbolic-links #[stable(feature = "symlink", since = "1.1.0")] pub fn symlink_dir<P: AsRef<Path>, Q: AsRef<Path>>(original: P, link: Q) -> io::Result<()> { sys::fs::symlink_inner(original.as_ref(), link.as_ref(), true) |
